kanzi::Light Class Reference

Light node is a source of light for a 3D scene. More...

#include <kanzi/core.ui/node/light.hpp>

Inheritance diagram for kanzi::Light:
kanzi::Node3D kanzi::Node kanzi::Object kanzi::MetaObject kanzi::PropertyObject

Public Types

enum  Type {
  TypeDirectional, TypePoint, TypeSpot, TypeCount,
  TypeInvalid
}
 
- 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::MessageSubscriptionTokenMessageSubscriptionTokenVector
 
typedef function< VisitorResult(Node &)> Visitor
 
typedef vector< InputManipulatorSharedPtrInputManipulatorContainer
 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< NodeComponentEntryNodeComponentContainer
 Gets the node component iterator. More...
 
typedef NodeComponentContainer::iterator NodeComponentIterator
 
typedef NodeComponentContainer::const_iterator NodeComponentConstIterator
 
- Public Types inherited from kanzi::PropertyObject
typedef intrusive_ptr< AbstractPropertyTypeDescriptor::PropertyStoragePropertyStoragePtr
 
typedef vector< PropertyStoragePtrPropertyStorageContainer
 
typedef PropertyStorageContainer::iterator PropertyStorageIterator
 
typedef PropertyStorageContainer::const_iterator PropertyStorageConstIterator
 
typedef PropertyStorageContainer::reverse_iterator PropertyStorageReverseIterator
 

Public Member Functions

void setLightType (Type type)
 
Light::Type getLightType () const
 Gets the type of the light node. More...
 
Matrix4x4 getWorldTransform () const
 
void setWorldTransform (const Matrix4x4 &worldTransformation)
 
- Public Member Functions inherited from kanzi::Node3D
Matrix4x4 getFinalTransformation () const
 Gets the value of FinalTransformationProperty. More...
 
void setFinalTransformation (Matrix4x4 value)
 Sets the value of FinalTransformationProperty. More...
 
float getFrustumCullMargin () const
 Gets the value of FrustumCullMarginProperty. More...
 
void setFrustumCullMargin (float value)
 Sets the value of FrustumCullMarginProperty. More...
 
SRTValue3D getRenderTransformation () const
 Gets the value of RenderTransformationProperty. More...
 
void setRenderTransformation (SRTValue3D value)
 Sets the value of RenderTransformationProperty. More...
 
SRTValue3D getLayoutTransformation () const
 Gets the value of LayoutTransformationProperty. More...
 
void setLayoutTransformation (SRTValue3D value)
 Sets the value of LayoutTransformationProperty. 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 ()
 Sets node to automatically determine width. More...
 
void setAutoHeight ()
 Sets node to automatically determine height. More...
 
void setAutoDepth ()
 Sets node to automatically determine depth. More...
 
void setAutoSize ()
 Sets node to automatically determine width, height and depth. More...
 
void setSize (float width, float height, float depth)
 Sets size properties of the node. More...
 
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 setArrangeTransformation (const Matrix4x4 &value)
 Sets the layout transformation of the object. More...
 
Matrix4x4 getArrangeTransformation () const
 Gets the layout transformation of the object. 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, const Matrix4x4 &worldTransformation)
 Node-specific render function. More...
 
Node3DSharedPtr getLookAtTarget () const
 
Node3DSharedPtr getPositionConstraintTarget () const
 
Node3DSharedPtr getOrientationConstraintTarget () const
 
Node3DSharedPtr getFaceToCameraTarget () const
 
virtual void onNodePropertyChanged (AbstractPropertyType propertyType, PropertyNotificationReason 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 >::Traits::ReturnType getProperty (const PropertyType< DataType > &propertyType) const
 Returns the current value of a property. More...
 
AbstractPropertyTypeDescriptor::ValueSourcegetNodeFinalValueSource (AbstractPropertyTypeDescriptor &descriptor) const
 
template<typename DataType >
optional< typename PropertyType< DataType >::Traits::ReturnType > getOptionalProperty (const PropertyType< DataType > &propertyType) 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 >
optional< typename PropertyType< DataType >::DataType > getOptionalAbstractProperty (AbstractPropertyType abstractPropertyType) 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...
 
template<typename TMessageType >
MessageSubscriptionToken addMessageHandler (const TMessageType &messageType, typename TMessageType::FunctionType function, Node *messageSourceFilter)
 Adds a message handler where handler is function and accepted source is explicitly defined. 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
 Tries to find Resource URL for Resource ID from this node. More...
 
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...
 
ResourceManager::AcquireTaskSharedPtr acquireResourceAsync (const ResourceID &key, ResourceManager::AsyncAcquireFinishedCallback func) const
 Posts an asynchronous task to acquire a resource. 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
 Gets the resource dictionary of the node, if the node has one. More...
 
ResourceDictionarySharedPtr acquireResourceDictionary ()
 Gets the resource dictionary of the node. More...
 
void setResourceDictionary (ResourceDictionarySharedPtr resourceDictionary)
 Replaces the resource dictionary of the node. More...
 
void addResourceDictionary (ResourceDictionarySharedPtr resourceDictionary)
 Add a nested resource dictionary to the resource dictionary of the node. More...
 
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...
 
tuple< NodeSharedPtr, AbstractPropertyTypelookupObjectForStateManager (string_view relativePath)
 Lookup for an node and possible object from within the node for state manager. More...
 
template<typename Type >
shared_ptr< Type > lookupObject (string_view path)
 Lookup for an object 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 addNodeComponent (NodeComponentSharedPtr nodeComponent)
 Transfers the ownership of a node component to an object node. More...
 
void addNodeComponentWithOwner (NodeComponentSharedPtr nodeComponent, const void *owner)
 Transfers the ownership of a node component to an object node and sets the owner of the node component. More...
 
void removeNodeComponent (NodeComponent &nodeComponent)
 Removes the ownership of a node component from an object node. More...
 
void removeNodeComponentWithOwner (const void *owner)
 Removes all bindings with the specified owner. More...
 
NodeComponentConstIterator beginNodeComponents () const
 
NodeComponentConstIterator endNodeComponents () const
 
template<typename Type >
shared_ptr< Type > lookupNodeComponent (string_view name)
 Returns a node component of specified type by looking it up with specified name. More...
 
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...
 
bool isAnyChangeFlagSet (uint32_t flag) const
 Checks if any of given flags 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 isInvalidDraw ()
 Tells if node draw flag is invalid. More...
 
void invalidateDraw ()
 Invalidates draw flag for the node. More...
 
void validateDraw ()
 Validates draw flags for the node. More...
 
void validateDrawForChildrenRecursive ()
 Recursively validates draw for the children from this 2D node onwards. More...
 
bool isInitialized () const
 Returns true if initialize() has been called, false otherwise. 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...
 
virtual const KzuBoundingVolumegetBoundingVolume () const
 Gets bounding volume from object node. More...
 
AppliedStyleEntryapplyStyle (StyleSharedPtr style)
 Applies a style to an object node. More...
 
AppliedStyleEntryapplyManualStyle (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, node comopnents, resources etc. 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)
 
void setTemplateRoot (NodeSharedPtr templateRoot)
 Sets the template root of this node. More...
 
NodeSharedPtr getTemplateRoot () const
 Gets the template root of this node. More...
 
string getName () const
 Gets the value of NameProperty. More...
 
void setName (string_view 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...
 
ResourceSharedPtr getFont () const
 Gets the value of FontProperty. More...
 
void setFont (ResourceSharedPtr 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...
 
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...
 
ResourceSharedPtr getStyle () const
 Gets the value of StyleProperty. More...
 
void setStyle (ResourceSharedPtr value)
 Sets the value of StyleProperty. More...
 
ResourceSharedPtr getStateManager () const
 Gets the value of StateManagerProperty. More...
 
void setStateManager (ResourceSharedPtr 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...
 
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 KZ_OVERRIDE
 Returns the metaclass of the dynamic type of the 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...
 
- Public Member Functions inherited from kanzi::MetaObject
virtual ~MetaObject ()
 
bool isTypeOf (const Metaclass *objectType) const
 Determines if the type of this object is the given type or derived from it. More...
 
- Public Member Functions inherited from kanzi::PropertyObject
 PropertyObject ()
 
virtual ~PropertyObject ()
 
template<typename DataType >
void setProperty (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Traits::ParameterType value)
 Sets the local value of a property. More...
 
void removeKzbProperties ()
 
template<typename DataType >
PropertyType< DataType >::Traits::ReturnType getProperty (const PropertyType< DataType > &propertyType) const
 Returns the current value of a property. More...
 
template<typename DataType >
optional< typename PropertyType< DataType >::Traits::ReturnType > getOptionalProperty (const PropertyType< DataType > &propertyType) 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 >
PropertyType< DataType >::Traits::ReturnType getPropertyBase (const PropertyType< DataType > &propertyType) const
 Returns the current value of a property disregarding modifiers. More...
 
template<typename DataType >
void setAbstractProperty (AbstractPropertyType abstractPropertyType, typename PropertyType< DataType >::Traits::ParameterType value)
 
template<typename DataType >
PropertyType< DataType >::Traits::ReturnType getAbstractProperty (AbstractPropertyType abstractPropertyType) const
 
template<typename DataType >
PropertyType< DataType >::Traits::ReturnType getAbstractPropertyBase (AbstractPropertyType abstractPropertyType) const
 
template<typename DataType >
optional< typename PropertyType< DataType >::Traits::ReturnType > getOptionalAbstractProperty (AbstractPropertyType abstractPropertyType) const
 
void setPropertyFlag (AbstractPropertyType propertyType, uint32_t flag)
 
bool isPropertyFlagSet (AbstractPropertyType propertyType, uint32_t flag) const
 
void clearPropertyFlag (AbstractPropertyType propertyType, uint32_t flag)
 
bool hasValue (AbstractPropertyType propertyType) const
 Evaluates whether there are any inputs into the property value. More...
 
bool hasBaseValue (AbstractPropertyType propertyType) const
 Evaluates whether there are any inputs into the property value, disregarding modifiers. More...
 
bool hasLocalValue (AbstractPropertyType propertyType) const
 Evaluates whether there is a local value set for the property. More...
 
bool hasNonClassValue (AbstractPropertyType propertyType) const
 Evaluates whether there is a value of any precedence higher than class default value set for the property. More...
 
void removeLocalValue (AbstractPropertyType propertyType)
 Removes the local value associated with the property. More...
 
void copyLocalValue (const PropertyObject &other, AbstractPropertyType propertyType)
 Copies local value of single property from another object. More...
 
void copyLocalValues (const PropertyObject &other)
 Copies all local values from another object. More...
 
template<typename DataType >
void addPropertyValueSource (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::TypedValueSource *valueSource, PropertyValuePrecedence precedence, void *owner)
 
template<typename DataType >
void removePropertyValueSource (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::TypedValueSource *valueSource, void *owner)
 
template<typename DataType >
void addPropertyModifier (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::ModifierCallback callback, void *owner)
 
template<typename DataType >
void removePropertyModifier (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::ModifierCallback callback, void *owner)
 
void validatePropertyModifiers (AbstractPropertyType propertyType)
 
template<typename DataType >
void addPropertyNotificationHandler (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::NotificationCallback callback, void *owner)
 
template<typename DataType >
void removePropertyNotificationHandler (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::NotificationCallback callback, void *owner)
 
template<typename DataType >
size_t getPropertyNotificationHandlerCount (const PropertyType< DataType > &propertyType)
 Gets number of current notification handlers for given property type. More...
 

Static Public Member Functions

static LightSharedPtr create (Domain *domain, string_view name)
 Creates a light node. More...
 
static LightSharedPtr createDirectional (Domain *domain, string_view name)
 Creates a directional light. More...
 
static LightSharedPtr createPoint (Domain *domain, string_view name)
 Creates a point light. More...
 
static LightSharedPtr createSpot (Domain *domain, string_view name)
 Creates a spot light. More...
 
- Static Public Member Functions inherited from kanzi::Node3D
static float layoutUp ()
 
static bool isValidLayoutSize (Vector3 size)
 Indicates whether a size is valid layout size. More...
 
static Vector3 unboundedLayoutSize ()
 Returns an unbounded layout size. More...
 
static bool isUnboundedLayoutSize (Vector3 layoutSize)
 Indicates whether a layout size is an unbound layout size. More...
 
static Vector3 replaceUnboundedLayoutSize (Vector3 layoutSize, Vector3 resetSize)
 Replaces any element of a layout size with appropriate element of the reset size if it is unbounded and returns the size. More...
 
static Vector3 replaceUnboundedLayoutSizeWithZero (Vector3 layoutSize)
 Replaces any element of a layout size with zero if it is unbounded and returns the size. More...
 
static PropertyTypeEditorInfoSharedPtr makeEditorInfo ()
 
- Static Public Member Functions inherited from kanzi::Node
static bool isValidLayoutValue (float value)
 Indicates whether a value is valid layout value. More...
 
static float unboundedLayoutValue ()
 Returns an unbounded layout value. More...
 
static bool isUnboundedLayoutValue (float layoutValue)
 Indicates whether a value is an unbound layout value. More...
 
static float replaceUnboundedLayoutValue (float layoutValue, float resetValue)
 Replaces layout value with the specified value if it is unbounded and returns it. More...
 
static float replaceUnboundedLayoutValueWithZero (float layoutValue)
 Replaces layout value with zero if it is unbounded layout value and returns it. More...
 
- 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::MetaObject
static const MetaclassgetStaticMetaclass ()
 Returns the metaclass of Object class. More...
 
static PropertyTypeEditorInfoSharedPtr makeEditorInfo ()
 Default implementation that returns empty editor info. More...
 

Protected Member Functions

virtual void onAttached () KZ_OVERRIDE
 Called when an object node becomes attached. More...
 
 Light (Domain *domain, string_view name)
 Constructor. More...
 
- Protected Member Functions inherited from kanzi::Node3D
 Node3D (Domain *domain, string_view name)
 
void initialize ()
 
virtual NodeSharedPtr findAbstractChildOverride (string_view name) KZ_OVERRIDE
 
virtual VisitorResult visitAbstractChildOverride (const Visitor &visitor, VisitorOrder order) KZ_OVERRIDE
 
virtual Vector3 measureOverride (Vector3 availableSize)
 
virtual void arrangeOverride (Vector3 actualSize)
 
void setPrimitiveLayout (bool primitive)
 
- Protected Member Functions inherited from kanzi::Node
 Node (Domain *domain, string_view name)
 Constructor. More...
 
void initialize ()
 
virtual void onDetached ()
 Called when an object node becomes detached. More...
 
void updatePropertiesForConnectedNode ()
 Invokes property notifications for inherited properties during scene graph tree connections. More...
 
void updatePropertiesForDisconnectedNode (Node *oldParent)
 Invokes property notifications for inherited properties during scene graph tree disconnections. 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...
 
virtual void notifyPropertyHandlers (PropertyStoragePtr &propertyStorage, PropertyNotificationReason reason) KZ_OVERRIDE
 
- Protected Member Functions inherited from kanzi::Object
void initialize ()
 
void onCopy (const Object &other)
 
- Protected Member Functions inherited from kanzi::MetaObject
 MetaObject ()
 
void initialize ()
 
- Protected Member Functions inherited from kanzi::PropertyObject
void addPropertyValueSource (AbstractPropertyTypeDescriptor &descriptor, AbstractPropertyTypeDescriptor::ValueSource *valueSource, PropertyValuePrecedence precedence, void *owner)
 
void removePropertyValueSource (AbstractPropertyTypeDescriptor &descriptor, AbstractPropertyTypeDescriptor::ValueSource *valueSource, void *owner)
 
AbstractPropertyTypeDescriptor::ValueSourceEntrygetTopValueSourceEntry (AbstractPropertyTypeDescriptor::PropertyStorage &propertyStorage) const
 
AbstractPropertyTypeDescriptor::ValueSourceEntrygetTopValueSourceEntry (AbstractPropertyTypeDescriptor &descriptor) const
 
AbstractPropertyTypeDescriptor::ValueSourcegetTopValueSource (AbstractPropertyTypeDescriptor &descriptor) const
 
AbstractPropertyTypeDescriptor::ValueSourcegetFinalValueSource (AbstractPropertyTypeDescriptor &descriptor) const
 
AbstractPropertyTypeDescriptor::ValueSourcegetNonClassValueSource (AbstractPropertyTypeDescriptor &descriptor) const
 
AbstractPropertyTypeDescriptor::ValueSourcegetClassValueSource (AbstractPropertyTypeDescriptor &descriptor) const
 
AbstractPropertyTypeDescriptor::ValueSourceEntryfindLocalValueSourceEntry (AbstractPropertyTypeDescriptor::PropertyStorage &propertyStorage)
 
AbstractPropertyTypeDescriptor::ValueSourceEntryconstructLocalValueSourceEntry (AbstractPropertyTypeDescriptor &descriptor, AbstractPropertyTypeDescriptor::PropertyStorage &propertyStorage)
 
AbstractPropertyTypeDescriptor::ValueSourceEntryacquireLocalValueSourceEntry (AbstractPropertyTypeDescriptor &descriptor)
 
AbstractPropertyTypeDescriptor::PropertyStoragefindPropertyStorage (AbstractPropertyTypeDescriptor &descriptor) const
 
PropertyStoragePtr findPropertyStoragePtr (AbstractPropertyTypeDescriptor &descriptor) const
 Gets property storage intrusive pointer that can be used to hold a reference until end of operation. More...
 
PropertyStoragePtr constructPropertyStorage (AbstractPropertyTypeDescriptor &descriptor)
 
PropertyStoragePtr acquirePropertyStorage (AbstractPropertyTypeDescriptor &descriptor)
 
AbstractPropertyTypeDescriptor::ModifierStorageacquireModifierStorage (AbstractPropertyTypeDescriptor &descriptor)
 
AbstractPropertyTypeDescriptor::ModifierStoragefindModifierStorage (AbstractPropertyTypeDescriptor &descriptor)
 
AbstractPropertyTypeDescriptor::NotificationStorageacquireNotificationStorage (AbstractPropertyTypeDescriptor &descriptor)
 
AbstractPropertyTypeDescriptor::NotificationStoragefindNotificationStorage (AbstractPropertyTypeDescriptor &descriptor)
 
AbstractPropertyTypeDescriptorfindPropertyTypeDescriptorByUnqualifiedNameAndDataType (string_view unqualifiedName, PropertyDataType dataType)
 
void validatePropertyModifiersAndNotifyHandlers (PropertyStoragePtr &propertyStorage)
 
void copyLocalValue (const AbstractPropertyTypeDescriptor::PropertyStorage &propertyStorage)
 Copy local value from property storage. More...
 
PropertyStorageContainer::iterator beginPropertyStorage ()
 
PropertyStorageContainer::iterator endPropertyStorage ()
 
void onCopy (const PropertyObject &other)
 

Properties

static PropertyType< string > TypeNameProperty
 TypeName property. More...
 
static PropertyType< bool > EnabledProperty
 Enabled property. More...
 
static PropertyType< float > ColorScaleProperty
 ColorScale property. More...
 
static PropertyType< ColorRGBADirectionalLightColorProperty
 DirectionalLightColor property. More...
 
static PropertyType< Vector3DirectionalLightDirectionProperty
 DirectionalLightDirection property. More...
 
static PropertyType< ColorRGBAPointLightColorProperty
 PointLightColor property. More...
 
static PropertyType< Vector3PointLightAttenuationProperty
 PointLightAttenuation property. More...
 
static PropertyType< Vector3PointLightPositionProperty
 PointLightPosition property. More...
 
static PropertyType< float > PointLightRadiusProperty
 PointLightRadius property. More...
 
static PropertyType< ColorRGBASpotLightColorProperty
 SpotLightColor property. More...
 
static PropertyType< Vector3SpotLightAttenuationProperty
 SpotLightAttenuation property. More...
 
static PropertyType< float > SpotLightCutoffAngleProperty
 SpotLightCutoffAngle property. More...
 
static PropertyType< float > SpotLightInnerAngleProperty
 SpotLightInnerAngle property. More...
 
static PropertyType< Vector3SpotLightDirectionProperty
 SpotLightDirection property. More...
 
static PropertyType< float > SpotLightExponentProperty
 SpotLightExponent property. More...
 
static PropertyType< Vector3SpotLightPositionProperty
 SpotLightPosition property. More...
 
string getTypeName () const
 Gets the value of TypeNameProperty. More...
 
void setTypeName (string value)
 Sets the value of TypeNameProperty. More...
 
bool isEnabled () const
 Gets the value of EnabledProperty. More...
 
void setEnabled (bool value)
 Sets the value of EnabledProperty. More...
 
float getColorScale () const
 Gets the value of ColorScaleProperty. More...
 
void setColorScale (float value)
 Sets the value of ColorScaleProperty. More...
 
ColorRGBA getDirectionalLightColor () const
 Gets the value of DirectionalLightColorProperty. More...
 
void setDirectionalLightColor (ColorRGBA value)
 Sets the value of DirectionalLightColorProperty. More...
 
Vector3 getDirectionalLightDirection () const
 Gets the value of DirectionalLightDirectionProperty. More...
 
ColorRGBA getPointLightColor () const
 Gets the value of PointLightColorProperty. More...
 
void setPointLightColor (ColorRGBA value)
 Sets the value of PointLightColorProperty. More...
 
Vector3 getPointLightAttenuation () const
 Gets the value of PointLightAttenuationProperty. More...
 
void setPointLightAttenuation (Vector3 value)
 Sets the value of PointLightAttenuationProperty. More...
 
Vector3 getPointLightPosition () const
 Gets the value of PointLightPositionProperty. More...
 
float getPointLightRadius () const
 Gets the value of PointLightRadiusProperty. More...
 
void setPointLightRadius (float value)
 Sets the value of PointLightRadiusProperty. More...
 
ColorRGBA getSpotLightColor () const
 Gets the value of SpotLightColorProperty. More...
 
void setSpotLightColor (ColorRGBA value)
 Sets the value of SpotLightColorProperty. More...
 
Vector3 getSpotLightAttenuation () const
 Gets the value of SpotLightAttenuationProperty. More...
 
void setSpotLightAttenuation (Vector3 value)
 Sets the value of SpotLightAttenuationProperty. More...
 
float getSpotLightCutoffAngle () const
 Gets the value of SpotLightCutoffAngleProperty. More...
 
void setSpotLightCutoffAngle (float value)
 Sets the value of SpotLightCutoffAngleProperty. More...
 
float getSpotLightInnerAngle () const
 Gets the value of SpotLightInnerAngleProperty. More...
 
void setSpotLightInnerAngle (float value)
 Sets the value of SpotLightInnerAngleProperty. More...
 
Vector3 getSpotLightDirection () const
 Gets the value of SpotLightDirectionProperty. More...
 
float getSpotLightExponent () const
 Gets the value of SpotLightExponentProperty. More...
 
void setSpotLightExponent (float value)
 Sets the value of SpotLightExponentProperty. More...
 
Vector3 getSpotLightPosition () const
 Gets the value of SpotLightPositionProperty. More...
 

Additional Inherited Members

- Static Public Attributes inherited from kanzi::Node3D
static PropertyType< Matrix4x4FinalTransformationProperty
 FinalTransformation property. More...
 
static PropertyType< float > FrustumCullMarginProperty
 FrustumCullMargin property. More...
 
static PropertyType< SRTValue3DRenderTransformationProperty
 RenderTransformation property. More...
 
static PropertyType< SRTValue3DLayoutTransformationProperty
 LayoutTransformation 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::HorizontalAlignmentHorizontalAlignmentProperty
 HorizontalAlignment property. More...
 
static PropertyType< Node::VerticalAlignmentVerticalAlignmentProperty
 VerticalAlignment property. More...
 
static PropertyType< Node::DepthAlignmentDepthAlignmentProperty
 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< ResourceSharedPtrFontProperty
 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< bool > EnableClickProperty
 EnableClick property. More...
 
static PropertyType< bool > EnableMultiClickProperty
 EnableMultiClick property. More...
 
static PropertyType< Node::ContentStretchContentStretchProperty
 ContentStretch property. More...
 
static PropertyType< float > OpacityProperty
 Opacity property. More...
 
static PropertyType< ResourceSharedPtrStyleProperty
 Style property. More...
 
static PropertyType< ResourceSharedPtrStateManagerProperty
 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...
 
- 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 VisitorResult validateDrawVisitor (Node &node)
 Visitor for validating draw. More...
 
static bool processPropertyChanged (Node &node, AbstractPropertyType propertyType, const PropertyStoragePtr &nodePropertyStorage, AbstractPropertyTypeDescriptor::PropertyStorage *changedPropertyStorage, PropertyNotificationReason reason)
 Processes notification handlers for node and property storage. More...
 
static VisitorResult propertyChangedVisitor (Node &node, AbstractPropertyType propertyType, AbstractPropertyTypeDescriptor::PropertyStorage *propertyStorage, PropertyNotificationReason reason)
 
- Protected Attributes inherited from kanzi::Object
AppliedStyleContainer m_appliedStyles
 Listing of applied styles applied to this object. More...
 

Detailed Description

Light node is a source of light for a 3D scene.

Light nodes contain properties that are passed as uniforms to shaders when 3D nodes are rendered. Note that lights affect only the rendering of nodes which use materials with shaders that use those lights.

Examples

To create and set a directional light:

// Create a directional light named Directional light.
LightSharedPtr directionalLight = Light::createDirectional(domain, "Directional light");
// Rotate the directional light node by -45 degrees around the x axis.
SRTValue3D layoutTransformation = directionalLight->getLayoutTransformation();
layoutTransformation.setRotation(Vector3(kzsDegreesToRadians(-45.0f), 0.0f, 0.0f));
directionalLight->setLayoutTransformation(layoutTransformation);
// Set the color of the directional light to red.
directionalLight->setDirectionalLightColor(ThemeRed);

To create and set a point light:

// Create a point light named Point light.
LightSharedPtr pointLight = Light::createPoint(domain, "Point light");
// Move the point light on y axis by 4 units.
SRTValue3D layoutTransformation = pointLight->getLayoutTransformation();
layoutTransformation.setTranslation(Vector3(0.0f, 4.0f, 0.0f));
pointLight->setLayoutTransformation(layoutTransformation);
// Set the color of the point light to green.
pointLight->setPointLightColor(ThemeGreen);
// Set the constant attenuation for the point light to 0.8, and linear and quadratic attenuation to 0.
pointLight->setPointLightAttenuation(Vector3(0.8f, 0.0f, 0.0f));

To create and set a spot light:

// Create a spot light named Spot light.
LightSharedPtr spotLight = Light::createSpot(domain, "Spot light");
// Move the spot light on x axis by 4 units and rotate it around the y axis by 90 degrees.
SRTValue3D layoutTransformation = spotLight->getLayoutTransformation();
layoutTransformation.setTranslation(Vector3(4.0f, 0.0f, 0.0f));
layoutTransformation.setRotation(Vector3(0.0f, kzsDegreesToRadians(90.0f), 0.0f));
spotLight->setLayoutTransformation(layoutTransformation);
// Set the color of the spot light to blue.
spotLight->setSpotLightColor(ThemeBlue);
// Set the angle of the spot light cone to 45 degrees.
spotLight->setSpotLightCutoffAngle(45.0f);
// Set how concentrated the spot light is.
spotLight->setSpotLightExponent(30.0f);
// Set the constant attenuation for the spot light to 1.3, and linear and quadratic attenuation to 0.
spotLight->setSpotLightAttenuation(Vector3(1.3f, 0.0f, 0.0f));

Member Enumeration Documentation

Enumerator
TypeDirectional 
TypePoint 
TypeSpot 
TypeCount 
TypeInvalid 

Constructor & Destructor Documentation

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

Constructor.

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

Member Function Documentation

string kanzi::Light::getTypeName ( ) const
inline

Gets the value of TypeNameProperty.

See also
setTypeName()
void kanzi::Light::setTypeName ( string  value)
inline

Sets the value of TypeNameProperty.

See also
getTypeName()
bool kanzi::Light::isEnabled ( ) const
inline

Gets the value of EnabledProperty.

See also
setEnabled()
void kanzi::Light::setEnabled ( bool  value)
inline

Sets the value of EnabledProperty.

See also
isEnabled()
float kanzi::Light::getColorScale ( ) const
inline

Gets the value of ColorScaleProperty.

See also
setColorScale()
void kanzi::Light::setColorScale ( float  value)
inline

Sets the value of ColorScaleProperty.

See also
getColorScale()
ColorRGBA kanzi::Light::getDirectionalLightColor ( ) const
inline
void kanzi::Light::setDirectionalLightColor ( ColorRGBA  value)
inline
Vector3 kanzi::Light::getDirectionalLightDirection ( ) const
inline

Gets the value of DirectionalLightDirectionProperty.

See also
setDirectionalLightDirection()
ColorRGBA kanzi::Light::getPointLightColor ( ) const
inline

Gets the value of PointLightColorProperty.

See also
setPointLightColor()
void kanzi::Light::setPointLightColor ( ColorRGBA  value)
inline

Sets the value of PointLightColorProperty.

See also
getPointLightColor()
Vector3 kanzi::Light::getPointLightAttenuation ( ) const
inline
void kanzi::Light::setPointLightAttenuation ( Vector3  value)
inline
Vector3 kanzi::Light::getPointLightPosition ( ) const
inline

Gets the value of PointLightPositionProperty.

See also
setPointLightPosition()
float kanzi::Light::getPointLightRadius ( ) const
inline

Gets the value of PointLightRadiusProperty.

See also
setPointLightRadius()
void kanzi::Light::setPointLightRadius ( float  value)
inline

Sets the value of PointLightRadiusProperty.

See also
getPointLightRadius()
ColorRGBA kanzi::Light::getSpotLightColor ( ) const
inline

Gets the value of SpotLightColorProperty.

See also
setSpotLightColor()
void kanzi::Light::setSpotLightColor ( ColorRGBA  value)
inline

Sets the value of SpotLightColorProperty.

See also
getSpotLightColor()
Vector3 kanzi::Light::getSpotLightAttenuation ( ) const
inline
void kanzi::Light::setSpotLightAttenuation ( Vector3  value)
inline
float kanzi::Light::getSpotLightCutoffAngle ( ) const
inline
void kanzi::Light::setSpotLightCutoffAngle ( float  value)
inline
float kanzi::Light::getSpotLightInnerAngle ( ) const
inline
void kanzi::Light::setSpotLightInnerAngle ( float  value)
inline
Vector3 kanzi::Light::getSpotLightDirection ( ) const
inline

Gets the value of SpotLightDirectionProperty.

See also
setSpotLightDirection()
float kanzi::Light::getSpotLightExponent ( ) const
inline
void kanzi::Light::setSpotLightExponent ( float  value)
inline
Vector3 kanzi::Light::getSpotLightPosition ( ) const
inline

Gets the value of SpotLightPositionProperty.

See also
setSpotLightPosition()
static LightSharedPtr kanzi::Light::create ( Domain domain,
string_view  name 
)
static

Creates a light node.

Parameters
domainThe UI domain the new light node belongs to.
nameThe name of the node.
Returns
The created node.
static LightSharedPtr kanzi::Light::createDirectional ( Domain domain,
string_view  name 
)
static

Creates a directional light.

Parameters
domainThe UI domain the new directional light node belongs to.
nameThe name of the node.
Returns
The created node.
static LightSharedPtr kanzi::Light::createPoint ( Domain domain,
string_view  name 
)
static

Creates a point light.

Parameters
domainThe UI domain the new point light node belongs to.
nameThe name of the node.
Returns
The created node.
static LightSharedPtr kanzi::Light::createSpot ( Domain domain,
string_view  name 
)
static

Creates a spot light.

Parameters
domainThe UI domain the new spot light node belongs to.
nameThe name of the node.
Returns
The created node.
void kanzi::Light::setLightType ( Type  type)
Light::Type kanzi::Light::getLightType ( ) const

Gets the type of the light node.

Matrix4x4 kanzi::Light::getWorldTransform ( ) const
void kanzi::Light::setWorldTransform ( const Matrix4x4 worldTransformation)
virtual void kanzi::Light::onAttached ( )
protectedvirtual

Called when an object node becomes attached.

Reimplemented from kanzi::Node.

Member Data Documentation

PropertyType<string> kanzi::Light::TypeNameProperty
static

TypeName property.

The default value is "DirectionalLight".

See also
setTypeName(), getTypeName()
PropertyType<bool> kanzi::Light::EnabledProperty
static

Enabled property.

Whether the light is switched on or off. The light affects rendering only when the value is set to true. The default value is true.

See also
setEnabled(), isEnabled()
PropertyType<float> kanzi::Light::ColorScaleProperty
static

ColorScale property.

Scales light color. The default value is 1.0f.

See also
setColorScale(), getColorScale()
PropertyType<ColorRGBA> kanzi::Light::DirectionalLightColorProperty
static

DirectionalLightColor property.

Defines the color of a directional light. The default value is ColorRGBA(0.4980392f, 0.4980392f, 0.4980392f, 1.0f).

See also
setDirectionalLightColor(), getDirectionalLightColor()
PropertyType<Vector3> kanzi::Light::DirectionalLightDirectionProperty
static

DirectionalLightDirection property.

Contains the direction vector of a directional light. Calculated automatically from a directional light's world transformation. The default value is Vector3(0.0f, 0.0f, 0.0f).

See also
setDirectionalLightDirection(), getDirectionalLightDirection()
PropertyType<ColorRGBA> kanzi::Light::PointLightColorProperty
static

PointLightColor property.

Defines the color of a point light. The default value is ColorRGBA(0.4980392f, 0.4980392f, 0.4980392f, 1.0f).

See also
setPointLightColor(), getPointLightColor()
PropertyType<Vector3> kanzi::Light::PointLightAttenuationProperty
static

PointLightAttenuation property.

Defines the effect of a point light on objects that are farther away. Define the attenuation value of a point light by setting constant, linear, and quadratic coefficients. The default value is Vector3(1.0f, 0.0f, 0.0f).

See also
setPointLightAttenuation(), getPointLightAttenuation()
PropertyType<Vector3> kanzi::Light::PointLightPositionProperty
static

PointLightPosition property.

Contains the position vector of a point light. Calculated automatically from a point light's world transformation. The default value is Vector3(0.0f, 0.0f, 0.0f).

See also
setPointLightPosition(), getPointLightPosition()
PropertyType<float> kanzi::Light::PointLightRadiusProperty
static

PointLightRadius property.

Sphere light radius. The default value is 0.0f.

See also
setPointLightRadius(), getPointLightRadius()
PropertyType<ColorRGBA> kanzi::Light::SpotLightColorProperty
static

SpotLightColor property.

Defines the color of a spot light. The default value is ColorRGBA(0.4980392f, 0.4980392f, 0.4980392f, 1.0f).

See also
setSpotLightColor(), getSpotLightColor()
PropertyType<Vector3> kanzi::Light::SpotLightAttenuationProperty
static

SpotLightAttenuation property.

Defines the effect of a spot light on objects that are farther away. Define the attenuation value of a spot light by setting constant, linear, and quadratic coefficients. The default value is Vector3(1.0f, 0.0f, 0.0f).

See also
setSpotLightAttenuation(), getSpotLightAttenuation()
PropertyType<float> kanzi::Light::SpotLightCutoffAngleProperty
static

SpotLightCutoffAngle property.

Defines the angle of the light cone in degrees. The default value is 90.0f.

See also
setSpotLightCutoffAngle(), getSpotLightCutoffAngle()
PropertyType<float> kanzi::Light::SpotLightInnerAngleProperty
static

SpotLightInnerAngle property.

Defines the inner angle of the light cone in degrees. The default value is 80.0f.

See also
setSpotLightInnerAngle(), getSpotLightInnerAngle()
PropertyType<Vector3> kanzi::Light::SpotLightDirectionProperty
static

SpotLightDirection property.

Contains the direction vector of a spot light. Calculated automatically from a spot light's world transformation. The default value is Vector3(0.0f, 0.0f, 0.0f).

See also
setSpotLightDirection(), getSpotLightDirection()
PropertyType<float> kanzi::Light::SpotLightExponentProperty
static

SpotLightExponent property.

Defines how fast a fully lit area at the center of the light cone turns into an unlit area. The default value is 1.0f.

See also
setSpotLightExponent(), getSpotLightExponent()
PropertyType<Vector3> kanzi::Light::SpotLightPositionProperty
static

SpotLightPosition property.

Contains the position vector of a spot light. Calculated automatically from a spot light's world transformation. The default value is Vector3(0.0f, 0.0f, 0.0f).

See also
setSpotLightPosition(), getSpotLightPosition()

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