Behavior element behavior adding dimming support to ECBehaviorLight. More...
Classes | |
| class | Instance |
| Behavior instance. More... | |
Public Member Functions | |
| ECBehaviorInstance | createInstance (BehaviorElement element) |
| Create Behavior instance. More... | |
| void | dispose () |
| Dispose of behavior. More... | |
| ECBehaviorLight | getLight () |
| Light behavior to modify. More... | |
| ECPFloat | getTimeLower () |
| Time in seconds to lower intensity. More... | |
| ECPFloat | getTimeRaise () |
| Time in seconds to raise intensity. More... | |
| Instance | instance (BehaviorElement element) |
| Get instance in element from owner element class. More... | |
| ECBehaviorLightDimmer | new (BehaviorElementClass eclass, ECBehaviorLight light) |
| Create behavior element class. More... | |
| ECBehaviorLightDimmer | new (BehaviorElementClass eclass, ECBehaviorLight light, String id) |
| Create behavior element class. More... | |
| ECBehaviorLightDimmer | new (BehaviorElementClass eclass, ECBehaviorLight light, String id, String prefix) |
| void | setLight (ECBehaviorLight light) |
| Set light behavior to modify. More... | |
 Public Member Functions inherited from Dragengine.Scenery.DefaultECBehavior | |
| void | assignInstanceIndex (int instanceIndex) |
| Assign instance index. More... | |
| String | getBehaviorID () |
| Unique identifier of behavior. More... | |
| String | getID () |
| Identifier. More... | |
| int | getInstanceIndex () |
| Instance index. More... | |
| void | loadSupportedData (String identifier, PersistencyEnvironment env, FileReader reader, ECBehaviorInstance instance) |
| Load instance data of another behavior. More... | |
| bool | supportsBehaviorID (String identifier) |
| Behavior supports loading instance data of another behavior. More... | |
Static Public Member Functions | |
| static Array | getAllBehaviorsIn (BehaviorElementClass eclass) |
| Get list of all behaviors in element. More... | |
| static Array | getAllInstancesIn (BehaviorElement element) |
| Get list of all instances in element. More... | |
| static ECBehaviorLightDimmer | getBehaviorIn (BehaviorElementClass eclass) |
| Get behavior in element class or null if absent. More... | |
| static ECBehaviorLightDimmer | getBehaviorIn (BehaviorElementClass eclass, String id) |
| Get behavior with id in element class or null if absent. More... | |
| static Instance | getInstanceIn (BehaviorElement element) |
| Get instance in element or null if absent. More... | |
| static Instance | getInstanceIn (BehaviorElement element, String id) |
| Get instance with id in element or null if absent. More... | |
Additional Inherited Members | |
| Protected Member Functions inherited from Dragengine.Scenery.DefaultECBehavior | |
| DefaultECBehavior | new (BehaviorElementClass eclass) |
| Create default composeable behavior with empty identifier. More... | |
| DefaultECBehavior | new (BehaviorElementClass eclass, String id) |
| Create default composeable behavior. More... | |
| void | setBehaviorID (String identifier) |
| Set behavior identifier. More... | |
| void | useClassNameAsBehaviorID () |
| Set behavior identifier to "<class-name>:<identifier>". More... | |
| void | useFullyQualifiedClassNameAsBehaviorID () |
| Set behavior identifier to "<fully-qualified-class-name>:<identifier>". More... | |
Detailed Description
Behavior element behavior adding dimming support to ECBehaviorLight.
This behavior modifies the light parameters of ECBehaviorLight instances present in the element to make lights gently raise and lower intensity when (de)activated.
To use this behavior add first an ECBehaviorLight. Addint ECBehaviorLightDimmer will then register itself as listener to the ECBehaviorLight and also set it to use custom light handling.
Multiple ECBehaviorLightDimmer instances can be added to affect individual ECBehaviorLight instances like this example below.
Element class properties have the prefix "lightDimmer{(id)}.".
- Full Bright Intensity
This behaviors needs to know the full bright intensity of the light. During init() call the intensity of the light resource in the controlled ECBehaviorLight is stored as the full bright intensity. This value can be later on changed if required.
If the full bright intensity of the light can change over you have to update the full bright intensity in this behavior for the dimming to work correctly.
This behavior does require the element class to be persistable (setPersistable).
Member Function Documentation
◆ createInstance()
| ECBehaviorInstance Dragengine.Scenery.ECBehaviorLightDimmer.createInstance | ( | BehaviorElement | element | ) |
Create Behavior instance.
Implements Dragengine.Scenery.ECBehavior.
◆ dispose()
| void Dragengine.Scenery.ECBehaviorLightDimmer.dispose | ( | ) |
Dispose of behavior.
Reimplemented from Dragengine.Scenery.DefaultECBehavior.
◆ getAllBehaviorsIn()
|
static |
Get list of all behaviors in element.
Returns list contains ECBehaviorLightDimmer behaviors in the order they have been created in the element.
◆ getAllInstancesIn()
|
static |
Get list of all instances in element.
Returns list contains ECBehaviorLightDimmer.Instance instances in the order they have been created in the element.
◆ getBehaviorIn() [1/2]
|
static |
Get behavior in element class or null if absent.
Use this method to check if a particular BehaviorElementClass contains a behavior of type ECBehaviorComponent.
◆ getBehaviorIn() [2/2]
|
static |
Get behavior with id in element class or null if absent.
Use this method to check if a particular BehaviorElementClass contains a behavior of type ECBehaviorLightDimmer with specific identifier.
◆ getInstanceIn() [1/2]
|
static |
Get instance in element or null if absent.
Use this method to check if a particular BehaviorElement contains a behavior instance of type ECBehaviorLightDimmer.Instance . If more than one instance is present returns the first instance.
◆ getInstanceIn() [2/2]
|
static |
Get instance with id in element or null if absent.
Use this method to check if a particular BehaviorElement contains a behavior instance of type ECBehaviorLightDimmer.Instance with specific identifier.
◆ getLight()
| ECBehaviorLight Dragengine.Scenery.ECBehaviorLightDimmer.getLight | ( | ) |
Light behavior to modify.
◆ getTimeLower()
| ECPFloat Dragengine.Scenery.ECBehaviorLightDimmer.getTimeLower | ( | ) |
Time in seconds to lower intensity.
◆ getTimeRaise()
| ECPFloat Dragengine.Scenery.ECBehaviorLightDimmer.getTimeRaise | ( | ) |
Time in seconds to raise intensity.
◆ instance()
| Instance Dragengine.Scenery.ECBehaviorLightDimmer.instance | ( | BehaviorElement | element | ) |
Get instance in element from owner element class.
◆ new() [1/3]
| ECBehaviorLightDimmer Dragengine.Scenery.ECBehaviorLightDimmer.new | ( | BehaviorElementClass | eclass, |
| ECBehaviorLight | light | ||
| ) |
Create behavior element class.
◆ new() [2/3]
| ECBehaviorLightDimmer Dragengine.Scenery.ECBehaviorLightDimmer.new | ( | BehaviorElementClass | eclass, |
| ECBehaviorLight | light, | ||
| String | id | ||
| ) |
Create behavior element class.
◆ new() [3/3]
| ECBehaviorLightDimmer Dragengine.Scenery.ECBehaviorLightDimmer.new | ( | BehaviorElementClass | eclass, |
| ECBehaviorLight | light, | ||
| String | id, | ||
| String | prefix | ||
| ) |
◆ setLight()
| void Dragengine.Scenery.ECBehaviorLightDimmer.setLight | ( | ECBehaviorLight | light | ) |
Set light behavior to modify.
The documentation for this class was generated from the following file:
