Base class for TrajectoryLayout classes. More...

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

Inheritance diagram for kanzi::TrajectoryLayoutConcept:

Static Public Member Functions
static float	getItemOffset (const Node &item)
	Gets the offset of an item in a Trajectory Layout node. More...

static optional< float >	getOverrideOffset (const Node &item)
	Gets the fixed offset of an item on the trajectory. More...

static PropertyTypeEditorInfoSharedPtr	makeEditorInfo ()

static void	setOverrideOffset (Node &item, float staticOffset)
	Sets the fixed offset of an item on the trajectory. More...

Static Public Attributes
Properties
static PropertyType< ResourceSharedPtr >	TrajectoryProperty
	Defines the Trajectory resource used by a Trajectory Layout node. More...

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

Base class for TrajectoryLayout classes.

This class defines common properties for the TrajectoryLayout2D and TrajectoryLayout3D classes.

Member Function Documentation

◆ makeEditorInfo()

static PropertyTypeEditorInfoSharedPtr kanzi::TrajectoryLayoutConcept::makeEditorInfo ( )

static

◆ getItemOffset()

static float kanzi::TrajectoryLayoutConcept::getItemOffset ( const Node & item )

static

Gets the offset of an item in a Trajectory Layout node.

Parameters

item	A node that is an item in a Trajectory Layout node.

Returns: The last offset calculated for the item by the Trajectory Layout.

◆ getOverrideOffset()

static optional<float> kanzi::TrajectoryLayoutConcept::getOverrideOffset ( const Node & item )

static

Gets the fixed offset of an item on the trajectory.

Parameters

item	A node that is an item in a Trajectory Layout node.

Returns: The value of the OverrideOffsetProperty in the item, or if the property is not set, an empty optional.

◆ setOverrideOffset()

static void kanzi::TrajectoryLayoutConcept::setOverrideOffset	(	Node &	item,
		float	staticOffset
	)

static

Sets the fixed offset of an item on the trajectory.

Parameters

item	A node that is an item in a Trajectory Layout node.
staticOffset	The fixed offset on the trajectory, which the Trajectory Layout uses to position the item.

Examples

To manually position items in a Trajectory Layout node:

        // Position an item in the middle of the trajectory.
        TrajectoryLayout3D::setOverrideOffset(*item2, 0.5f);
        // Set the distance between the items to one third of the length of the trajectory.
        trajectoryLayout->setOverrideDistance(0.3f);

Member Data Documentation

◆ TrajectoryProperty

PropertyType<ResourceSharedPtr> kanzi::TrajectoryLayoutConcept::TrajectoryProperty

static

Defines the Trajectory resource used by a Trajectory Layout node.

The default value is ResourceSharedPtr().

See also: TrajectoryLayoutConceptImpl::setTrajectory(), TrajectoryLayoutConceptImpl::getTrajectory()

◆ 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: TrajectoryLayoutConceptImpl::setItemAreaBegin(), TrajectoryLayoutConceptImpl::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: TrajectoryLayoutConceptImpl::setItemAreaEnd(), TrajectoryLayoutConceptImpl::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: TrajectoryLayoutConceptImpl::setOverrideDistance(), TrajectoryLayoutConceptImpl::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. The default value is 0.0f.

See also: TrajectoryLayoutConceptImpl::setStartOffset(), TrajectoryLayoutConceptImpl::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: TrajectoryLayoutConceptImpl::setAlignToTangent(), TrajectoryLayoutConceptImpl::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. The default value is 0.0f.

See also: TrajectoryLayoutConceptImpl::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. 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: TrajectoryLayoutConceptImpl::setStretch(), TrajectoryLayoutConceptImpl::isStretch()

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

kanzi/ui/node/concept/trajectory_layout.hpp

Static Public Member Functions

Static Public Attributes

Detailed Description

Member Function Documentation

◆ makeEditorInfo()

◆ getItemOffset()

◆ getOverrideOffset()

◆ setOverrideOffset()

Examples

Member Data Documentation

◆ TrajectoryProperty

◆ ItemAreaBeginProperty

◆ ItemAreaEndProperty

◆ OverrideDistanceProperty

◆ StartOffsetProperty

◆ AlignToTangentProperty

◆ CalculatedOffsetProperty

◆ OverrideOffsetProperty

◆ StretchProperty