trajectory_layout_properties.h File Reference

Variables

static PropertyType< ResourceSharedPtr > TrajectoryProperty
 Trajectory property. More...
 
static PropertyType< float > ItemAreaBeginProperty
 ItemAreaBegin property. More...
 
static PropertyType< float > ItemAreaEndProperty
 ItemAreaEnd property. More...
 
static PropertyType< float > OverrideDistanceProperty
 OverrideDistance property. More...
 
static PropertyType< float > StartOffsetProperty
 StartOffset property. More...
 
static PropertyType< bool > AlignToTangentProperty
 AlignToTangent property. More...
 
static PropertyType< float > CalculatedOffsetProperty
 CalculatedOffset property. More...
 
static PropertyType< float > OverrideOffsetProperty
 OverrideOffset property. More...
 
static PropertyType< bool > StretchProperty
 Stretch property. More...
 

Variable Documentation

PropertyType<ResourceSharedPtr> TrajectoryProperty
static

Trajectory property.

Defines the resource ID of the trajectory resource used by a trajectory layout. The default value is ResourceSharedPtr().

See also
setTrajectory(), getTrajectory()
PropertyType<float> ItemAreaBeginProperty
static

ItemAreaBegin property.

Defines the starting point of the trajectory segment in which the layout items are considered fully visible. The value is in [0, 1] range where 0 is the beginning and 1 is the end of the trajectory. See use of the VisibleAmountInParent property. TODO Link to VisibleAmountInParent. The default value is 0.0f.

See also
setItemAreaBegin(), getItemAreaBegin()
PropertyType<float> ItemAreaEndProperty
static

ItemAreaEnd property.

Defines the ending point of the trajectory segment in which the layout items are considered fully visible. The value is in [0, 1] range where 0 is the beginning and 1 is the end of the trajectory. See use of the VisibleAmountInParent property. TODO Link to VisibleAmountInParent. The default value is 1.0f.

See also
setItemAreaEnd(), getItemAreaEnd()
PropertyType<float> OverrideDistanceProperty
static

OverrideDistance property.

Defines the fixed distance between items in the trajectory layout. If not set, the trajectory layout calculates the distance and provides equal spacing between the items. TODO: clarify units The default value is 1.0f.

See also
setOverrideDistance(), getOverrideDistance()
PropertyType<float> StartOffsetProperty
static

StartOffset property.

Defines the starting offset on the trajectory from where the items are laid out. The value is in [0, 1] range, where 0 is the beginning and 1 is the end of the trajectory spline (see, for example, TrajectoryLayoutClipEndOffsetProportional). The default value is 0.0f.

See also
setStartOffset(), getStartOffset()
PropertyType<bool> AlignToTangentProperty
static

AlignToTangent property.

Whether the items in the trajectory layout are aligned to the tangent of the trajectory. The default value is false.

See also
setAlignToTangent(), isAlignToTangent()
PropertyType<float> CalculatedOffsetProperty
static

CalculatedOffset property.

Defines the value where the layout stores the current calculated offset along the trajectory calculated for an item. The value is in [0, 1] range, where 0 is the beginning and 1 is the end of the trajectory spline (see, for example, TrajectoryLayoutClipEndOffsetProportional). The default value is 0.0f.

See also
setCalculatedOffset(), getCalculatedOffset()
PropertyType<float> OverrideOffsetProperty
static

OverrideOffset property.

Defines the fixed offset on the trajectory, which the trajectory layout uses to position an item. If not set, the trajectory layout calculates the offset automatically. The value is in [0, 1] range, where 0 is the beginning and 1 is the end of the trajectory spline (see, for example, TrajectoryLayoutClipEndOffsetProportional). The default value is 0.0f.

See also
setOverrideOffset(), getOverrideOffset()
PropertyType<bool> StretchProperty
static

Stretch property.

If true, scale the trajectory to match layout size. The default value is false.

See also
setStretch(), isStretch()