Kanzi  3.9.2
Java API
Public Attributes | List of all members
LightMetadata Interface Reference

Metadata definitions for Light. More...

Inheritance diagram for LightMetadata:
[legend]

Public Attributes

DynamicPropertyType< ColorRGBA > DirectionalLightColorProperty
 Sets the color of the Directional Light. More...
 
DynamicPropertyType< Vector3 > DirectionalLightDirectionProperty
 A hidden property that identifies directional light direction and contains related metadata. More...
 
DynamicPropertyType< Boolean > LightEnabledProperty
 Whether the light is switched on or off. More...
 
DynamicPropertyType< String > LightPropertyTypeProperty
 The property type name of the light. More...
 
AbstractMetaclass metaclass = new AbstractMetaclass("Kanzi.Light")
 Metaclass for Light.
 
DynamicPropertyType< Vector3 > PointLightAttenuationProperty
 Sets the effect that this Point Light has on nodes that are farther away. More...
 
DynamicPropertyType< ColorRGBA > PointLightColorProperty
 Sets the color of the Point Light. More...
 
DynamicPropertyType< Vector3 > PointLightPositionProperty
 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< Vector3 > SpotLightAttenuationProperty
 Sets the effect that this Spot Light has on nodes that are farther away. More...
 
DynamicPropertyType< ColorRGBA > SpotLightColorProperty
 Sets the color of the Spot Light. More...
 
DynamicPropertyType< Vector3 > SpotLightConeParametersProperty
 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< Vector3 > SpotLightDirectionProperty
 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< Vector3 > SpotLightPositionProperty
 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...
 

Detailed Description

Metadata definitions for Light.

Member Data Documentation

◆ DirectionalLightColorProperty

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

Sets the color of the Directional Light.

◆ DirectionalLightDirectionProperty

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

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

◆ LightEnabledProperty

DynamicPropertyType<Boolean> LightEnabledProperty
Initial value:
=
new DynamicPropertyType<>("LightEnabled", Boolean.class)

Whether the light is switched on or off.

Only lights that are switched on affect rendering.

◆ LightPropertyTypeProperty

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

The property type name of the light.

◆ PointLightAttenuationProperty

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.

◆ PointLightColorProperty

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

Sets the color of the Point Light.

◆ PointLightPositionProperty

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

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

◆ PointLightRadiusProperty

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.

◆ SpotLightAttenuationProperty

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.

◆ SpotLightColorProperty

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

Sets the color of the Spot Light.

◆ SpotLightConeParametersProperty

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

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

◆ SpotLightCutoffAngleProperty

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

Sets the angle of the light cone in degrees.

◆ SpotLightDirectionProperty

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

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

◆ SpotLightExponentProperty

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.

◆ SpotLightInnerAngleProperty

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

Sets the inner angle of the light cone in degrees.

◆ SpotLightPositionProperty

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

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

◆ SpotLightRadiusProperty

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.