kanzi::TrajectoryLayoutConcept Class Reference

TrajectoryLayoutConcept contains trajectory layout related properties. More...

#include <kanzi/ui/node/concept/trajectory_layout.hpp>

Inheritance diagram for kanzi::TrajectoryLayoutConcept:

Static Public Member Functions
static PropertyTypeEditorInfoSharedPtr	makeEditorInfo ()

Static Public Attributes
Properties
Defines the resource ID of the trajectory resource used by a trajectory layout. The default value is ResourceSharedPtr(). See also setTrajectory(), getTrajectory()
static PropertyType< ResourceSharedPtr >	TrajectoryProperty
static PropertyType< float >	ItemAreaBeginProperty
	Defines the starting point of the trajectory segment in which the layout items are considered fully visible. More...
static PropertyType< float >	ItemAreaEndProperty
	Defines the ending point of the trajectory segment in which the layout items are considered fully visible. More...
static PropertyType< float >	OverrideDistanceProperty
	Defines the fixed distance between items in the trajectory layout. More...
static PropertyType< float >	StartOffsetProperty
	Defines the starting offset on the trajectory from where the items are laid out. More...
static PropertyType< bool >	AlignToTangentProperty
	Sets whether the items in the trajectory layout are aligned to the tangent of the trajectory. More...
static PropertyType< float >	CalculatedOffsetProperty
	Defines the value where the layout stores the current calculated offset along the trajectory calculated for an item. More...
static PropertyType< float >	OverrideOffsetProperty
	Defines the fixed offset on the trajectory, which the trajectory layout uses to position an item. More...
static PropertyType< bool >	StretchProperty
	If true, scale the trajectory to match layout size. More...

Detailed Description

TrajectoryLayoutConcept contains trajectory layout related properties.

Member Function Documentation

makeEditorInfo()

static PropertyTypeEditorInfoSharedPtr kanzi::TrajectoryLayoutConcept::makeEditorInfo ( )

static

Member Data Documentation

TrajectoryProperty

PropertyType<ResourceSharedPtr> kanzi::TrajectoryLayoutConcept::TrajectoryProperty

static

ItemAreaBeginProperty

PropertyType<float> kanzi::TrajectoryLayoutConcept::ItemAreaBeginProperty

static

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 Node::VisibleAmountInParentProperty. The default value is 0.0f.

See also

setItemAreaBegin(), getItemAreaBegin()

ItemAreaEndProperty

PropertyType<float> kanzi::TrajectoryLayoutConcept::ItemAreaEndProperty

static

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 Node::VisibleAmountInParentProperty. The default value is 1.0f.

See also

setItemAreaEnd(), getItemAreaEnd()

OverrideDistanceProperty

PropertyType<float> kanzi::TrajectoryLayoutConcept::OverrideDistanceProperty

static

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. The default value is 1.0f.

See also

setOverrideDistance(), getOverrideDistance()

StartOffsetProperty

PropertyType<float> kanzi::TrajectoryLayoutConcept::StartOffsetProperty

static

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. For example, see TrajectoryLayoutClipEndOffsetProportional. The default value is 0.0f.

See also

setStartOffset(), getStartOffset()

AlignToTangentProperty

PropertyType<bool> kanzi::TrajectoryLayoutConcept::AlignToTangentProperty

static

Sets whether the items in the trajectory layout are aligned to the tangent of the trajectory.

The default value is false.

See also

setAlignToTangent(), isAlignToTangent()

CalculatedOffsetProperty

PropertyType<float> kanzi::TrajectoryLayoutConcept::CalculatedOffsetProperty

static

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. For example, see TrajectoryLayoutClipEndOffsetProportional. The default value is 0.0f.

See also

setCalculatedOffset(), getCalculatedOffset()

OverrideOffsetProperty

PropertyType<float> kanzi::TrajectoryLayoutConcept::OverrideOffsetProperty

static

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. For example, see TrajectoryLayoutClipEndOffsetProportional. The default value is 0.0f.

See also

setOverrideOffset(), getOverrideOffset()

StretchProperty

PropertyType<bool> kanzi::TrajectoryLayoutConcept::StretchProperty

static

If true, scale the trajectory to match layout size.

The default value is false.

See also

setStretch(), isStretch()

---

The documentation for this class was generated from the following file:

• kanzi/ui/node/concept/trajectory_layout.hpp