Behavior element behavior adding billboard support. More...

Inheritance diagram for Dragengine.Scenery.ECBehaviorBillboard:

Classes
class	Instance
	Behavior instance. More...

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

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

ECComposeBillboard	getBillboard ()
	Billboard for element class. More...

ECBehaviorCollider	getCollider ()
	Collider behavior. More...

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

ECBehaviorBillboard	new (BehaviorElementClass eclass, ECBehaviorCollider collider)
	Create behavior element class. More...

ECBehaviorBillboard	new (BehaviorElementClass eclass, ECBehaviorCollider collider, String id)

ECBehaviorBillboard	new (BehaviorElementClass eclass, ECBehaviorCollider collider, String id, String prefix)

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 ECBehaviorBillboard	getBehaviorIn (BehaviorElementClass eclass)
	Get behavior in element class or null if absent. More...

static ECBehaviorBillboard	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 billboard support.

Billboards place a flat image in the game world optionally rotated towards the camera position. This behavior can be added multiple times to an element. Each instance creates one billboard attached to the element collider which can be individually modified. To distinguish the billboards each instance has an identifier which can be used to retrieve a specific instance. The identifier is also used as prefix for element class properties and stub properties if not empty. Hence to use more than one billboard use code like this in your subclass constructor:

class MyElement extends BehaviorElementClass
   public func new()
      ECBehaviorBillboard.new(this, null)
      ECBehaviorBillboard.new(this, null, "subBillboard")
   end
end

You can now define the skin to use for both billboards using the properties "skin" for the first billboard and "subBillboard.skin" for the second billboard.

If the ECBehaviorCollider behavior is present in the behavior element before this behavior is added the billboard is statically attached.

Element class properties have the prefix "billboard{(id)}.".

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

Member Function Documentation

◆ createInstance()

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

Create Behavior instance.

Implements Dragengine.Scenery.ECBehavior.

◆ dispose()

void Dragengine.Scenery.ECBehaviorBillboard.dispose ( )

Dispose of behavior.

Reimplemented from Dragengine.Scenery.DefaultECBehavior.

◆ getAllBehaviorsIn()

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

static

Get list of all behaviors in element.

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

◆ getAllInstancesIn()

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

static

Get list of all instances in element.

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

◆ getBehaviorIn() [1/2]

static ECBehaviorBillboard Dragengine.Scenery.ECBehaviorBillboard.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 ECBehaviorCollider.

◆ getBehaviorIn() [2/2]

static ECBehaviorBillboard Dragengine.Scenery.ECBehaviorBillboard.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 ECBehaviorBillboard with specific identifier.

◆ getBillboard()

ECComposeBillboard Dragengine.Scenery.ECBehaviorBillboard.getBillboard ( )

Billboard for element class.

◆ getCollider()

ECBehaviorCollider Dragengine.Scenery.ECBehaviorBillboard.getCollider ( )

Collider behavior.

◆ getInstanceIn() [1/2]

static Instance Dragengine.Scenery.ECBehaviorBillboard.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 ECBehaviorBillboard.Instance . If more than one instance is present returns the first instance.

◆ getInstanceIn() [2/2]

static Instance Dragengine.Scenery.ECBehaviorBillboard.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 ECBehaviorBillboard.Instance with specific identifier.

◆ instance()

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

Get instance in element from owner element class.

◆ new() [1/3]

ECBehaviorBillboard Dragengine.Scenery.ECBehaviorBillboard.new	(	BehaviorElementClass	eclass,
		ECBehaviorCollider	collider
	)

Create behavior element class.

These values are optional and can be null: collider.

◆ new() [2/3]

ECBehaviorBillboard Dragengine.Scenery.ECBehaviorBillboard.new	(	BehaviorElementClass	eclass,
		ECBehaviorCollider	collider,
		String	id
	)

◆ new() [3/3]

ECBehaviorBillboard Dragengine.Scenery.ECBehaviorBillboard.new	(	BehaviorElementClass	eclass,
		ECBehaviorCollider	collider,
		String	id,
		String	prefix
	)

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

ECBehaviorBillboard.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]

◆ getBillboard()

◆ getCollider()

◆ getInstanceIn() [1/2]

◆ getInstanceIn() [2/2]

◆ instance()

◆ new() [1/3]

◆ new() [2/3]

◆ new() [3/3]