All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros
kanzi::TrajectoryLayout3D Class Reference

Trajectory Layout 3D arranges its items along a trajectory. More...

#include <kanzi/node/trajectory_layout3d.hpp>

Inheritance diagram for kanzi::TrajectoryLayout3D:
kanzi::Node3D kanzi::TrajectoryLayoutConcept kanzi::Node kanzi::Object

Public Member Functions

void setUserTrajectory (const TrajectorySharedPtr &trajectory)
 Sets a trajectory to use. More...
 
TrajectorySharedPtr getTrajectory () const
 Gets the trajectory currently used by the trajectory layout. More...
 
float getCalculatedOffset (const Node3DSharedPtr &item) const
 Gets the offset calculated for an item. More...
 
Vector3 getCalculatedPosition (const Node3DSharedPtr &item) const
 Gets the position calculated for an item. More...
 
Vector3 getCalculatedTangent (const Node3DSharedPtr &item) const
 Gets the tangent calculated for an item. More...
 
float getCurveLength () const
 Gets the length of the trajectory used by the trajectory layout. More...
 
float proportionalToLength (float proportionalOffset) const
 Converts a proportional offset to a length offset. More...
 
float lengthToProportional (float lengthOffset) const
 Converts a length offset to a proportional offset. More...
 
ResourceID getTrajectoryResourceID () const
 Gets the value of TrajectoryProperty. More...
 
void setTrajectoryResourceID (ResourceID value)
 Sets the value of TrajectoryProperty. More...
 
float getItemAreaBegin () const
 Gets the value of #ClipStartOffsetProportionalProperty. More...
 
void setItemAreaBegin (float value)
 Sets the value of #ClipStartOffsetProportionalProperty. More...
 
float getItemAreaEnd () const
 Gets the value of #ClipEndOffsetProportionalProperty. More...
 
void setItemAreaEnd (float value)
 Sets the value of #ClipEndOffsetProportionalProperty. More...
 
float getOverrideDistance () const
 Gets the value of #FixedDistanceProperty. More...
 
void setOverrideDistance (float value)
 Sets the value of #FixedDistanceProperty. More...
 
float getStartOffset () const
 Gets the value of #ScrollOffsetProportionalProperty. More...
 
void setStartOffset (float value)
 Sets the value of #ScrollOffsetProportionalProperty. More...
 
bool isAlignToTangent () const
 Gets the value of AlignToTangentProperty. More...
 
void setAlignToTangent (bool value)
 Sets the value of AlignToTangentProperty. More...
 
bool isStretch () const
 Gets the value of #EnableTrajectoryScalingProperty. More...
 
void setStretch (bool value)
 Sets the value of #EnableTrajectoryScalingProperty. More...
 
Vector3 getScaling () const
 Return scaling factor. More...
 
void refreshScaling (const Vector3 &availableSize)
 
- Public Member Functions inherited from kanzi::Node3D
bool isUnboundedLayoutValue (Vector3 value)
 Determines whether vector is unbounded layout value. More...
 
Matrix4x4 getRenderTransformation () const
 Gets the value of RenderTransformationProperty. More...
 
void setRenderTransformation (Matrix4x4 value)
 Sets the value of RenderTransformationProperty. More...
 
Matrix4x4 getLayoutTransformation () const
 Gets the value of LayoutTransformationProperty. More...
 
void setLayoutTransformation (Matrix4x4 value)
 Sets the value of LayoutTransformationProperty. More...
 
Matrix4x4 getFinalTransformation () const
 Gets the value of FinalTransformationProperty. More...
 
void setFinalTransformation (Matrix4x4 value)
 Sets the value of FinalTransformationProperty. More...
 
bool isObjectDepthTest () const
 Gets the value of ObjectDepthTestProperty. More...
 
void setObjectDepthTest (bool value)
 Sets the value of ObjectDepthTestProperty. More...
 
bool isObjectDepthWrite () const
 Gets the value of ObjectDepthWriteProperty. More...
 
void setObjectDepthWrite (bool value)
 Sets the value of ObjectDepthWriteProperty. More...
 
bool isObjectScissorEnabled () const
 Gets the value of ObjectScissorEnabledProperty. More...
 
void setObjectScissorEnabled (bool value)
 Sets the value of ObjectScissorEnabledProperty. More...
 
Vector2 getObjectScissorAreaXY () const
 Gets the value of ObjectScissorAreaXYProperty. More...
 
void setObjectScissorAreaXY (Vector2 value)
 Sets the value of ObjectScissorAreaXYProperty. More...
 
Vector2 getObjectScissorAreaWidthHeight () const
 Gets the value of ObjectScissorAreaWidthHeightProperty. More...
 
void setObjectScissorAreaWidthHeight (Vector2 value)
 Sets the value of ObjectScissorAreaWidthHeightProperty. More...
 
float getFrustumCullMargin () const
 Gets the value of FrustumCullMarginProperty. More...
 
void setFrustumCullMargin (float value)
 Sets the value of FrustumCullMarginProperty. More...
 
virtual ~Node3D ()
 
size_t getChildCount () const
 Gets child count from object. More...
 
Node3DSharedPtr getChild (size_t index) const
 Returns a child from given index from object node. More...
 
size_t getChildIndex (const Node &child) const
 Returns the index of a child in an object node. More...
 
bool hasChild (const Node &child) const
 Returns whether or not the child exists. More...
 
void addChild (const Node3DSharedPtr &child)
 Adds a child node for object node. More...
 
void insertChild (size_t index, const Node3DSharedPtr &child)
 Adds a child node for object node to given index. More...
 
void removeChild (const Node &child)
 Removes child node from parent object. More...
 
void removeChild (size_t index)
 Removes child node from parent object node at specified index. More...
 
void removeAllChildren ()
 Removes all child nodes from parent object. More...
 
ChildConstIterator beginChildren () const
 
ChildConstIterator endChildren () const
 
ChildConstReverseIterator rbeginChildren () const
 
ChildConstReverseIterator rendChildren () const
 
virtual bool addAbstractChildOverride (NodeSharedPtr child) KZ_OVERRIDE
 
virtual size_t getAbstractChildCountOverride () KZ_OVERRIDE
 
virtual NodeSharedPtr getAbstractChildOverride (size_t index) KZ_OVERRIDE
 
virtual bool removeAbstractChildOverride (Node &child) KZ_OVERRIDE
 
void moveToBack ()
 Repositions the node to the beginning of its parent's children, so that it is drawn first. More...
 
void moveToFront ()
 Repositions the node to the end of its parent's children, so that it is drawn last. More...
 
void setAutoWidth ()
 
void setAutoHeight ()
 
void setAutoDepth ()
 
void setAutoSize ()
 
void setSize (float width, float height, float depth)
 
void setCoreDesiredSize (const Vector3 &coreDesiredSize)
 Set core desired size for an object. More...
 
Vector3 getCoreDesiredSize () const
 Get core desired size of an object. More...
 
void setDesiredSize (const Vector3 &desiredSize)
 Set desired size for an object. More...
 
Vector3 getDesiredSize () const
 Get desired size for of object. More...
 
void setAllocatedSize (const Vector3 &layoutSize)
 Set allocated size for an object. More...
 
Vector3 getAllocatedSize () const
 Get allocated size of an object. More...
 
void setActualSize (const Vector3 &actualSize)
 Set actual size for an object. More...
 
Vector3 getActualSize () const
 Get actual size of an object. More...
 
void setLayoutBoundingBoxSize (const Vector3 &bboxMin, const Vector3 &bboxMax)
 Set bounding box size for an object. More...
 
void getLayoutBoundingBoxSize (Vector3 &bboxMin, Vector3 &bboxMax) const
 Get bounding box size for an object. More...
 
void setAllocatedOffset (const Vector3 &allocatedOffset)
 Set allocated offset for an object. More...
 
Vector3 getAllocatedOffset () const
 Get allocated offset of an object. More...
 
void setStretchScale (const Vector3 &stretchScale)
 Set stretch scale for an object. More...
 
Vector3 getStretchScale () const
 Get stretch scale of an object. More...
 
void setPivotOffset (const Vector3 &pivotOffset)
 Set pivot offset for an object. More...
 
Vector3 getPivotOffset () const
 Get pivot offset of an object. More...
 
kzsError getSize (Vector3 &out_size) const
 Returns the size of object node. More...
 
kzsError getMaximumBoundingBoxCoordinates (Vector3 &out_size) const
 Returns the minimum coordinates for object nodes bounding volume. More...
 
kzsError getMinimumBoundingBoxCoordinates (Vector3 &out_size) const
 Returns the maximum coordinates for object nodes bounding volume. More...
 
void setIdentityTransformation ()
 Sets an identity matrix for object node. More...
 
void setIdentity3x3Transformation ()
 Sets a top left 3x3 part of object node transformation as identity (clear rotation & scaling). More...
 
void setTranslation (float x, float y, float z)
 Sets position for object node. More...
 
Vector3 getTranslation () const
 Returns the translation of the object node as vector3. More...
 
void translate (float x, float y, float z)
 Translates object node. More...
 
void rotate (float angleInDegrees, float x, float y, float z)
 Rotates object node by specific axis, rotation angle in degrees. More...
 
void scale (float uniformScale)
 Scales object node uniformly. More...
 
void scale (float scaleX, float scaleY, float scaleZ)
 Scales object node non-uniformly. More...
 
void setArrangeTransformation (const Matrix4x4 &value)
 Sets the layout transformation of the object. More...
 
Matrix4x4 getArrangeTransformation () const
 Gets the layout transformation of the object. More...
 
KzcMatrix4x4 getBaseTransformationDefaultFromSRT () const
 Calculates the node base transformation from scaling, rotation, and translation properties. More...
 
void layout ()
 Recursively calculate the layouts in the scene. More...
 
void measureIterate ()
 Initial scene measure. More...
 
virtual bool measureRecursive ()
 Perform layout measurement on a node. More...
 
void arrangeIterate ()
 Initial scene arrange. More...
 
void arrangeIterateLayout (bool propagateArrange)
 
void arrangeIterateLayoutChild (bool propagateArrange)
 
void measure (const Vector3 &availableSize)
 Perform the default measure step. More...
 
void arrange ()
 Perform layout arrangement on a node. More...
 
Vector3 centeredMeasure (Vector3 availableSize) const
 Default implementation of measure for a layout that accommodates all children at its center. More...
 
void centeredArrange (Vector3 actualSize) const
 Default implementation of arrange for a layout that accommodates all children at its center. More...
 
bool isPrimitiveLayout () const
 
virtual void render (Renderer3D &renderer, const KzuTransformedObjectNode &transformedObjectNode, KzcMatrix4x4 &worldTransformation)
 Renders the object if the object type has specified a renderer function. More...
 
void renderDebugObjects (Renderer3D &renderer, const TransformedScene3D &transformedScene, const KzuTransformedObjectNode &transformedObjectNode)
 Renders the debug visualizations for the object. More...
 
Node3DSharedPtr getLookAtTarget () const
 
Node3DSharedPtr getPositionConstraintTarget () const
 
Node3DSharedPtr getOrientationConstraintTarget () const
 
Node3DSharedPtr getFaceToCameraTarget () const
 
virtual void onNodePropertyChanged (AbstractPropertyType propertyType, KzuPropertyNotificationReason reason) KZ_OVERRIDE
 Method executed on node property change. More...
 
- Public Member Functions inherited from kanzi::Node
virtual ~Node ()
 Destructor. More...
 
template<typename DataType >
PropertyType< DataType >::DataType getProperty (const PropertyType< DataType > &propertyType) const
 Returns the current value of a property. More...
 
template<typename DataType >
bool getProperty (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::DataType &value) const
 Evaluates the property value in the same way as the overload above but does not default to the value in property metadata if there are no inputs to the property value. More...
 
template<typename DataType >
DataType getAbstractProperty (AbstractPropertyType abstractPropertyType) const
 
template<typename DataType >
bool getAbstractProperty (AbstractPropertyType abstractPropertyType, typename PropertyType< DataType >::DataType &value) const
 
template<typename TMessageType , typename TClass , typename TClassMethod >
MessageSubscriptionToken addMessageHandler (TMessageType &messageType, TClass *messageHandlerObject, TClassMethod method)
 Adds a message handler where handler is a method to invoke on an object. More...
 
template<typename TMessageType , typename TClass , typename TClassMethod >
MessageSubscriptionToken addMessageFilter (TMessageType &messageType, TClass *messageHandlerObject, TClassMethod method)
 Adds a message filter where filter is a method to invoke on an object. More...
 
template<typename TMessageType >
MessageSubscriptionToken addMessageHandler (const TMessageType &messageType, typename TMessageType::FunctionType function)
 Adds a message handler where handler is function. More...
 
template<typename TMessageType >
MessageSubscriptionToken addMessageFilter (const TMessageType &messageType, typename TMessageType::FunctionType function)
 Adds a message filter where filter is function. More...
 
void removeMessageHandler (MessageSubscriptionToken token)
 Removes a message subscription. More...
 
template<typename TArgumentsType >
void dispatchMessage (const MessageType< TArgumentsType > &messageType, typename MessageType< TArgumentsType >::ArgumentsType &messageArguments)
 Dispatches a message with specified arguments. More...
 
void addResource (const ResourceID &resourceId, string_view resourceUrl)
 Adds a resource manager resource to an object node. If resourceID already exists in object, removes the existing entry. If resourceURL is NULL, error is thrown. */. More...
 
void removeResource (const ResourceID &resourceId)
 Removes a resource with given ID from object node resource dictionary. Does not do anything if resourceID was not found. */. More...
 
bool containsResource (const ResourceID &resourceID) const
 Returns if object node resource dictionary contains the resource with given ID. Resource can be any type: style, alias or resource manager resource. */. More...
 
optional< string > findResourceURL (const ResourceID &resourceId) const
 
ResourceSharedPtr acquireResource (const ResourceID &id) const
 Acquires a resource from the node or the node's closest ancestor having the resource id in the resource dictionary. More...
 
template<typename T >
shared_ptr< T > acquireResource (const ResourceID &id) const
 Acquires a resource from the node or the node's closest ancestor having the resource id in the resource dictionary, and casts the resource to given type. More...
 
ResourceSharedPtr tryAcquireResource (const ResourceID &id) const
 Acquires a resource from the node or the node's closest ancestor having the resource id in the resource dictionary. More...
 
template<typename T >
shared_ptr< T > tryAcquireResource (const ResourceID &id) const
 Acquires a resource from the node or the node's closest ancestor having the resource and casts the resource to given type. More...
 
ResourceDictionarySharedPtr getResourceDictionary () const
 
ResourceDictionarySharedPtr acquireResourceDictionary ()
 
void setResourceDictionary (ResourceDictionarySharedPtr resourceDictionary)
 
void addAnonymousResource (ResourceSharedPtr resource)
 Adds alias resource to an object node. More...
 
void removeAnonymousResource (const Resource &resource)
 Removes anonymous resource from object node resources. More...
 
bool isNamed (string_view name) const
 
NodegetParent () const
 Returns the parent of the node. More...
 
void setParent (Node *parent)
 
VisitorResult visit (const Visitor &visitor, VisitorOrder order)
 
VisitorResult visitDescendants (const Visitor &visitor, VisitorOrder order)
 
template<typename Type >
shared_ptr< Type > lookupNode (string_view pathOrKey)
 Returns a node of specified type by looking it up with specified path or alias. More...
 
NodelookupNodeRaw (string_view relativePath)
 Get an object node by another node and a relative path. More...
 
ObjectSharedPtr lookupObject (string_view relativePath)
 Lookup for an object from a node. More...
 
template<typename Type >
shared_ptr< Type > lookupObject (string_view path)
 
ObjectSharedPtr lookupResource (string_view resourceName)
 Lookup for a resource from a node. More...
 
template<typename TNodeType >
shared_ptr< TNodeType > findAbstractChild (string_view name)
 Find a child by name. Finds direct children as well as children connected indirectly for example Viewport->Scene. More...
 
void addInputManipulator (InputManipulatorSharedPtr inputManipulator)
 Transfers the ownership and attaches an input manipulator to an object node. More...
 
void removeInputManipulator (InputManipulator &inputManipulator)
 Removes the ownership and detaches an input manipulator from an object node. More...
 
InputManipulatorConstIterator beginInputManipulators () const
 
InputManipulatorConstIterator endInputManipulators () const
 
void addBinding (BindingSharedPtr binding)
 Transfers the ownership of a binding rule to an object node. More...
 
void addBindingWithOwner (BindingSharedPtr binding, const void *owner)
 Transfers the ownership of a binding rule to an object node and sets the owner of binding rule. More...
 
void removeBinding (Binding &binding)
 Removes the ownership and detaches a binding rule from an object node. More...
 
void removeBindingsWithOwner (const void *owner)
 Removes all bindings with the specified owner. More...
 
BindingConstIterator beginBindings () const
 
BindingConstIterator endBindings () const
 
void addTrigger (TriggerSharedPtr trigger)
 Transfers the ownership of a trigger to an object node. More...
 
void addTriggerWithOwner (TriggerSharedPtr trigger, const void *owner)
 Transfers the ownership of a trigger to an object node and sets the owner of the trigger. More...
 
void removeTrigger (Trigger &trigger)
 Removes the ownership of a trigger from an object node. More...
 
void removeTriggersWithOwner (const void *owner)
 Removes all bindings with the specified owner. More...
 
TriggerConstIterator beginTriggers () const
 
TriggerConstIterator endTriggers () const
 
void setRenderable (bool state)
 Sets whether the object node is renderable. More...
 
bool isRenderable () const
 Returns whether node is renderable. More...
 
bool isEffectivelyVisible () const
 Checks if the node and all of its ancestors are visible. More...
 
bool isEffectivelyEnabled () const
 Checks if the node and all of its ancestors are enabled. More...
 
uint32_t getChangeFlags () const
 Get current change flags. More...
 
uint32_t getChildChangeFlags () const
 Get current child change flags. More...
 
void setChangeFlag (uint32_t flag)
 Sets a change flag. More...
 
void clearChangeFlag (uint32_t flag)
 Clears a change flag. More...
 
bool isChangeFlagSet (uint32_t flag) const
 Checks if a change flag is set. More...
 
void setChildChangeFlag (uint32_t flag)
 Sets a child change flag. More...
 
void clearChildChangeFlag (uint32_t flag)
 Clears a child change flag. More...
 
bool isChildChangeFlagSet (uint32_t flag) const
 Checks if child change flags match. More...
 
bool isAnyChildChangeFlagSet (uint32_t flag) const
 Checks if any child change flags (corresponding to given mask) are set. More...
 
bool isInvalidMeasure () const
 Check if the node needs measure. More...
 
void invalidateMeasure ()
 Invalidates measure for the node. More...
 
void validateMeasure ()
 Validates measure for the node. More...
 
bool isInvalidArrange () const
 Checks if the node needs arrange. More...
 
void invalidateArrange ()
 Invalidates arrange. More...
 
void validateArrange ()
 Validates arrange. More...
 
bool isInvalidRender () const
 Returns if node render flag is invalid. More...
 
void validateRender ()
 Validates render for object node. More...
 
void invalidateRender ()
 Invalidates render for object node. More...
 
bool isAttached () const
 Returns true if the node is attached to a screen or one of its descendants. More...
 
bool isAttaching () const
 Returns true if node is in the process of attaching, false otherwise. More...
 
bool isDetaching () const
 Returns true if the node currently detaching. More...
 
void attachRecursive ()
 Attaches an object node and its children recursively. More...
 
void detachRecursive ()
 Detaches an object node and its children recursively. More...
 
kzsError addTimeLineEntry (struct KzuTimeLineEntry *timeLineEntry)
 Adds timeline entry for object's animation player. More...
 
TimeLineEntrySharedPtr addAnimationItem (AnimationItemSharedPtr animationItemSharedPtr, bool reverse, int repeatCount)
 Adds animation item for object's animation player. More...
 
kzsError createAnimationPlayerAttachToParentPlayer (struct KzuAnimationPlayer **out_animationPlayer)
 Create an animation player that references this object node, attach to an animation player in parent node. More...
 
kzsError createAnimationPlayerAttachToTaskScheduler (struct KzuAnimationPlayer **out_animationPlayer)
 Create an animation player that references this object node, attach to the master animation player in task scheduler. More...
 
kzsError animationPlayerAttachToTaskScheduler (struct KzuAnimationPlayer *animationPlayer) const
 Attach given animation player to the task scheduler acquired via the object node. More...
 
struct KzuAnimationPlayergetAnimationPlayer () const
 Returns animation player from object node. More...
 
virtual void getBoundingVolume (KzuBoundingVolume **out_boundingVolume) const
 Gets bounding volume from object node. More...
 
AppliedStyleEntryapplyStyle (StyleSharedPtr style)
 Applies a style to an object node. More...
 
void unapplyStyle (AppliedStyleEntry *appliedStyleEntry)
 Unapplies a style from an object node. More...
 
void applyStyles ()
 Apply all styles for an object node. More...
 
void unapplyStyles ()
 Unapplies and removes all applied styles. More...
 
void applyStylesRecursive ()
 Applies styles recursively. More...
 
void unapplyStylesRecursive ()
 Unapplies styles recursively. More...
 
void removeKZBData ()
 Destroys all object node data loaded from KZB, including properties, bindings, triggers, resources etc. More...
 
void addPropertyNotificationHandler (AbstractPropertyType propertyType, AbstractPropertyNotificationHandler *handler)
 Add an abstract property notification handler. More...
 
void removePropertyNotificationHandler (const AbstractPropertyNotificationHandler &handler)
 Remove an abstract property notification handler. More...
 
size_t getPropertyNotificationHandlerCount () const
 Gets number of current notification handlers. More...
 
void addResourceReference (AbstractPropertyType propertyType, AbstractResourceReference *reference)
 This is a helper for automatic resource tracking in ResourceReference. More...
 
void removeResourceReference (const AbstractResourceReference &reference)
 This is a helper for automatic resource tracking in ResourceReference. More...
 
void addNodeReference (AbstractPropertyType propertyType, AbstractNodeReference *reference)
 
void removeNodeReference (const AbstractNodeReference &reference)
 
virtual void restoreResources ()
 Reattaches an object node after potential resource change. More...
 
ScriptingContextSharedPtr getScriptingContext () const
 
void setScriptingContext (ScriptingContextSharedPtr context)
 
string getName () const
 Gets the value of NameProperty. More...
 
void setName (string value)
 Sets the value of NameProperty. More...
 
string getPath () const
 Gets the value of PathProperty. More...
 
void setPath (string value)
 Sets the value of PathProperty. More...
 
string getLocale () const
 Gets the value of LocaleProperty. More...
 
void setLocale (string value)
 Sets the value of LocaleProperty. More...
 
float getWidth () const
 Gets the value of WidthProperty. More...
 
void setWidth (float value)
 Sets the value of WidthProperty. More...
 
float getHeight () const
 Gets the value of HeightProperty. More...
 
void setHeight (float value)
 Sets the value of HeightProperty. More...
 
float getDepth () const
 Gets the value of DepthProperty. More...
 
void setDepth (float value)
 Sets the value of DepthProperty. More...
 
float getActualWidth () const
 Gets the value of ActualWidthProperty. More...
 
void setActualWidth (float value)
 Sets the value of ActualWidthProperty. More...
 
float getActualHeight () const
 Gets the value of ActualHeightProperty. More...
 
void setActualHeight (float value)
 Sets the value of ActualHeightProperty. More...
 
float getActualDepth () const
 Gets the value of ActualDepthProperty. More...
 
void setActualDepth (float value)
 Sets the value of ActualDepthProperty. More...
 
Node::HorizontalAlignment getHorizontalAlignment () const
 Gets the value of HorizontalAlignmentProperty. More...
 
void setHorizontalAlignment (Node::HorizontalAlignment value)
 Sets the value of HorizontalAlignmentProperty. More...
 
Node::VerticalAlignment getVerticalAlignment () const
 Gets the value of VerticalAlignmentProperty. More...
 
void setVerticalAlignment (Node::VerticalAlignment value)
 Sets the value of VerticalAlignmentProperty. More...
 
Node::DepthAlignment getDepthAlignment () const
 Gets the value of DepthAlignmentProperty. More...
 
void setDepthAlignment (Node::DepthAlignment value)
 Sets the value of DepthAlignmentProperty. More...
 
Vector2 getHorizontalMargin () const
 Gets the value of HorizontalMarginProperty. More...
 
void setHorizontalMargin (Vector2 value)
 Sets the value of HorizontalMarginProperty. More...
 
Vector2 getVerticalMargin () const
 Gets the value of VerticalMarginProperty. More...
 
void setVerticalMargin (Vector2 value)
 Sets the value of VerticalMarginProperty. More...
 
Vector2 getDepthMargin () const
 Gets the value of DepthMarginProperty. More...
 
void setDepthMargin (Vector2 value)
 Sets the value of DepthMarginProperty. More...
 
bool isHitTestable () const
 Gets the value of HitTestableProperty. More...
 
void setHitTestable (bool value)
 Sets the value of HitTestableProperty. More...
 
bool isHitTestableContainer () const
 Gets the value of HitTestableContainerProperty. More...
 
void setHitTestableContainer (bool value)
 Sets the value of HitTestableContainerProperty. More...
 
bool isVisible () const
 Gets the value of VisibleProperty. More...
 
void setVisible (bool value)
 Sets the value of VisibleProperty. More...
 
bool isEnabled () const
 Gets the value of EnabledProperty. More...
 
void setEnabled (bool value)
 Sets the value of EnabledProperty. More...
 
bool isFocusable () const
 Gets the value of FocusableProperty. More...
 
void setFocusable (bool value)
 Sets the value of FocusableProperty. More...
 
bool isFocused () const
 Gets the value of FocusedProperty. More...
 
void setFocused (bool value)
 Sets the value of FocusedProperty. More...
 
ResourceID getFontResourceID () const
 Gets the value of FontProperty. More...
 
void setFontResourceID (ResourceID value)
 Sets the value of FontProperty. More...
 
float getVisibleAmountInParent () const
 Gets the value of VisibleAmountInParentProperty. More...
 
void setVisibleAmountInParent (float value)
 Sets the value of VisibleAmountInParentProperty. More...
 
bool isClipChildren () const
 Gets the value of ClipChildrenProperty. More...
 
void setClipChildren (bool value)
 Sets the value of ClipChildrenProperty. More...
 
float getProjection2DTo3DScale () const
 Gets the value of Projection2DTo3DScaleProperty. More...
 
void setProjection2DTo3DScale (float value)
 Sets the value of Projection2DTo3DScaleProperty. More...
 
string getDataContext () const
 Gets the value of DataContextProperty. More...
 
void setDataContext (string value)
 Sets the value of DataContextProperty. More...
 
bool isEnableClick () const
 Gets the value of EnableClickProperty. More...
 
void setEnableClick (bool value)
 Sets the value of EnableClickProperty. More...
 
bool isEnableMultiClick () const
 Gets the value of EnableMultiClickProperty. More...
 
void setEnableMultiClick (bool value)
 Sets the value of EnableMultiClickProperty. More...
 
Node::ContentStretch getContentStretch () const
 Gets the value of ContentStretchProperty. More...
 
void setContentStretch (Node::ContentStretch value)
 Sets the value of ContentStretchProperty. More...
 
float getOpacity () const
 Gets the value of OpacityProperty. More...
 
void setOpacity (float value)
 Sets the value of OpacityProperty. More...
 
ResourceID getStyleResourceID () const
 Gets the value of StyleProperty. More...
 
void setStyleResourceID (ResourceID value)
 Sets the value of StyleProperty. More...
 
ResourceID getStateManagerResourceID () const
 Gets the value of StateManagerProperty. More...
 
void setStateManagerResourceID (ResourceID value)
 Sets the value of StateManagerProperty. More...
 
- Public Member Functions inherited from kanzi::Object
 Object (Domain *domain)
 
virtual ~Object ()
 
DomaingetDomain () const
 Returns the domain the object belongs to. More...
 
KzuPropertyManager * getPropertyManager () const
 Returns the property manager of the object. More...
 
KzuTaskSchedulergetTaskScheduler () const
 Returns the task scheduler of the object. More...
 
KzuMessageDispatchergetMessageDispatcher () const
 Returns the message dispatcher of the object. More...
 
ResourceManagergetResourceManager () const
 Returns the resource manager of the object. More...
 
virtual const MetaclassgetDynamicMetaclass () const
 Returns the metaclass of the dynamic type of the object. More...
 
bool isTypeOf (const Metaclass *objectType) const
 Determines if the type of this object is the given type or derived from it. More...
 
template<typename DataType >
void setProperty (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::DataType value)
 Sets the local value of a property. More...
 
void setProperty (const PropertyType< ResourceID > &propertyType, ResourceSharedPtr value)
 Sets the local value of a resource id property with a resource pointer. More...
 
template<typename DataType >
DataType getProperty (const PropertyType< DataType > &propertyType) const
 Returns the current value of a property. More...
 
template<typename DataType >
bool getProperty (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::DataType &value) const
 Evaluates the property value in the same way as the overload above but does not default to the value in property metadata if there are no inputs to the property value. More...
 
template<typename DataType >
void setAbstractProperty (AbstractPropertyType abstractPropertyType, typename PropertyType< DataType >::DataType value)
 
void setAbstractProperty (AbstractPropertyType abstractPropertyType, ResourceSharedPtr value)
 
template<typename DataType >
DataType getAbstractProperty (AbstractPropertyType abstractPropertyType) const
 
template<typename DataType >
bool getAbstractProperty (AbstractPropertyType abstractPropertyType, typename PropertyType< DataType >::DataType &value) const
 
bool hasValue (AbstractPropertyType propertyType) const
 Evaluates whether there are any inputs into the property value. More...
 
bool hasLocalValue (AbstractPropertyType propertyType) const
 Evaluates whether there is a local value set for the property. More...
 
void removeLocalValue (AbstractPropertyType propertyType)
 Removes the local value associated with the property. More...
 
void copyLocalValues (const Object &other)
 Copies all local values from another object. More...
 
AppliedStyleEntryapplyObjectStyle (kanzi::StyleSharedPtr style)
 Applies a style to an object. More...
 
void unapplyObjectStyle (AppliedStyleEntry *appliedStyleEntry)
 
void applyObjectStyles ()
 Apply all styles for an object node. More...
 
void unapplyObjectStyles ()
 Unapplies and removes all applied styles. More...
 

Static Public Member Functions

static TrajectoryLayout3DSharedPtr create (Domain *domain, string_view name)
 Creates a trajectory layout node. More...
 
static
PropertyTypeEditorInfoSharedPtr 
makeEditorInfo ()
 
static float getItemOffset (const Node &item)
 Gets the offset of an item. More...
 
static bool getOverrideOffset (const Node &item, float &staticOffset)
 Gets static offset of an item. More...
 
static void setOverrideOffset (Node &item, float staticOffset)
 Sets static offset of an item. More...
 
- Static Public Member Functions inherited from kanzi::Node3D
static float layoutUp ()
 
static Vector3 unboundedLayoutValue ()
 Returns unbounded layout value. More...
 
static
PropertyTypeEditorInfoSharedPtr 
makeEditorInfo ()
 
- Static Public Member Functions inherited from kanzi::Object
static const MetaclassgetStaticMetaclass ()
 Returns the metaclass of Object class. More...
 
static
PropertyTypeEditorInfoSharedPtr 
makeEditorInfo ()
 Default implementation that returns empty editor info. More...
 
- Static Public Member Functions inherited from kanzi::TrajectoryLayoutConcept
static
PropertyTypeEditorInfoSharedPtr 
makeEditorInfo ()
 

Protected Member Functions

 TrajectoryLayout3D (Domain *domain, string_view name)
 Constructor. More...
 
virtual Vector3 measureOverride (Vector3 availableSize) KZ_OVERRIDE
 KzuUiComponent::measureOverride() implementation. More...
 
virtual void arrangeOverride (Vector3 actualSize) KZ_OVERRIDE
 KzuUiComponent::arrangeOverride() implementation. More...
 
virtual void renderDebugObjectsOverride (Renderer3D &renderer, const TransformedScene3D &transformedScene, const KzuTransformedObjectNode &transformedObjectNode) KZ_OVERRIDE
 
void updateItemOffsetProperty (const Node3DSharedPtr &item) const
 Updates the offset property value of an item, which the user of the layout can later retrieve from #TrajectoryOffsetProperty. More...
 
void updateItemAmountVisibleInParentProperty (const Node3DSharedPtr &item) const
 Updates the visible amount value for an item, which the user of the layout can later retrieve from #VisibleAmountInParent. More...
 
- Protected Member Functions inherited from kanzi::Node3D
 Node3D (Domain *domain, string_view name)
 
virtual NodeSharedPtr findAbstractChildOverride (string_view name) KZ_OVERRIDE
 
virtual VisitorResult visitAbstractChildOverride (const Visitor &visitor, VisitorOrder order) KZ_OVERRIDE
 
void setPrimitiveLayout (bool primitive)
 
- Protected Member Functions inherited from kanzi::Node
 Node (Domain *domain, string_view name)
 Constructor. More...
 
void initialize ()
 
virtual void onAttached ()
 Called when an object node becomes attached. More...
 
virtual void onDetached ()
 Called when an object node becomes detached. More...
 
void updateResourceReferences ()
 
void updateResourceReferences (AbstractPropertyType propertyType)
 
void updateResourceReferencesRecursive ()
 
void updateResourceReferencesRecursive (const ResourceID &resourceID)
 
void attach ()
 Attaches the object node. More...
 
void detach ()
 Detaches the object node. More...
 
- Protected Member Functions inherited from kanzi::Object
void initialize ()
 
void onCopy (const Object &other)
 

Additional Inherited Members

- Public Types inherited from kanzi::Node3D
typedef Vector3 LayoutVectorType
 
typedef Matrix4x4 LayoutMatrixType
 
typedef vector< Node3DSharedPtrChildContainer
 Iterators for children. More...
 
typedef
ChildContainer::const_iterator 
ChildConstIterator
 
typedef
ChildContainer::const_reverse_iterator 
ChildConstReverseIterator
 
- Public Types inherited from kanzi::Node
enum  HorizontalAlignment { HorizontalAlignmentLeft, HorizontalAlignmentRight, HorizontalAlignmentCenter, HorizontalAlignmentStretch }
 Horizontal alignment options. More...
 
enum  VerticalAlignment { VerticalAlignmentBottom, VerticalAlignmentTop, VerticalAlignmentCenter, VerticalAlignmentStretch }
 Vertical alignment options. More...
 
enum  DepthAlignment { DepthAlignmentBack, DepthAlignmentFront, DepthAlignmentCenter, DepthAlignmentStretch }
 Depth alignment options. More...
 
enum  ContentStretch {
  ContentStretchNone, ContentStretchFill, ContentStretchUniform, ContentStretchUniformToFill,
  ContentStretchRepeat
}
 Content stretch option. More...
 
enum  VisitorOrder { VisitorPreOrder, VisitorPostOrder }
 
enum  VisitorResult { VisitorAbort, VisitorContinue, VisitorContinueSibling }
 
typedef kanzi::vector
< Node::MessageSubscriptionToken > 
MessageSubscriptionTokenVector
 
typedef function
< VisitorResult(Node &)> 
Visitor
 
typedef vector
< InputManipulatorSharedPtr
InputManipulatorContainer
 Gets the input manipulator iterator. More...
 
typedef
InputManipulatorContainer::iterator 
InputManipulatorIterator
 
typedef
InputManipulatorContainer::const_iterator 
InputManipulatorConstIterator
 
typedef vector< BindingEntryBindingContainer
 Gets the bindings iterator. More...
 
typedef BindingContainer::iterator BindingIterator
 
typedef
BindingContainer::const_iterator 
BindingConstIterator
 
typedef vector< TriggerEntryTriggerContainer
 Gets the triggers iterator. More...
 
typedef TriggerContainer::iterator TriggerIterator
 
typedef
TriggerContainer::const_iterator 
TriggerConstIterator
 
- Static Public Attributes inherited from kanzi::Node3D
static PropertyType< Matrix4x4RenderTransformationProperty
 RenderTransformation property. More...
 
static PropertyType< Matrix4x4LayoutTransformationProperty
 LayoutTransformation property. More...
 
static PropertyType< Matrix4x4FinalTransformationProperty
 FinalTransformation property. More...
 
static PropertyType< bool > ObjectDepthTestProperty
 ObjectDepthTest property. More...
 
static PropertyType< bool > ObjectDepthWriteProperty
 ObjectDepthWrite property. More...
 
static PropertyType< bool > ObjectScissorEnabledProperty
 ObjectScissorEnabled property. More...
 
static PropertyType< Vector2ObjectScissorAreaXYProperty
 ObjectScissorAreaXY property. More...
 
static PropertyType< Vector2ObjectScissorAreaWidthHeightProperty
 ObjectScissorAreaWidthHeight property. More...
 
static PropertyType< float > FrustumCullMarginProperty
 FrustumCullMargin property. More...
 
- Static Public Attributes inherited from kanzi::Node
static PropertyType< string > NameProperty
 Name property. More...
 
static PropertyType< string > PathProperty
 Path property. More...
 
static PropertyType< string > LocaleProperty
 Locale property. More...
 
static PropertyType< bool > CreatedFromKZBProperty
 CreatedFromKZB property. More...
 
static PropertyType< float > WidthProperty
 Width property. More...
 
static PropertyType< float > HeightProperty
 Height property. More...
 
static PropertyType< float > DepthProperty
 Depth property. More...
 
static PropertyType< float > ActualWidthProperty
 ActualWidth property. More...
 
static PropertyType< float > ActualHeightProperty
 ActualHeight property. More...
 
static PropertyType< float > ActualDepthProperty
 ActualDepth property. More...
 
static PropertyType
< Node::HorizontalAlignment
HorizontalAlignmentProperty
 HorizontalAlignment property. More...
 
static PropertyType
< Node::VerticalAlignment
VerticalAlignmentProperty
 VerticalAlignment property. More...
 
static PropertyType
< Node::DepthAlignment
DepthAlignmentProperty
 DepthAlignment property. More...
 
static PropertyType< Vector2HorizontalMarginProperty
 HorizontalMargin property. More...
 
static PropertyType< Vector2VerticalMarginProperty
 VerticalMargin property. More...
 
static PropertyType< Vector2DepthMarginProperty
 DepthMargin property. More...
 
static PropertyType< bool > HitTestableProperty
 HitTestable property. More...
 
static PropertyType< bool > HitTestableContainerProperty
 HitTestableContainer property. More...
 
static PropertyType< bool > VisibleProperty
 Visible property. More...
 
static PropertyType< bool > EnabledProperty
 Enabled property. More...
 
static PropertyType< bool > FocusableProperty
 Focusable property. More...
 
static PropertyType< bool > FocusedProperty
 Focused property. More...
 
static PropertyType< ResourceIDFontProperty
 Font property. More...
 
static PropertyType< float > VisibleAmountInParentProperty
 VisibleAmountInParent property. More...
 
static PropertyType< bool > ClipChildrenProperty
 ClipChildren property. More...
 
static PropertyType< float > Projection2DTo3DScaleProperty
 Projection2DTo3DScale property. More...
 
static PropertyType< string > DataContextProperty
 DataContext property. More...
 
static PropertyType< bool > EnableClickProperty
 EnableClick property. More...
 
static PropertyType< bool > EnableMultiClickProperty
 EnableMultiClick property. More...
 
static PropertyType
< Node::ContentStretch
ContentStretchProperty
 ContentStretch property. More...
 
static PropertyType< float > OpacityProperty
 Opacity property. More...
 
static PropertyType< ResourceIDStyleProperty
 Style property. More...
 
static PropertyType< ResourceIDStateManagerProperty
 StateManager property. More...
 
static PropertyType< int > SceneGraphAddNodeChangeChildFlagsProperty
 SceneGraphAddNodeChangeChildFlags property. More...
 
static PropertyType< int > SceneGraphAddNodeChangeParentFlagsProperty
 SceneGraphAddNodeChangeParentFlags property. More...
 
static PropertyType< int > SceneGraphRemoveNodeChangeChildFlagsProperty
 SceneGraphRemoveNodeChangeChildFlags property. More...
 
static PropertyType< int > SceneGraphRemoveNodeChangeParentFlagsProperty
 SceneGraphRemoveNodeChangeParentFlags property. More...
 
static PropertyType< void * > PrefabTemplateSourceProperty
 PrefabTemplateSource property. More...
 
- Static Public Attributes inherited from kanzi::TrajectoryLayoutConcept
static PropertyType< ResourceIDTrajectoryProperty
 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...
 
- Protected Types inherited from kanzi::Object
typedef vector
< AppliedStyleEntry * > 
AppliedStyleContainer
 Applied style container. More...
 
- Static Protected Member Functions inherited from kanzi::Node
static VisitorResult updateResourceVisitor (Node &node, const ResourceID &id)
 
static VisitorResult updateAllResourcesVisitor (Node &node)
 
static VisitorResult applyStylesVisitor (Node &node, bool apply)
 
static VisitorResult attachVisitor (Node &node)
 
static VisitorResult detachVisitor (Node &node)
 
static void processPropertyChanged (Node &node, AbstractPropertyType propertyType, KzuPropertyNotificationReason reason)
 
static VisitorResult propertyChangedVisitor (Node &node, AbstractPropertyType propertyType, KzuPropertyNotificationReason reason)
 
- Protected Attributes inherited from kanzi::Object
AppliedStyleContainer m_appliedStyles
 Listing of applied styles applied to this object. More...
 

Detailed Description

Trajectory Layout 3D arranges its items along a trajectory.

You can use a line, a circle, or a spline as a trajectory for the trajectory layout. See TrajectoryProperty, setTrajectoryResourceID(), using_resource_ids.

Based on the number of items in a trajectory layout, the layout by default arranges its items so that they are separated by an equal amount of space. You can disable automatic positioning by manually setting the distance between items. See setItemStaticOffset(), setFixedDistance().

See also
For a 2D trajectory layout component, see #TrajectoryLayout2D.

Examples

To create a Trajectory Layout 3D object:

// Create a Trajectory Layout 3D named Trajectory.
TrajectoryLayout3DSharedPtr trajectoryLayout = TrajectoryLayout3D::create(domain, "Trajectory");

To set the trajectory you want the trajectory layout to use:

// Use a trajectory with the resource ID MyTrajectory as the trajectory for the trajectory layout.
trajectoryLayout->setTrajectoryResourceID(ResourceID("MyTrajectory"));

To create a trajectory and use it in a trajectory layout:

// Create a circle trajectory named Circle with radius of 4 device independent units.
// Set the trajectory layout to use it.
TrajectorySharedPtr trajectoryResource = Trajectory::createCircle(Vector3(), Vector3::up(), 0.0f, 4.0f, domain, "Circle");
trajectoryLayout->setUserTrajectory(trajectoryResource);

To add items to a trajectory layout:

// Create cube meshes and add them as items of the trajectory layout.
// Items on the trajectory appear in the order you add them to the trajectory layout.
Model3DSharedPtr item1 = Model3D::createCube(domain, "item1", 1.0f, KanziThemeRed);
trajectoryLayout->addChild(item1);
Model3DSharedPtr item2 = Model3D::createCube(domain, "item2", 1.0f, KanziThemeGreen);
trajectoryLayout->addChild(item2);
Model3DSharedPtr item3 = Model3D::createCube(domain, "item3", 1.0f, KanziThemeBlue);
trajectoryLayout->addChild(item3);
Model3DSharedPtr item4 = Model3D::createCube(domain, "item4", 1.0f, KanziThemeOrange);
trajectoryLayout->addChild(item4);
Model3DSharedPtr item5 = Model3D::createCube(domain, "item5", 1.0f, KanziThemeGray);
trajectoryLayout->addChild(item5);

To manually position items in a trajectory layout:

// Position an item in the middle of the trajectory.
// Set the distance between the items to one third of the length of the trajectory.
trajectoryLayout->setOverrideDistance(0.3f);

Constructor & Destructor Documentation

kanzi::TrajectoryLayout3D::TrajectoryLayout3D ( Domain domain,
string_view  name 
)
explicitprotected

Constructor.

Parameters
domainThe UI domain the new node belongs to.
nameThe name of the node.

Member Function Documentation

static TrajectoryLayout3DSharedPtr kanzi::TrajectoryLayout3D::create ( Domain domain,
string_view  name 
)
static

Creates a trajectory layout node.

Parameters
domainThe UI domain the new node belongs to.
nameName of the trajectory layout.
static PropertyTypeEditorInfoSharedPtr kanzi::TrajectoryLayout3D::makeEditorInfo ( )
static
void kanzi::TrajectoryLayout3D::setUserTrajectory ( const TrajectorySharedPtr trajectory)

Sets a trajectory to use.

The trajectory you set with this method overrides any trajectory specified through TrajectoryProperty.

Parameters
trajectoryTrajectory resource to use.
See also
TrajectoryProperty
TrajectorySharedPtr kanzi::TrajectoryLayout3D::getTrajectory ( ) const

Gets the trajectory currently used by the trajectory layout.

Returns
The trajectory resource currently in use.
See also
setTrajectoryResourceID(), setUserTrajectory()
float kanzi::TrajectoryLayout3D::getCalculatedOffset ( const Node3DSharedPtr item) const

Gets the offset calculated for an item.

Parameters
itemThe item that is a child of trajectory layout.
Returns
Returns the offset calculated for a child node. If the layout has not been calculated, it returns the previous value. If the item is not a child node of the trajectory layout, it returns 0.0f.
Vector3 kanzi::TrajectoryLayout3D::getCalculatedPosition ( const Node3DSharedPtr item) const

Gets the position calculated for an item.

Parameters
itemThe item that is a child of trajectory layout.
Returns
Returns the position calculated for an item. If the layout has not been calculated, it returns the previous value. If the item is not a child node of the trajectory layout, it returns the starting position.
Vector3 kanzi::TrajectoryLayout3D::getCalculatedTangent ( const Node3DSharedPtr item) const

Gets the tangent calculated for an item.

Parameters
itemThe item that is a child of trajectory layout.
Returns
Returns the tangent calculated for an item. If the layout has not been calculated, it returns the previous value. If the item is not a child node of the trajectory layout, it returns Vector3(-1.0f, 0.0f, 0.0f).
float kanzi::TrajectoryLayout3D::getCurveLength ( ) const

Gets the length of the trajectory used by the trajectory layout.

Returns
Returns the length of the trajectory.
See also
KzuTrajectory
float kanzi::TrajectoryLayout3D::proportionalToLength ( float  proportionalOffset) const

Converts a proportional offset to a length offset.

Parameters
proportionalOffsetOffset in [0, 1] range.
Returns
Returns the offset mapped to the length of the trajectory.
float kanzi::TrajectoryLayout3D::lengthToProportional ( float  lengthOffset) const

Converts a length offset to a proportional offset.

Parameters
lengthOffsetOffset on the trajectory.
Returns
Returns the offset mapped to [0, 1] range.
static float kanzi::TrajectoryLayout3D::getItemOffset ( const Node item)
static

Gets the offset of an item.

Parameters
itemA node that is or can become an item of a trajectory layout.
Returns
Returns the last offset calculated for the item by trajectory layout.
static bool kanzi::TrajectoryLayout3D::getOverrideOffset ( const Node item,
float &  staticOffset 
)
static

Gets static offset of an item.

Parameters
itemA node that is or can become an item of a trajectory layout.
[out]staticOffsetReceives the static offset value if the item has #StaticTrajectoryOffsetProperty set. The parameter is not modified if the property is not set.
Returns
Returns true if #StaticTrajectoryOffsetProperty is set on the item, false otherwise.
static void kanzi::TrajectoryLayout3D::setOverrideOffset ( Node item,
float  staticOffset 
)
static

Sets static offset of an item.

Parameters
itemA node that is or can become an item of a trajectory layout.
staticOffsetStatic offset to use for the item on a trajectory.
// Position an item in the middle of the trajectory.
// Set the distance between the items to one third of the length of the trajectory.
trajectoryLayout->setOverrideDistance(0.3f);
ResourceID kanzi::TrajectoryLayout3D::getTrajectoryResourceID ( ) const
inline

Gets the value of TrajectoryProperty.

See also
setTrajectoryResourceID()
void kanzi::TrajectoryLayout3D::setTrajectoryResourceID ( ResourceID  value)
inline

Sets the value of TrajectoryProperty.

See also
getTrajectoryResourceID()
float kanzi::TrajectoryLayout3D::getItemAreaBegin ( ) const
inline

Gets the value of #ClipStartOffsetProportionalProperty.

See also
setClipStartOffsetProportional()
void kanzi::TrajectoryLayout3D::setItemAreaBegin ( float  value)
inline

Sets the value of #ClipStartOffsetProportionalProperty.

See also
getClipStartOffsetProportional()
float kanzi::TrajectoryLayout3D::getItemAreaEnd ( ) const
inline

Gets the value of #ClipEndOffsetProportionalProperty.

See also
setClipEndOffsetProportional()
void kanzi::TrajectoryLayout3D::setItemAreaEnd ( float  value)
inline

Sets the value of #ClipEndOffsetProportionalProperty.

See also
getClipEndOffsetProportional()
float kanzi::TrajectoryLayout3D::getOverrideDistance ( ) const
inline

Gets the value of #FixedDistanceProperty.

See also
setFixedDistance()
void kanzi::TrajectoryLayout3D::setOverrideDistance ( float  value)
inline

Sets the value of #FixedDistanceProperty.

See also
getFixedDistance()
float kanzi::TrajectoryLayout3D::getStartOffset ( ) const
inline

Gets the value of #ScrollOffsetProportionalProperty.

See also
setScrollOffsetProportional()
void kanzi::TrajectoryLayout3D::setStartOffset ( float  value)
inline

Sets the value of #ScrollOffsetProportionalProperty.

See also
getScrollOffsetProportional()
bool kanzi::TrajectoryLayout3D::isAlignToTangent ( ) const
inline

Gets the value of AlignToTangentProperty.

See also
setAlignToTangent()
void kanzi::TrajectoryLayout3D::setAlignToTangent ( bool  value)
inline

Sets the value of AlignToTangentProperty.

See also
isAlignToTangent()
bool kanzi::TrajectoryLayout3D::isStretch ( ) const
inline

Gets the value of #EnableTrajectoryScalingProperty.

See also
setEnableTrajectoryScaling()
void kanzi::TrajectoryLayout3D::setStretch ( bool  value)
inline

Sets the value of #EnableTrajectoryScalingProperty.

See also
isEnableTrajectoryScaling()
Vector3 kanzi::TrajectoryLayout3D::getScaling ( ) const
inline

Return scaling factor.

void kanzi::TrajectoryLayout3D::refreshScaling ( const Vector3 availableSize)
virtual Vector3 kanzi::TrajectoryLayout3D::measureOverride ( Vector3  availableSize)
protectedvirtual

KzuUiComponent::measureOverride() implementation.

Reimplemented from kanzi::Node3D.

virtual void kanzi::TrajectoryLayout3D::arrangeOverride ( Vector3  actualSize)
protectedvirtual

KzuUiComponent::arrangeOverride() implementation.

Reimplemented from kanzi::Node3D.

virtual void kanzi::TrajectoryLayout3D::renderDebugObjectsOverride ( Renderer3D renderer,
const TransformedScene3D transformedScene,
const KzuTransformedObjectNode transformedObjectNode 
)
protectedvirtual

Reimplemented from kanzi::Node3D.

void kanzi::TrajectoryLayout3D::updateItemOffsetProperty ( const Node3DSharedPtr item) const
protected

Updates the offset property value of an item, which the user of the layout can later retrieve from #TrajectoryOffsetProperty.

Parameters
itemThe item that is a child of trajectory layout.
void kanzi::TrajectoryLayout3D::updateItemAmountVisibleInParentProperty ( const Node3DSharedPtr item) const
protected

Updates the visible amount value for an item, which the user of the layout can later retrieve from #VisibleAmountInParent.

Parameters
itemThe item that is a child of trajectory layout.
See also
#VisibleAmountInParent

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