Behavior element behavior adding dynamic skin support. More...

Inheritance diagram for Dragengine.Scenery.ECBehaviorDynamicSkin:

Classes
class	Instance
	Behavior instance. More...

Public Member Functions
ECBehaviorInstance	createInstance (BehaviorElement element)
	Create Behavior instance. More...

void	dispose ()
	Dispose of behavior. More...

ECBehaviorComponent	getComponent ()
	Component behavior. More...

Instance	instance (BehaviorElement element)
	Get instance in element from owner element class. More...

ECBehaviorDynamicSkin	new (BehaviorElementClass eclass, ECBehaviorComponent component)
	Create behavior element class attaching to component with empty id. More...

ECBehaviorDynamicSkin	new (BehaviorElementClass eclass, ECBehaviorComponent component, String id)
	Create behavior element class attaching to component with empty id. 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 ECBehaviorDynamicSkin	getBehaviorIn (BehaviorElementClass eclass)
	Get behavior in element class or null if absent. More...

static ECBehaviorDynamicSkin	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 dynamic skin support.

Dynamic skins are used to alter the visual appearance of ECBehaviorComponent. Dynamic skins affect the skin assigned to the ECBehaviorComponent. By default the ECBehaviorComponent with empty identifier is assigned the dynamic skin. Multiple ECBehaviorDynamicSkin can be added targeting different ECBehaviorComponent using their identifier. It is not possible to add multiple ECBehaviorDynamicSkin targeting the same ECBehaviorComponent.

To use this behavior make sure to add first the ECBehaviorComponent to assign the dynamic skins to. The example below adds to components and dynamic skins for each of them.

class MyElement extends BehaviorElementClass
   public func new()
      var ECBehaviorComponent component = ECBehaviorComponent.new(this)
      ECBehaviorDynamicSkin.new(this, component)
      
      var ECBehaviorComponent subComponent = ECBehaviorComponent.new(this, "subComponent")
      ECBehaviorDynamicSkin.new(this, subComponent)
   end
end

Dynamic skin behaviors have an own identifier so they can be properly targeted by other behaviors.

This behavior provides the dynamic skin for the component. Other behaviors add renderables to them to provide their functionality. Multiple behaviors should not target the same named renderable unless they are crafted in a specific way to not interfere with each other.

No element class properties are added.

This behavior does not require the element class to be persistable (setPersistable).

Todo:: Add "light id" and "particle emitter id" to allow the dynamic skin to attach also to lights (as light skin) and particle emitters.

Member Function Documentation

◆ createInstance()

ECBehaviorInstance Dragengine.Scenery.ECBehaviorDynamicSkin.createInstance ( BehaviorElement element )

Create Behavior instance.

Implements Dragengine.Scenery.ECBehavior.

◆ dispose()

void Dragengine.Scenery.ECBehaviorDynamicSkin.dispose ( )

Dispose of behavior.

Reimplemented from Dragengine.Scenery.DefaultECBehavior.

◆ getAllBehaviorsIn()

static Array Dragengine.Scenery.ECBehaviorDynamicSkin.getAllBehaviorsIn ( BehaviorElementClass eclass )

static

Get list of all behaviors in element.

Returns list contains ECBehaviorDynamicSkin behaviors in the order they have been created in the element.

◆ getAllInstancesIn()

static Array Dragengine.Scenery.ECBehaviorDynamicSkin.getAllInstancesIn ( BehaviorElement element )

static

Get list of all instances in element.

Returns list contains ECBehaviorDynamicSkin.Instance instances in the order they have been created in the element.

◆ getBehaviorIn() [1/2]

static ECBehaviorDynamicSkin Dragengine.Scenery.ECBehaviorDynamicSkin.getBehaviorIn ( BehaviorElementClass eclass )

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 ECBehaviorDynamicSkin Dragengine.Scenery.ECBehaviorDynamicSkin.getBehaviorIn	(	BehaviorElementClass	eclass,
		String	id
	)

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 ECBehaviorDynamicSkin with specific identifier.

◆ getComponent()

ECBehaviorComponent Dragengine.Scenery.ECBehaviorDynamicSkin.getComponent ( )

Component behavior.

◆ getInstanceIn() [1/2]

static Instance Dragengine.Scenery.ECBehaviorDynamicSkin.getInstanceIn ( BehaviorElement element )

static

Get instance in element or null if absent.

Use this method to check if a particular BehaviorElement contains a behavior instance of type ECBehaviorDynamicSkin.Instance . If more than one instance is present returns the first instance.

◆ getInstanceIn() [2/2]

static Instance Dragengine.Scenery.ECBehaviorDynamicSkin.getInstanceIn	(	BehaviorElement	element,
		String	id
	)

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 ECBehaviorDynamicSkin.Instance with specific identifier.

◆ instance()

Instance Dragengine.Scenery.ECBehaviorDynamicSkin.instance ( BehaviorElement element )

Get instance in element from owner element class.

◆ new() [1/2]

ECBehaviorDynamicSkin Dragengine.Scenery.ECBehaviorDynamicSkin.new	(	BehaviorElementClass	eclass,
		ECBehaviorComponent	component
	)

Create behavior element class attaching to component with empty id.

◆ new() [2/2]

ECBehaviorDynamicSkin Dragengine.Scenery.ECBehaviorDynamicSkin.new	(	BehaviorElementClass	eclass,
		ECBehaviorComponent	component,
		String	id
	)

Create behavior element class attaching to component with empty id.

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

ECBehaviorDynamicSkin.ds

Classes

Public Member Functions

Static Public Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ createInstance()

◆ dispose()

◆ getAllBehaviorsIn()

◆ getAllInstancesIn()

◆ getBehaviorIn() [1/2]

◆ getBehaviorIn() [2/2]

◆ getComponent()

◆ getInstanceIn() [1/2]

◆ getInstanceIn() [2/2]

◆ instance()

◆ new() [1/2]

◆ new() [2/2]