ShinobiControls Xamarin Bindings Documentation

ShinobiEssentials : Shinobi.Essentials Namespace

SEssentialsCoverFlow Class

An SEssentialsCarousel which displays all items in a line, either with horizontal or vertical alignment.

Syntax

[Foundation.Register("SEssentialsCoverFlow", true)]
public class SEssentialsCoverFlow : SEssentialsCarousel

Remarks

Off-center items have a constant spacing between centers (SEssentialsCoverFlow.ItemSpacing), and the item in focus has padding around it (SEssentialsCoverFlow.CenterItemPadding). The items to the left of the center are rotated left, and the items to the right rotated right, with the center item facing forwards.

The majority of interactions with the SEssentialsCoverFlow will be done via the methods and properties on the SEssentialsCarousel abstract base class, with the properties of the SEssentialsCoverFlow making small changes to the positioning of items.

Requirements

Namespace: Shinobi.Essentials
Assembly: ShinobiEssentials (in ShinobiEssentials.dll)
Assembly Versions: 2.8.0.4

Members

See Also: Inherited members from SEssentialsCarousel.

Public Constructors

Construct a new CoverFlow Carousel with a given frame.
A constructor that initializes the object from the data stored in the unarchiver object.

Protected Constructors

Constructor to call on derived classes to skip initialization and merely allocate the object.
A constructor used when creating managed representations of unmanaged objects.

Public Properties

Bounces bool . Whether the carousel will bounce on reaching the end, or simply stop. (Inherited from SEssentialsCarousel.)
CenterItemPadding nfloat . The distance between the edge of the focused item, and the center of the nearest off-center item, measured in points.
[read-only]
override
ClassHandle IntPtr . The handle for this class.
[read-only]
override
ClassHandle IntPtr . The handle for this class. (Inherited from SEssentialsCarousel.)
ContentOffset nfloat . The current offset through the carousel, measured in indices. (Inherited from SEssentialsCarousel.)
[read-only]
CurrentItemInFocus UIKit.UIView . The item closest to the focus point of the carousel. (Inherited from SEssentialsCarousel.)
DataSource SEssentialsCarouselDataSource . The DataSource to call for fetching item content. (Inherited from SEssentialsCarousel.)
Delegate SEssentialsCarouselDelegate . The delegate to call back to on specific events. (Inherited from SEssentialsCarousel.)
FocusPointNormalized CoreGraphics.CGPoint . The point in the carousel bounds to center items around. (Inherited from SEssentialsCarousel.)
FrictionCoefficient nfloat . How much friction to apply to the carousel. (Inherited from SEssentialsCarousel.)
FrontFacingFactor nfloat . The percentage time the focused item remains front-facing while the carousel is panning, before the item rotates away and moves out of focus.
ItemSpacing nfloat . The amount of spacing to use between the centers of all off-center items, measured in points.
MaxNumberOfItemsToDisplay nint . The maximum number of on-screen items to display. (Inherited from SEssentialsCarousel.)
MomentumAnimationCurve SEssentialsAnimationCurve . The type of animation curve to use when panning the carousel. (Inherited from SEssentialsCarousel.)
Orientation SEssentialsCarouselOrientation . Controls the orientation of the carousel.
PanEnabled bool . Controls if the Carousel can be panned by the user. (Inherited from SEssentialsCarousel.)
PanGestureFrame CoreGraphics.CGRect . Specifies a sub-area of the carousel bounds to allow panning. (Inherited from SEssentialsCarousel.)
PanVector CoreGraphics.CGPoint . Specifies the direction of forward panning, as a vector. (Inherited from SEssentialsCarousel.)
ProgrammaticAnimationCurve SEssentialsAnimationCurve . The type of animation curve to use when programmatically changing the carousel offset. (Inherited from SEssentialsCarousel.)
RotateFactor nfloat . The rotation applied to the off-center items.
ScaleFactor nfloat . The scale of off-center items, in comparison to the center item, as a positive value.
SnapToFocusPoint bool . Controls if the Carousel will always finish pans centered on an item. (Inherited from SEssentialsCarousel.)
[read-only]
VisibleItems UIKit.UIView[]. The set of all currently visible items on the carousel. (Inherited from SEssentialsCarousel.)
WeakDelegate Foundation.NSObject . The weak delegate to call back to on specific events. (Inherited from SEssentialsCarousel.)
WrapItems bool . Controls if the Carousel will loop items. (Inherited from SEssentialsCarousel.)

Public Methods

ConvertToIndex (nfloat) : nint
Documentation for this section has not yet been entered. (Inherited from SEssentialsCarousel.)
ConvertToOffset (nint) : nfloat
Converts an index to the nearest corresponding offset in the carousel. (Inherited from SEssentialsCarousel.)
PanToItem (nint, bool, nfloat)
Documentation for this section has not yet been entered. (Inherited from SEssentialsCarousel.)
PositionOfItemAtOffset (nfloat) : CoreGraphics.CGPoint
Documentation for this section has not yet been entered. (Inherited from SEssentialsCarousel.)
RedrawCarousel ()
Force a layout of all items in the carousel. (Inherited from SEssentialsCarousel.)
ReloadData ()
Reloads all items by re-requesting them from the DataSource. (Inherited from SEssentialsCarousel.)
SetContentOffset (nfloat, bool, nfloat)
Documentation for this section has not yet been entered. (Inherited from SEssentialsCarousel.)
TransformOfItemAtOffset (nfloat) : CoreAnimation.CATransform3D
Documentation for this section has not yet been entered. (Inherited from SEssentialsCarousel.)

Protected Methods

override
Dispose (bool)
Releases unmanaged resources. (Inherited from SEssentialsCarousel.)

Member Details

SEssentialsCoverFlow Constructor

Construct a new CoverFlow Carousel with a given frame.

Syntax

public SEssentialsCoverFlow (CoreGraphics.CGRect frame)

Parameters

frame
The Frame to use.

Remarks

Requirements

Namespace: Shinobi.Essentials
Assembly: ShinobiEssentials (in ShinobiEssentials.dll)
Assembly Versions: 2.8.0.4

SEssentialsCoverFlow Constructor

A constructor that initializes the object from the data stored in the unarchiver object.

Syntax

[Foundation.Export("initWithCoder:")]
[System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)]
public SEssentialsCoverFlow (Foundation.NSCoder coder)

Parameters

coder
The unarchiver object

Remarks

This constructor is provided to allow the class to be initialized from an unarchiver (for example, during NIB deserialization).

Requirements

Namespace: Shinobi.Essentials
Assembly: ShinobiEssentials (in ShinobiEssentials.dll)
Assembly Versions: 2.8.0.4

SEssentialsCoverFlow Constructor

Constructor to call on derived classes to skip initialization and merely allocate the object.

Syntax

[System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)]
protected SEssentialsCoverFlow (Foundation.NSObjectFlag t)

Parameters

t
Unused sentinel value

Remarks

You should not invoke this method directly.

Requirements

Namespace: Shinobi.Essentials
Assembly: ShinobiEssentials (in ShinobiEssentials.dll)
Assembly Versions: 2.8.0.4

SEssentialsCoverFlow Constructor

A constructor used when creating managed representations of unmanaged objects.

Syntax

[System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)]
protected SEssentialsCoverFlow (IntPtr handle)

Parameters

handle
Handle of the unmanaged object

Remarks

You should not invoke this method directly.

Requirements

Namespace: Shinobi.Essentials
Assembly: ShinobiEssentials (in ShinobiEssentials.dll)
Assembly Versions: 2.8.0.4

CenterItemPadding Property

The distance between the edge of the focused item, and the center of the nearest off-center item, measured in points.

Syntax

[get: Foundation.Export("centerItemPadding", ObjCRuntime.ArgumentSemantic.UnsafeUnretained)]
[set: Foundation.Export("setCenterItemPadding:", ObjCRuntime.ArgumentSemantic.UnsafeUnretained)]
public virtual nfloat CenterItemPadding { get; set; }

Value

Documentation for this section has not yet been entered.

Remarks

Defaults to 70 pts.

Requirements

Namespace: Shinobi.Essentials
Assembly: ShinobiEssentials (in ShinobiEssentials.dll)
Assembly Versions: 2.8.0.4

ClassHandle Property

The handle for this class.

Syntax

public override IntPtr ClassHandle { get; }

Value

Documentation for this section has not yet been entered.

Remarks

Requirements

Namespace: Shinobi.Essentials
Assembly: ShinobiEssentials (in ShinobiEssentials.dll)
Assembly Versions: 2.8.0.4

FrontFacingFactor Property

The percentage time the focused item remains front-facing while the carousel is panning, before the item rotates away and moves out of focus.

Syntax

[get: Foundation.Export("frontFacingFactor", ObjCRuntime.ArgumentSemantic.UnsafeUnretained)]
[set: Foundation.Export("setFrontFacingFactor:", ObjCRuntime.ArgumentSemantic.UnsafeUnretained)]
public virtual nfloat FrontFacingFactor { get; set; }

Value

Documentation for this section has not yet been entered.

Remarks

At 0, the item will always rotate as the carousel pans, and at 1, the item will not rotate until a new item is centered. Defaults to 0.2.

Requirements

Namespace: Shinobi.Essentials
Assembly: ShinobiEssentials (in ShinobiEssentials.dll)
Assembly Versions: 2.8.0.4

ItemSpacing Property

The amount of spacing to use between the centers of all off-center items, measured in points.

Syntax

[get: Foundation.Export("itemSpacing", ObjCRuntime.ArgumentSemantic.UnsafeUnretained)]
[set: Foundation.Export("setItemSpacing:", ObjCRuntime.ArgumentSemantic.UnsafeUnretained)]
public virtual nfloat ItemSpacing { get; set; }

Value

Documentation for this section has not yet been entered.

Remarks

Defaults to 65 pts.

Requirements

Namespace: Shinobi.Essentials
Assembly: ShinobiEssentials (in ShinobiEssentials.dll)
Assembly Versions: 2.8.0.4

Orientation Property

Controls the orientation of the carousel.

Syntax

[get: Foundation.Export("orientation", ObjCRuntime.ArgumentSemantic.UnsafeUnretained)]
[set: Foundation.Export("setOrientation:", ObjCRuntime.ArgumentSemantic.UnsafeUnretained)]
public virtual SEssentialsCarouselOrientation Orientation { get; set; }

Value

Documentation for this section has not yet been entered.

Remarks

If SEssentialsCarouselOrientation.Horizontal, items are laid out left-to-right. If SEssentialsCarouselOrientation.Vertical, items are laid out top-to-bottom. Defaults to SEssentialsCarouselOrientation.Horizontal.

Requirements

Namespace: Shinobi.Essentials
Assembly: ShinobiEssentials (in ShinobiEssentials.dll)
Assembly Versions: 2.8.0.4

RotateFactor Property

The rotation applied to the off-center items.

Syntax

[get: Foundation.Export("rotateFactor", ObjCRuntime.ArgumentSemantic.UnsafeUnretained)]
[set: Foundation.Export("setRotateFactor:", ObjCRuntime.ArgumentSemantic.UnsafeUnretained)]
public virtual nfloat RotateFactor { get; set; }

Value

Documentation for this section has not yet been entered.

Remarks

At 0, all items face forwards. At 1, all items are turned perpendicular to the viewer, facing inwards, and at -1 all items are perpendicular facing outwards. Defaults to 0.3.

Requirements

Namespace: Shinobi.Essentials
Assembly: ShinobiEssentials (in ShinobiEssentials.dll)
Assembly Versions: 2.8.0.4

ScaleFactor Property

The scale of off-center items, in comparison to the center item, as a positive value.

Syntax

[get: Foundation.Export("scaleFactor", ObjCRuntime.ArgumentSemantic.UnsafeUnretained)]
[set: Foundation.Export("setScaleFactor:", ObjCRuntime.ArgumentSemantic.UnsafeUnretained)]
public virtual nfloat ScaleFactor { get; set; }

Value

Documentation for this section has not yet been entered.

Remarks

All off-center items will be the same scale, until moved to the center when they will scale to 1. Defaults to 0.9.

Requirements

Namespace: Shinobi.Essentials
Assembly: ShinobiEssentials (in ShinobiEssentials.dll)
Assembly Versions: 2.8.0.4