|
Kanzi Graphics Engine
|
|
Kanzi Graphics Engine
|
User interface trajectory layout component. More...
#include <user/scene_graph/kzu_object_common.h>#include <system/kzs_types.h>#include <system/debug/kzs_error.h>#include <system/kzs_header.h>Functions | |
| kzsError | kzuUiTrajectoryLayoutCreate (const struct KzcMemoryManager *memoryManager, kzString name, struct KzuUIDomain *uiDomain, struct KzuUiTrajectoryLayout **out_trajectoryLayout) |
| Creates a trajectory layout with default settings. More... | |
| kzsError | kzuUiTrajectoryLayoutRegisterToFactory (const struct KzuFactory *factory) |
| Registers component type to factory. More... | |
| struct KzuUiComponentNode * | kzuUiTrajectoryLayoutToUiComponentNode (const struct KzuUiTrajectoryLayout *trajectoryLayout) |
| Casts to UiComponentNode. More... | |
| struct KzuUiTrajectoryLayout * | kzuUiTrajectoryLayoutFromUiComponentNode (const struct KzuUiComponentNode *component) |
| Casts to UiTrajectoryLayout. More... | |
| kzFloat | kzuUiTrajectoryLayoutProportionalToLength (const struct KzuUiTrajectoryLayout *trajectoryLayout, kzFloat proportionalOffset) |
| Converts a proportional offset to a length offset. More... | |
| kzFloat | kzuUiTrajectoryLayoutLengthToProportional (const struct KzuUiTrajectoryLayout *trajectoryLayout, kzFloat lengthOffset) |
| Converts a unit length offset to a proportional offset. More... | |
| kzsError | kzuUiTrajectoryLayoutGetObjectOffset (const struct KzuUiTrajectoryLayout *trajectoryLayout, const struct KzuObjectNode *objectNode, kzFloat *out_value) |
| Gets proportional offset of an object. More... | |
| kzFloat | kzuUiTrajectoryLayoutGetClipStartOffset (const struct KzuUiTrajectoryLayout *trajectoryLayout) |
| Returns offset of start of clipping area of trajectory, in proportional range. More... | |
| kzFloat | kzuUiTrajectoryLayoutGetClipEndOffset (const struct KzuUiTrajectoryLayout *trajectoryLayout) |
| Returns offset of end of clipping area of trajectory, in proportional range. More... | |
| kzFloat | kzuUiTrajectoryLayoutGetCurveLength (const struct KzuUiTrajectoryLayout *trajectoryLayout) |
| Returns length of the trajectory. More... | |
| kzsError | kzuUiTrajectoryLayoutSetScrollOffset (const struct KzuUiTrajectoryLayout *trajectoryLayout, kzFloat proportionalOffset) |
| Sets trajectory layout's scroll offset in proportional range. More... | |
| kzFloat | kzuUiTrajectoryLayoutGetScrollOffset (const struct KzuUiTrajectoryLayout *trajectoryLayout) |
| Gets trajectory layout's scroll offset in proportional range. More... | |
| kzBool | kzuUiTrajectoryLayoutGetFixedDistance (const struct KzuUiTrajectoryLayout *trajectoryLayout, kzFloat *out_fixedDistance) |
| Gets fixed distance variable of trajectory layout, in absolute units from zero offset. More... | |
| kzsError | kzuUiTrajectoryLayoutSetFixedDistance (const struct KzuUiTrajectoryLayout *trajectoryLayout, kzFloat fixedDistance) |
| Sets fixed distance variable of trajectory layout, in absolute units from zero offset. More... | |
| struct KzuTrajectory * | kzuUiTrajectoryLayoutGetTrajectory (const struct KzuUiTrajectoryLayout *trajectoryLayout) |
| Gets the trajectory attached to the trajectory layout. More... | |
| kzsError | kzuUiTrajectoryLayoutSetTrajectory (struct KzuUiTrajectoryLayout *trajectoryLayout, struct KzuTrajectory *trajectory) |
| Sets the trajectory attached to the trajectory layout. More... | |
| kzsError | kzuUiTrajectoryLayoutGetBoundingVolume_protected (const struct KzuObjectNode *objectNode, struct KzuBoundingVolume *out_boundingVolume) |
| Bounding volume getter implementation. More... | |
Variables | |
| const KzuObjectType | KZU_OBJECT_TYPE_UI_TRAJECTORY_LAYOUT |
| Object type for trajectory layout. More... | |
User interface trajectory layout component.
KzuUiTrajectoryLayout lays out its children on a user-specified KzuTrajectory.
KzuUiTrajectoryLayout does not send or receive any messages.
KZU_PROPERTY_TYPE_TRAJECTORY string property specifies the resource ID of the KzuTrajectory to use in the trajectory layout.
KZU_PROPERTY_TYPE_TRAJECTORY_LAYOUT_FIXED_DISTANCE float property can be set to specify a fixed distance between the children. If the property is not set, the whole trajectory length is used and the children are placed an equal distance apart from each other.
KZU_PROPERTY_TYPE_TRAJECTORY_LAYOUT_ALIGN_TO_TANGENT Boolean property specifies whether the children are aligned according to the tangent of the trajectory in the child's offset. The default value is KZ_FALSE.
KZU_PROPERTY_TYPE_STATIC_TRAJECTORY_OFFSET float property can be set in a child of the trajectory layout. It specifies a static offset for the child in the layout's KzuTrajectory. The value should be in the range [0, 1].
KZU_PROPERTY_TYPE_VISIBLE_AMOUNT_IN_PARENT float property is set by the trajectory layout in every child of the layout. It tells how much of the child is inside the trajectory layout's clipping area. Its value is in the range [0, 1].
KZU_PROPERTY_TYPE_TRAJECTORY_OFFSET float property is set by the trajectory layout in every child of the layout. It tells the child's current offset in the layout's KzuTrajectory. The value is in the range [0, 1].
KZU_PROPERTY_TYPE_TRAJECTORY_LAYOUT_CLIP_START_OFFSET_PROPORTIONAL float property specifies an offset (in proportional range [0, 1]) to the beginning of the clipping area of the trajectory layout. This property affects the KZU_PROPERTY_TYPE_VISIBLE_AMOUNT_IN_PARENT property setting only. The default value is 0.
KZU_PROPERTY_TYPE_TRAJECTORY_LAYOUT_CLIP_END_OFFSET_PROPORTIONAL float property specifies an offset (in proportional range [0, 1]) to the end of the clipping area of the trajectory layout. This property affects the KZU_PROPERTY_TYPE_VISIBLE_AMOUNT_IN_PARENT property setting only. The default value is 1.
KZU_PROPERTY_TYPE_TRAJECTORY_LAYOUT_SCROLL_OFFSET_PROPORTIONAL float property specifies an offset (in proportional range [0, 1]) to the first child on the trajectory. The default value is 0.
Copyright 2008-2019 by Rightware. All rights reserved.
| kzsError kzuUiTrajectoryLayoutCreate | ( | const struct KzcMemoryManager * | memoryManager, |
| kzString | name, | ||
| struct KzuUIDomain * | uiDomain, | ||
| struct KzuUiTrajectoryLayout ** | out_trajectoryLayout | ||
| ) |
Creates a trajectory layout with default settings.
| kzsError kzuUiTrajectoryLayoutRegisterToFactory | ( | const struct KzuFactory * | factory) |
Registers component type to factory.
| struct KzuUiComponentNode* kzuUiTrajectoryLayoutToUiComponentNode | ( | const struct KzuUiTrajectoryLayout * | trajectoryLayout) |
Casts to UiComponentNode.
| struct KzuUiTrajectoryLayout* kzuUiTrajectoryLayoutFromUiComponentNode | ( | const struct KzuUiComponentNode * | component) |
Casts to UiTrajectoryLayout.
| kzFloat kzuUiTrajectoryLayoutProportionalToLength | ( | const struct KzuUiTrajectoryLayout * | trajectoryLayout, |
| kzFloat | proportionalOffset | ||
| ) |
Converts a proportional offset to a length offset.
| kzFloat kzuUiTrajectoryLayoutLengthToProportional | ( | const struct KzuUiTrajectoryLayout * | trajectoryLayout, |
| kzFloat | lengthOffset | ||
| ) |
Converts a unit length offset to a proportional offset.
| kzsError kzuUiTrajectoryLayoutGetObjectOffset | ( | const struct KzuUiTrajectoryLayout * | trajectoryLayout, |
| const struct KzuObjectNode * | objectNode, | ||
| kzFloat * | out_value | ||
| ) |
Gets proportional offset of an object.
| kzFloat kzuUiTrajectoryLayoutGetClipStartOffset | ( | const struct KzuUiTrajectoryLayout * | trajectoryLayout) |
Returns offset of start of clipping area of trajectory, in proportional range.
| kzFloat kzuUiTrajectoryLayoutGetClipEndOffset | ( | const struct KzuUiTrajectoryLayout * | trajectoryLayout) |
Returns offset of end of clipping area of trajectory, in proportional range.
| kzFloat kzuUiTrajectoryLayoutGetCurveLength | ( | const struct KzuUiTrajectoryLayout * | trajectoryLayout) |
Returns length of the trajectory.
| kzsError kzuUiTrajectoryLayoutSetScrollOffset | ( | const struct KzuUiTrajectoryLayout * | trajectoryLayout, |
| kzFloat | proportionalOffset | ||
| ) |
Sets trajectory layout's scroll offset in proportional range.
| kzFloat kzuUiTrajectoryLayoutGetScrollOffset | ( | const struct KzuUiTrajectoryLayout * | trajectoryLayout) |
Gets trajectory layout's scroll offset in proportional range.
| kzBool kzuUiTrajectoryLayoutGetFixedDistance | ( | const struct KzuUiTrajectoryLayout * | trajectoryLayout, |
| kzFloat * | out_fixedDistance | ||
| ) |
Gets fixed distance variable of trajectory layout, in absolute units from zero offset.
Returns whether the property was set.
| kzsError kzuUiTrajectoryLayoutSetFixedDistance | ( | const struct KzuUiTrajectoryLayout * | trajectoryLayout, |
| kzFloat | fixedDistance | ||
| ) |
Sets fixed distance variable of trajectory layout, in absolute units from zero offset.
| struct KzuTrajectory* kzuUiTrajectoryLayoutGetTrajectory | ( | const struct KzuUiTrajectoryLayout * | trajectoryLayout) |
Gets the trajectory attached to the trajectory layout.
| kzsError kzuUiTrajectoryLayoutSetTrajectory | ( | struct KzuUiTrajectoryLayout * | trajectoryLayout, |
| struct KzuTrajectory * | trajectory | ||
| ) |
Sets the trajectory attached to the trajectory layout.
| kzsError kzuUiTrajectoryLayoutGetBoundingVolume_protected | ( | const struct KzuObjectNode * | objectNode, |
| struct KzuBoundingVolume * | out_boundingVolume | ||
| ) |
Bounding volume getter implementation.
| const KzuObjectType KZU_OBJECT_TYPE_UI_TRAJECTORY_LAYOUT |
Object type for trajectory layout.
1.8.4