Kanzi  3.9.7
Java API
LightMetadata Interface Reference

Metadata definitions for Light. More...

Inheritance diagram for LightMetadata:
[legend]

Public Attributes

DynamicPropertyType< ColorRGBADirectionalLightColorProperty
 Sets the color of the Directional Light. More...
 
DynamicPropertyType< Vector3DirectionalLightDirectionProperty
 A hidden property that identifies directional light direction and contains related metadata. More...
 
DynamicPropertyType< String > LightPropertyTypeProperty
 The property type name of the light. More...
 
AbstractMetaclass metaclass = new AbstractMetaclass("Kanzi.Light")
 Metaclass for Light.
 
DynamicPropertyType< Vector3PointLightAttenuationProperty
 Sets the effect that this Point Light has on nodes that are farther away. More...
 
DynamicPropertyType< ColorRGBAPointLightColorProperty
 Sets the color of the Point Light. More...
 
DynamicPropertyType< Vector3PointLightPositionProperty
 A hidden property that identifies point light position and related metata. More...
 
DynamicPropertyType< Float > PointLightRadiusProperty
 Sets the distance at which the intensity of the Point Light reaches zero. More...
 
DynamicPropertyType< Vector3SpotLightAttenuationProperty
 Sets the effect that this Spot Light has on nodes that are farther away. More...
 
DynamicPropertyType< ColorRGBASpotLightColorProperty
 Sets the color of the Spot Light. More...
 
DynamicPropertyType< Vector3SpotLightConeParametersProperty
 A hidden property that identifies the spotlight cone parameters and contains related metadata. More...
 
DynamicPropertyType< Float > SpotLightCutoffAngleProperty
 Sets the angle of the light cone in degrees. More...
 
DynamicPropertyType< Vector3SpotLightDirectionProperty
 A hidden property that identifies spotlight direction and contains related metadata. More...
 
DynamicPropertyType< Float > SpotLightExponentProperty
 Defines how fast a fully lit area at the center of the light cone turns into an unlit area. More...
 
DynamicPropertyType< Float > SpotLightInnerAngleProperty
 Sets the inner angle of the light cone in degrees. More...
 
DynamicPropertyType< Vector3SpotLightPositionProperty
 A hidden property that identifies spotlight position and contains related metadata. More...
 
DynamicPropertyType< Float > SpotLightRadiusProperty
 Sets the distance at which the intensity of the Spot Light reaches zero. More...
 
- Public Attributes inherited from Node3DMetadata
DynamicPropertyType< Matrix4x4FinalTransformationProperty
 The combined location, orientation and scale of the node and its ancestor nodes. More...
 
DynamicPropertyType< Float > FrustumCullMarginProperty
 The margin of the frustum cull radius of the node. More...
 
DynamicPropertyType< SRTValue3DLayoutTransformationProperty
 The location, orientation and scale of the node relative to its parent node. More...
 
AbstractMetaclass metaclass = new AbstractMetaclass("Kanzi.Node3D")
 Metaclass for Node3D.
 
DynamicPropertyType< SRTValue3DRenderTransformationProperty
 The location, orientation, and scale of the node relative to its parent node. More...
 
- Public Attributes inherited from NodeMetadata
DynamicPropertyType< Float > ActualDepthProperty
 The calculated size of the node in depth direction when used in a layout. More...
 
DynamicPropertyType< Float > ActualHeightProperty
 The calculated height of the node when used in a layout. More...
 
DynamicPropertyType< Float > ActualWidthProperty
 The calculated width of the node when used in a layout. More...
 
DynamicPropertyType< Boolean > ClipChildrenProperty
 Sets whether to clip the child nodes of this node. More...
 
DynamicPropertyType< NodeEnums.ContentStretchContentStretchProperty
 Sets how the content that belongs to this node is stretched (as opposed to manipulating the actual node size). More...
 
DynamicPropertyType< Boolean > CreatedFromKZBProperty
 Kanzi internally uses this property to distinguish objects like bindings and triggers created in code from objects that are loaded from a kzb file. More...
 
DynamicPropertyType< NodeEnums.DepthAlignmentDepthAlignmentProperty
 The alignment in depth direction the node should use when it resides under a layout. More...
 
DynamicPropertyType< Vector2DepthMarginProperty
 Sets the depth distance between this node and other nodes that are adjacent to this node in a layout. More...
 
DynamicPropertyType< Float > DepthProperty = new DynamicPropertyType<>("Node.Depth", Float.class)
 The size of the node in depth direction when used in a layout. More...
 
DynamicPropertyType< Boolean > EffectivelyEnabledProperty
 Indicates whether this node and its ancestor nodes are enabled. More...
 
DynamicPropertyType< Boolean > EnabledProperty
 Whether this node is enabled. More...
 
DynamicPropertyType< Boolean > FocusableProperty
 Indicates whether the node can receive focus. More...
 
DynamicPropertyType< Boolean > FocusedProperty
 Indicates whether the node has the key focus. More...
 
DynamicPropertyType< FocusStateFocusStateProperty
 Reports the focus state of a node: More...
 
DynamicPropertyType< ResourceFontFamilyProperty
 The font family used to render the text. More...
 
DynamicPropertyType< Float > HeightProperty
 The height of the node when used in a layout. More...
 
DynamicPropertyType< Boolean > HitTestableContainerProperty
 When enabled, Kanzi uses the layout bounds as geometry for hit testing. More...
 
DynamicPropertyType< Boolean > HitTestableProperty
 When enabled, the node can be hit tested. More...
 
DynamicPropertyType< NodeEnums.HorizontalAlignmentHorizontalAlignmentProperty
 The alignment in horizontal direction the node should use when it resides under a layout. More...
 
DynamicPropertyType< Vector2HorizontalMarginProperty
 Sets the horizontal space between this node and other nodes that are adjacent to this node in a layout. More...
 
DynamicPropertyType< Boolean > HoverProperty
 Indicates whether a node is the foremost hit testable node under the cursor. More...
 
DynamicPropertyType< String > LocaleProperty
 The locale of the node. More...
 
AbstractMetaclass metaclass = new AbstractMetaclass("Kanzi.Node")
 Metaclass for Node.
 
DynamicPropertyType< String > NameProperty = new DynamicPropertyType<>("Node.Name", String.class)
 Node name.
 
DynamicPropertyType< Float > OpacityProperty
 Opacity of the node. More...
 
DynamicPropertyType< String > PathProperty = new DynamicPropertyType<>("Node.Path", String.class)
 Full path to the node.
 
DynamicPropertyType< Float > Projection2DTo3DScaleProperty
 Sets the scale factor to project pixels to 3D size. More...
 
DynamicPropertyType< ResourceStateManagerProperty
 Sets the State Manager to the node. More...
 
DynamicPropertyType< ResourceStyleProperty
 Sets a style to the node. More...
 
DynamicPropertyType< NodeEnums.VerticalAlignmentVerticalAlignmentProperty
 The alignment in vertical direction the node should use when it resides under a layout. More...
 
DynamicPropertyType< Vector2VerticalMarginProperty
 Sets the vertical space between this node and other nodes that are adjacent to this node in a layout. More...
 
DynamicPropertyType< Float > VisibleAmountInParentProperty
 Sets the amount the node is inside its parent. More...
 
DynamicPropertyType< Boolean > VisibleProperty
 When disabled, Kanzi does not render the node. More...
 
DynamicPropertyType< Float > WidthProperty = new DynamicPropertyType<>("Node.Width", Float.class)
 The width of the node when used in a layout. More...
 

Detailed Description

Metadata definitions for Light.

Member Data Documentation

DynamicPropertyType<ColorRGBA> DirectionalLightColorProperty
Initial value:
=
new DynamicPropertyType<>("DirectionalLightColor", ColorRGBA.class)

Sets the color of the Directional Light.

DynamicPropertyType<Vector3> DirectionalLightDirectionProperty
Initial value:
=
new DynamicPropertyType<>("DirectionalLightDirection", Vector3.class)

A hidden property that identifies directional light direction and contains related metadata.

DynamicPropertyType<String> LightPropertyTypeProperty
Initial value:
=
new DynamicPropertyType<>("LightPropertyType", String.class)

The property type name of the light.

DynamicPropertyType<Vector3> PointLightAttenuationProperty
Initial value:
=
new DynamicPropertyType<>("PointLightAttenuation", Vector3.class)

Sets the effect that this Point Light has on nodes that are farther away.

Distance of light from the lighted surface is input in a quadratic function, the 3 components are the constant, linear and quadratic coefficients for the distance variable.

DynamicPropertyType<ColorRGBA> PointLightColorProperty
Initial value:
=
new DynamicPropertyType<>("PointLightColor", ColorRGBA.class)

Sets the color of the Point Light.

DynamicPropertyType<Vector3> PointLightPositionProperty
Initial value:
=
new DynamicPropertyType<>("PointLightPosition", Vector3.class)

A hidden property that identifies point light position and related metata.

DynamicPropertyType<Float> PointLightRadiusProperty
Initial value:
=
new DynamicPropertyType<>("PointLightRadius", Float.class)

Sets the distance at which the intensity of the Point Light reaches zero.

For infinite distance, set the property value to 0.

DynamicPropertyType<Vector3> SpotLightAttenuationProperty
Initial value:
=
new DynamicPropertyType<>("SpotLightAttenuation", Vector3.class)

Sets the effect that this Spot Light has on nodes that are farther away.

Distance of light from the lighted surface is input in a quadratic function, the 3 components are the constant, linear and quadratic coefficients for the distance variable.

DynamicPropertyType<ColorRGBA> SpotLightColorProperty
Initial value:
=
new DynamicPropertyType<>("SpotLightColor", ColorRGBA.class)

Sets the color of the Spot Light.

DynamicPropertyType<Vector3> SpotLightConeParametersProperty
Initial value:
=
new DynamicPropertyType<>("SpotLightConeParameters", Vector3.class)

A hidden property that identifies the spotlight cone parameters and contains related metadata.

DynamicPropertyType<Float> SpotLightCutoffAngleProperty
Initial value:
=
new DynamicPropertyType<>("SpotLightCutoffAngle", Float.class)

Sets the angle of the light cone in degrees.

DynamicPropertyType<Vector3> SpotLightDirectionProperty
Initial value:
=
new DynamicPropertyType<>("SpotLightDirection", Vector3.class)

A hidden property that identifies spotlight direction and contains related metadata.

DynamicPropertyType<Float> SpotLightExponentProperty
Initial value:
=
new DynamicPropertyType<>("SpotLightExponent", Float.class)

Defines how fast a fully lit area at the center of the light cone turns into an unlit area.

DynamicPropertyType<Float> SpotLightInnerAngleProperty
Initial value:
=
new DynamicPropertyType<>("SpotLightInnerAngle", Float.class)

Sets the inner angle of the light cone in degrees.

DynamicPropertyType<Vector3> SpotLightPositionProperty
Initial value:
=
new DynamicPropertyType<>("SpotLightPosition", Vector3.class)

A hidden property that identifies spotlight position and contains related metadata.

DynamicPropertyType<Float> SpotLightRadiusProperty
Initial value:
=
new DynamicPropertyType<>("SpotLightRadius", Float.class)

Sets the distance at which the intensity of the Spot Light reaches zero.

For infinite distance, set the property value to 0.