Kanzi 4.1.1
TextBlock3D Class Reference

To render a Text Block 3D node Kanzi: to scale pixels to 3D units. More...

Inheritance diagram for TextBlock3D:
[legend]

Static Public Member Functions

static ObjectRef< TextBlock3Dcreate (Domain domain, String name)
 Creates a TextBlock3D node.
 
- Static Public Member Functions inherited from Node3DProxy
static boolean isUnboundedLayoutSize (Vector3 layoutSize)
 Returns whether a layout size is an unbounded layout size.
 
static boolean isValidLayoutSize (Vector3 size)
 Returns whether a given size is a valid layout size.
 
static float layoutUp ()
 Returns the direction toward which the y axis of a 3D node grows.
 
static Vector3 replaceUnboundedLayoutSize (Vector3 layoutSize, Vector3 resetSize)
 Replaces any elements in an unbounded layout size with the corresponding elements of a given size.
 
static Vector3 replaceUnboundedLayoutSizeWithZero (Vector3 layoutSize)
 Replaces any elements in an unbounded layout size with zero.
 
static Vector3 unboundedLayoutSize ()
 Returns an unbounded layout size.
 
- Static Public Member Functions inherited from NodeProxy
static boolean isUnboundedLayoutValue (float layoutValue)
 Indicates whether a value is an unbound layout value.
 
static boolean isValidLayoutValue (float value)
 Indicates whether a value is valid layout value.
 
static float unboundedLayoutValue ()
 Returns an unbounded layout value.
 

Static Public Attributes

static final Metaclass metaclass
 The Metaclass for the class.
 
- Static Public Attributes inherited from Node3D
static final Metaclass metaclass = com.rightware.kanzi.metadata.Node3DMetadata.metaclass
 The Metaclass for the class.
 
- Static Public Attributes inherited from Node3DProxy
static final Metaclass metaclass = com.rightware.kanzi.metadata.Node3DMetadata.metaclass
 The Metaclass for the class.
 
- Static Public Attributes inherited from Node
static final Metaclass metaclass = com.rightware.kanzi.metadata.NodeMetadata.metaclass
 The Metaclass for the class.
 
- Static Public Attributes inherited from NodeProxy
static final Metaclass metaclass = com.rightware.kanzi.metadata.NodeMetadata.metaclass
 The Metaclass for the class.
 
- Static Public Attributes inherited from KanziObject
static final Metaclass metaclass = new AbstractMetaclass("Kanzi.Object")
 The Metaclass for the class.
 

Additional Inherited Members

- Public Member Functions inherited from Node3D
void close ()
 Close the object, and release native resources.
 
Matrix4x4 getArrangeTransform ()
 Get arrange transform.
 
Matrix4x4 getFinalTransformation ()
 Gets the value of Node3DMetadata::FinalTransformationProperty.
 
Vector3 getLayoutBoundingBoxMax ()
 Get bounding box size max corner for an object.
 
Vector3 getLayoutBoundingBoxMin ()
 Get bounding box size min corner for an object.
 
SRTValue3D getLayoutTransformation ()
 Gets the value of Node3DMetadata::LayoutTransformationProperty.
 
SRTValue3D getRenderTransformation ()
 Gets the value of Node3DMetadata::RenderTransformationProperty.
 
Iterable< Node3DiterateChildren ()
 Gets an Iterable object used to iterate the Node3D children.
 
Iterable< Node3DiterateChildrenReverse ()
 Gets an Reverse Iterable object used to iterate the Node3D children.
 
void layout ()
 Does layout pass starting from this node and iterating recursively all of its children.
 
void lookAt (Vector3 position, Vector3 lookAtPoint, Vector3 upVector)
 Sets node transformation so that the node is in a given position looking at the given point.
 
Vector3 nGetMaximumBoundingBoxCoordinates ()
 Returns the minimum coordinates for object nodes bounding volume.
 
Vector3 nGetMinimumBoundingBoxCoordinates ()
 Returns the maximum coordinates for object nodes bounding volume.
 
void setArrangeTransform (Matrix4x4 transform)
 Set arrange transform.
 
void setAutoDepth ()
 Sets node to automatically determine depth.
 
void setAutoSize ()
 Sets node to automatically determine width, height and depth.
 
void setFinalTransformation (Matrix4x4 value)
 Sets the value of Node3DMetadata::FinalTransformationProperty.
 
void setLayoutTransformation (SRTValue3D value)
 Sets the value of Node3DMetadata::LayoutTransformationProperty.
 
void setRenderTransformation (SRTValue3D value)
 Sets the value of Node3DMetadata::RenderTransformationProperty.
 
void setSize (float width, float height, float depth)
 Sets size properties of the node.
 
- Public Member Functions inherited from Node3DProxy
void addChild (Node3D child)
 Adds a child node to a 3D node.
 
void arrange ()
 Performs layout arrangement on a 3D node.
 
void centeredArrange (Vector3 actualSize)
 Default implementation of arrange for a layout that accommodates all children at its center.
 
Vector3 centeredMeasure (Vector3 availableSize)
 Default implementation of measure for a layout that accommodates all children at its center.
 
Vector3 getActualSize ()
 Returns the actual size of a 3D node.
 
Vector3 getAllocatedOffset ()
 Returns the allocated offset of a 3D node.
 
Vector3 getAllocatedSize ()
 Returns the allocated size of a 3D node.
 
Matrix4x4 getArrangeTransformation ()
 Returns the layout transformation of a 3D node.
 
Node3D getChild (int index)
 Gets a child node at a given index.
 
int getChildCount ()
 Gets the number of child nodes in a 3D node.
 
int getChildIndex (Node child)
 Gets the index of a child node.
 
Vector3 getCoreDesiredSize ()
 Returns the core desired size of a 3D node.
 
Vector3 getDesiredSize ()
 Returns the desired size of a 3D node.
 
Node3D getFaceToCameraTarget ()
 
Node3D getLookAtTarget ()
 
Vector3 getMaximumBoundingBoxCoordinates ()
 Returns the maximum coordinates for the bounding volume of a 3D node.
 
Vector3 getMinimumBoundingBoxCoordinates ()
 Returns the minimum coordinates for the bounding volume of a 3D node.
 
Node3D getOrientationConstraintTarget ()
 
Vector3 getPivotOffset ()
 Returns the pivot offset of a 3D node.
 
Node3D getPositionConstraintTarget ()
 
Vector3 getSize ()
 Returns the size of a 3D node.
 
Vector3 getStretchScale ()
 Returns the stretch scale of a 3D node.
 
boolean hasChild (Node child)
 Returns whether a child node exists.
 
void insertChild (int index, Node3D child)
 Adds to a 3D node a child node at a given index.
 
boolean isPrimitiveLayout ()
 Indicates whether a 3D node has primitive layout behavior.
 
void measure (Vector3 availableSize)
 Performs the default measure step.
 
void moveToBack ()
 Repositions a 3D node to the beginning of the list of child nodes of its parent node, so that Kanzi draws the node first.
 
void moveToFront ()
 Repositions a 3D node to the end of the list of child nodes of its parent node, so that Kanzi draws the node last.
 
void removeAllChildren ()
 Removes all child nodes from a 3D node.
 
void removeChild (int index)
 Removes from a 3D node a child node at a given index.
 
void removeChild (Node child)
 Removes a child node from a 3D node.
 
void setActualSize (Vector3 actualSize)
 Sets the actual size of a 3D node.
 
void setAllocatedOffset (Vector3 allocatedOffset)
 Sets the allocated offset of a 3D node.
 
void setAllocatedSize (Vector3 layoutSize)
 Sets the allocated size of a 3D node.
 
void setArrangeTransformation (Matrix4x4 value)
 Sets the layout transformation of a 3D node.
 
void setCoreDesiredSize (Vector3 coreDesiredSize)
 Sets the core desired size of a 3D node.
 
void setDesiredSize (Vector3 desiredSize)
 Sets the desired size of a 3D node.
 
void setLayoutBoundingBoxSize (Vector3 bboxMin, Vector3 bboxMax)
 Sets the size of the bounding box of a 3D node.
 
void setPivotOffset (Vector3 pivotOffset)
 Sets the pivot offset of a 3D node.
 
void setStretchScale (Vector3 stretchScale)
 Sets the stretch scale of a 3D node.
 
- Public Member Functions inherited from Node
ObjectRef< TResourceTypeacquireResource (ResourceID resourceId) throws ObjectNotFoundException
 Acquires a resource from the node or the node's closest ancestor having the resource id in the resource dictionary.
 
ResourceManager.AcquireTask acquireResourcesAsync (ResourceID resourceId, ResourceManager.AcquireTask.Callback callback)
 Posts an asynchronous task to acquire a resource.
 
boolean addAbstractChild (Node child)
 Adds a node as child of this node.
 
MessageSubscriptionToken addMessageFilter (MessageType< MessageArgumentsType > messageType, MessageSubscriptionFunction< MessageArgumentsType > messageHandlerFunction)
 Adds a message filter where the filter is a function.
 
MessageSubscriptionToken addMessageHandler (MessageType< MessageArgumentsType > messageType, MessageSubscriptionFunction< MessageArgumentsType > messageHandlerFunction)
 Adds a message handler where the handler is a function.
 
MessageSubscriptionToken addMessageHandler (MessageType< MessageArgumentsType > messageType, MessageSubscriptionFunction< MessageArgumentsType > messageHandlerFunction, Node messageSourceFilter)
 Adds a message handler where the handler is a function.
 
void addNodeComponentWithOwner (NodeComponent component, KanziObject owner)
 Transfers the ownership of a node component to an object node and sets the owner of the node component.
 
MessageSubscriptionToken addTunnelingMessageFilter (MessageType< MessageArgumentsType > messageType, MessageSubscriptionFunction< MessageArgumentsType > messageHandlerFunction)
 Adds a message filter where the filter is a function.
 
MessageSubscriptionToken addTunnelingMessageHandler (MessageType< MessageArgumentsType > messageType, MessageSubscriptionFunction< MessageArgumentsType > messageHandlerFunction, Node messageSourceFilter)
 Adds a message handler where the handler is a function and you explicitly define the accepted source.
 
void attachRecursive ()
 Attaches an object node and its children recursively.
 
void clearChangeFlag (PropertyTypeChangeFlag flag)
 Clears a change flag.
 
void dispatchMessage (MessageType< MessageArgumentsType > messageType, MessageArgumentsType arguments)
 Dispatches a message from this node with specified arguments.
 
String findResourceUrl (ResourceID resourceId)
 Tries to find Resource URL for Resource ID from this node.
 
Node getAbstractChild (int index)
 Returns node at given child index.
 
int getAbstractChildCount ()
 Returns number of child nodes.
 
int getAbstractChildIndex (Node node)
 Returns index of given node in list of child nodes.
 
float getActualDepth ()
 Gets the value of NodeMetadata::ActualDepthProperty.
 
float getActualHeight ()
 Gets the value of NodeMetadata::ActualHeightProperty.
 
float getActualWidth ()
 Gets the value of NodeMetadata::ActualWidthProperty.
 
float getDepth ()
 Gets the value of NodeMetadata::DepthProperty.
 
Vector2 getDepthMargin ()
 Gets the value of NodeMetadata::DepthMarginProperty.
 
float getHeight ()
 Gets the value of NodeMetadata::HeightProperty.
 
Vector2 getHorizontalMargin ()
 Gets the value of NodeMetadata::HorizontalMarginProperty.
 
String getLocale ()
 Gets the value of NodeMetadata::LocaleProperty.
 
String getName ()
 Gets the value of NodeMetadata::NameProperty.
 
float getOpacity ()
 Gets the value of NodeMetadata::OpacityProperty.
 
Node getParent ()
 Gets parent of this node.
 
String getPath ()
 Gets the value of NodeMetadata::PathProperty.
 
Resource getStateManager ()
 Gets the value of NodeMetadata::StateManagerProperty.
 
Resource getStyle ()
 Gets the value of NodeMetadata::StyleProperty.
 
Vector2 getVerticalMargin ()
 Gets the value of NodeMetadata::VerticalMarginProperty.
 
float getWidth ()
 Gets the value of NodeMetadata::WidthProperty.
 
void invalidateArrange ()
 Invalidates arrange for the node.
 
void invalidateDraw ()
 Invalidates draw flag for the node.
 
void invalidateFinalTransform ()
 Invalidates final transform for node.
 
void invalidateMeasure ()
 Invalidates measure for the node.
 
void invalidateRender ()
 Invalidates render for the node.
 
boolean isAnyChangeFlagSet (EnumSet< PropertyTypeChangeFlag > flags)
 Checks if any of a set of change flags is set.
 
boolean isAnyChildChangeFlagSet (EnumSet< PropertyTypeChangeFlag > flags)
 Checks if any of a set of change flags is set on a child.
 
boolean isChangeFlagSet (PropertyTypeChangeFlag flag)
 Checks if a change flag is set.
 
boolean isChildChangeFlagSet (PropertyTypeChangeFlag flag)
 Checks if a change flag is set on a child.
 
boolean isClipChildren ()
 Gets the value of NodeMetadata::ClipChildrenProperty.
 
boolean isEnabled ()
 Gets the value of NodeMetadata::EnabledProperty.
 
boolean isFocusable ()
 Gets the value of the NodeMetadata::FocusableProperty.
 
boolean isFocused ()
 Sets whether a node is an active focus node and can receive keyboard messages.
 
boolean isHitTestable ()
 Gets the value of NodeMetadata::HitTestableProperty.
 
boolean isHitTestableContainer ()
 Gets the value of NodeMetadata::HitTestableContainerProperty.
 
boolean isHover ()
 Gets the value of NodeMetadata::HoverProperty.
 
boolean isInvalidArrange ()
 Check if the node needs arrange.
 
boolean isInvalidDraw ()
 Tells if node draw flag is invalid.
 
boolean isInvalidFinalTransform ()
 Tells if final transform flag is invalid for node.
 
boolean isInvalidMeasure ()
 Check if the node needs measure.
 
boolean isInvalidRender ()
 Returns if node render flag is invalid.
 
boolean isVisible ()
 Gets the value of NodeMetadata::VisibleProperty.
 
Iterable< NodeComponentiterateNodeComponents ()
 Gets an Iterable object used to iterate the Node Components.
 
lookupNode (String path)
 Returns a node of specified type by looking it up with specified path or alias.
 
NodeComponent lookupNodeComponentByName (String name)
 Look up a Node Component by Name.
 
KanziObject lookupObject (String path)
 Returns a KanziObject by looking it up with specified path or alias.
 
void notifyResourceDictionaryModified ()
 Forces the re-evaluation of resource IDs in a node tree.
 
boolean removeAbstractChild (Node child)
 Removes child node from this node.
 
void removeBinding (AbstractBindingRuntime bindingRuntime)
 Removes a binding runtime added earlier.
 
void removeBindingsWithOwner (KanziObject owner)
 Removes binding runtimes owned by a KanziObject.
 
void removeMessageHandler (MessageSubscriptionToken token)
 Removes a message subscription.
 
void removeNodeComponentWithOwner (KanziObject owner)
 Removes all node component bindings with the specified owner.
 
void setActualDepth (float value)
 Sets the value of NodeMetadata::ActualDepthProperty.
 
void setActualHeight (float value)
 Sets the value of NodeMetadata::ActualHeightProperty.
 
void setActualWidth (float value)
 Sets the value of NodeMetadata::ActualWidthProperty.
 
void setAutoHeight ()
 Sets node to automatically determine height.
 
void setAutoWidth ()
 Sets node to automatically determine width.
 
AbstractBindingRuntime setBinding (AbstractBinding binding)
 Sets a binding.
 
AbstractBindingRuntime setBinding (AbstractBinding binding, PropertyType<?> propertyType)
 Sets a binding.
 
AbstractBindingRuntime setBinding (AbstractBinding binding, PropertyType<?> propertyType, PropertyField propertyField)
 Sets a binding.
 
AbstractBindingRuntime setBindingWithOwner (AbstractBinding binding, KanziObject owner, PropertyType<?> propertyType)
 Sets a binding with owner.
 
AbstractBindingRuntime setBindingWithOwner (AbstractBinding binding, KanziObject owner, PropertyType<?> propertyType, PropertyField propertyField)
 Sets a binding with owner.
 
void setChangeFlag (PropertyTypeChangeFlag flag)
 Sets a change flag.
 
void setClipChildren (boolean value)
 Sets the value of NodeMetadata::ClipChildrenProperty.
 
void setDepth (float value)
 Sets the value of NodeMetadata::DepthProperty.
 
void setDepthMargin (Vector2 value)
 Sets the value of NodeMetadata::DepthMarginProperty.
 
void setEnabled (boolean value)
 Sets the value of the NodeMetadata::EnabledProperty.
 
void setFocusable (boolean value)
 Sets the value of the NodeMetadata::FocusableProperty.
 
void setFocused (boolean value)
 Sets the value of the NodeMetadata::FocusedProperty.
 
void setHeight (float value)
 Sets the value of NodeMetadata::HeightProperty.
 
void setHitTestable (boolean value)
 Sets the value of NodeMetadata::HitTestableProperty.
 
void setHitTestableContainer (boolean value)
 Sets the value of NodeMetadata::HitTestableContainerProperty.
 
void setHorizontalMargin (Vector2 value)
 Sets the value of NodeMetadata::HorizontalMarginProperty.
 
void setHover (boolean value)
 Sets the value of NodeMetadata::HoverProperty.
 
void setLocale (String value)
 Sets the value of NodeMetadata::LocaleProperty.
 
AbstractBindingRuntime setModifierBinding (AbstractBinding binding, PropertyType<?> propertyType)
 Sets a modifier binding.
 
AbstractBindingRuntime setModifierBinding (AbstractBinding binding, PropertyType<?> propertyType, PropertyField propertyField)
 Sets a modifier binding.
 
AbstractBindingRuntime setModifierBindingWithOwner (AbstractBinding binding, KanziObject owner, PropertyType<?> propertyType)
 Sets a modifier binding with owner.
 
AbstractBindingRuntime setModifierBindingWithOwner (AbstractBinding binding, KanziObject owner, PropertyType<?> propertyType, PropertyField propertyField)
 Sets a modifier binding with owner.
 
void setName (String name)
 Sets the value of NodeMetadata::NameProperty.
 
void setOpacity (float value)
 Sets the value of NodeMetadata::OpacityProperty.
 
void setStateManager (Resource value)
 Sets the value of NodeMetadata::StateManagerProperty.
 
void setStyle (Resource value)
 Sets the value of NodeMetadata::StyleProperty.
 
void setVerticalMargin (Vector2 value)
 Sets the value of NodeMetadata::VerticalMarginProperty.
 
void setVisible (boolean value)
 Sets the value of NodeMetadata::VisibleProperty.
 
void setWidth (float value)
 Sets the value of NodeMetadata::WidthProperty.
 
ObjectRef< TResourceTypetryAcquireResource (ResourceID resourceId)
 Acquires a resource from the node or the node's closest ancestor having the resource id in the resource dictionary.
 
void validateArrange ()
 Validates arrange for the node.
 
void validateDraw ()
 Validates draw flags for the node.
 
void validateMeasure ()
 Validates measure for the node.
 
void validateRender ()
 Validates render for the node.
 
- Public Member Functions inherited from NodeProxy
ResourceDictionary acquireResourceDictionary ()
 Gets a resource dictionary of a node.
 
boolean addAbstractChildOverride (Node child)
 
void addAnonymousResource (Resource resource)
 Adds anonymous resource (such as style) for object node resources.
 
void addInputManipulator (InputManipulator inputManipulator)
 Transfers the ownership and attaches an input manipulator to an object node.
 
void addNodeComponent (NodeComponent nodeComponent)
 Transfers the ownership of a node component to an object node.
 
void addResource (ResourceID resourceId, String resourceUrl)
 Adds a resource manager resource to an object node.
 
void addResourceDictionary (ResourceDictionary resourceDictionary)
 Adds a nested resource dictionary to the resource dictionary of a node.
 
void clearChangeFlag (long flag)
 Clears a change flag.
 
boolean containsResource (ResourceID resourceID)
 Returns if object node resource dictionary contains the resource with given ID.
 
void detachRecursive ()
 Detaches a node and its descendants.
 
int getAbstractChildCountOverride ()
 
int getAbstractChildIndexOverride (Node node)
 
Node getAbstractChildOverride (int index)
 
long getChangeFlags ()
 Get current change flags.
 
long getChildChangeFlags ()
 Get current child change flags.
 
ResourceDictionary getResourceDictionary ()
 If a node has a resource dictionary, returns the resource dictionary of that node.
 
boolean isAttached ()
 Gets the attached status.
 
boolean isAttaching ()
 Gets the attaching status.
 
boolean isDetaching ()
 Gets the detaching status.
 
boolean isEffectivelyEnabled ()
 Returns the value of EffectivelyEnabledProperty.
 
boolean isEffectivelyFocusable ()
 Returns whether a node is focusable.
 
boolean isEffectivelyVisible ()
 Returns whether a node and its ancestor nodes are visible.
 
boolean isInitialized ()
 Gets the initialized status.
 
boolean isNamed (String name)
 Checks if the node has the given name.
 
boolean removeAbstractChildOverride (Node child)
 
void removeAnonymousResource (Resource resource)
 Removes anonymous resource from object node resources.
 
void removeInputManipulator (InputManipulator inputManipulator)
 Removes the ownership and detaches an input manipulator from an object node.
 
void removeNodeComponent (NodeComponent nodeComponent)
 Removes the ownership of a node component from an object node.
 
void removeResource (ResourceID resourceId)
 Removes a resource with given ID from object node resource dictionary.
 
void setChangeFlag (long flag)
 Sets a change flag.
 
void setResourceDictionary (ResourceDictionary resourceDictionary)
 Replaces the resource dictionary of a node.
 
Node trySetFocus ()
 Tries to move the focus to this node.
 
Node trySetFocus (FocusFallback fallbackOption)
 Tries to set the focus to the newFocusNode using FocusManager.trySetFocus() but with a fallback behavior in case the node does not gain focus.
 
- Public Member Functions inherited from KanziObject
boolean equals (Object object)
 
Domain getDomain ()
 Returns the domain the object belongs to.
 
Metaclass getDynamicMetaclass ()
 Returns the metaclass of the dynamic type of the object.
 
long getNative ()
 Gets a pointer to the backing C++ instance.
 
TDataType getOptionalProperty (PropertyType< TDataType > propertyType)
 Returns the current value of a property type, but does not use the default value if there are no inputs to the property value.
 
TDataType getProperty (PropertyType< TDataType > propertyType)
 Returns the current value of a property type.
 
int hashCode ()
 
boolean hasValue (PropertyType< TDataType > propertyType)
 Evaluates whether there are any inputs into the property value.
 
boolean isStale ()
 Test if the object is stale i.e.
 
void removeLocalValue (PropertyType< TDataType > propertyType)
 Removes the local value associated with the property.
 
void setFlagKeepDuringPatching (PropertyType< TDataType > propertyType)
 Sets the flag to indicate that the property was loaded from KZB.
 
void setProperty (PropertyType< TDataType > propertyType, TDataType value)
 Sets the local value of a property type.
 
ObjectRef< TTypetryCreateObjectRef (Class< TType > clazz)
 Tries to create an owning ObjectRef instance to this KanziObject.
 
- Protected Member Functions inherited from Node3D
 Node3D (Domain domain, long nativeNode, Metaclass metaclass)
 Wraps a given native node.
 
void arrangeOverride (Vector3 actualSize)
 Performs setting of actual node size and transformation calculations.
 
void initialize ()
 Initializes the Node3D.
 
Vector3 measureOverride (Vector3 availableSize)
 Performs node size calculation.
 
void onAttached ()
 Called when this node becomes attached.
 
void onDetached ()
 Called when this node becomes detached.
 
void onNodePropertyChanged (AbstractPropertyType propertyType, PropertyNotificationReason reason)
 Method executed on node property change.
 
- Static Protected Member Functions inherited from Node3D
static< Derived extends Node3D > ObjectRef< DerivedcreateDerived (Domain domain, String name, Metaclass metaclass)
 Creates a derived class instance.
 

Detailed Description

To render a Text Block 3D node Kanzi: to scale pixels to 3D units.

Member Function Documentation

◆ create()

static ObjectRef< TextBlock3D > create ( Domain domain,
String name )
static

Creates a TextBlock3D node.

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

Member Data Documentation

◆ metaclass

final Metaclass metaclass
static
Initial value:
=
com.rightware.kanzi.metadata.TextBlock3DMetadata.metaclass

The Metaclass for the class.