Composable force field for element class. More...

Inheritance diagram for Dragengine.Scenery.ECComposeForceField:

Public Member Functions
void	collisionCategoryClearBit (int bit)
	Convience function clearing bit in collision category.

void	collisionCategoryReplace (LayerMask layerMask)
	Convience function replacing collision category.

void	collisionCategorySetBit (int bit)
	Convience function setting bit in collision category.

void	collisionFilterClearBit (int bit)
	Convience function clearing bit in collision filter.

void	collisionFilterSetBit (int bit)
	Convience function setting bit in collision filter.

ForceField	createForceField (Element element, StubElement stub)
	Initialize force field for element from stub.

TSTriggerExpression	createTriggerEnable (Element element, StubElement stub)
	Create activate force field trigger expression from stub or null if not used.

TSTriggerExpression	createTriggerEnable (Element element, StubElement stub, String defaultValue)
	Create activate force field trigger expression from stub or null if not used.

ECPEnumeration	getApplicationType ()
	Force application type.

CollisionFilter	getCollisionFilter ()
	Collision filter.

ECPVector	getDirection ()
	Force direction.

ECPBoolean	getEnabled ()
	Initial force field enabled state.

ECPFloat	getExponent ()
	Falloff exponent.

ECPEnumeration	getFieldType ()
	Field type.

ECPFloat	getFluctuationDirection ()
	Fluctuation of direction in degrees.

ECPFloat	getFluctuationForce ()
	Fluctuation of force in newton.

ECPFloat	getForce ()
	Force in newton.

ECPShapeList	getInfluenceArea ()
	Influence area.

String	getPrefix ()
	Property prefix.

ECPFloat	getRadius ()
	Falloff radius.

ECPShapeList	getShape ()
	Shape from which force originates.

ECComposeForceField	new (ElementClass ownerClass)
	Create composable element class.

ECComposeForceField	new (ElementClass ownerClass, String prefix)
	Create composable element class.

void	setCollisionFilter (CollisionFilter collisionFilter)
	Set collision filter.

Detailed Description

Composable force field for element class.

Provides force field support to element class without subclassing from a specific class.

Member Function Documentation

◆ collisionCategoryClearBit()

void Dragengine.Scenery.ECComposeForceField.collisionCategoryClearBit ( int bit )

Convience function clearing bit in collision category.

◆ collisionCategoryReplace()

void Dragengine.Scenery.ECComposeForceField.collisionCategoryReplace ( LayerMask layerMask )

Convience function replacing collision category.

◆ collisionCategorySetBit()

void Dragengine.Scenery.ECComposeForceField.collisionCategorySetBit ( int bit )

Convience function setting bit in collision category.

◆ collisionFilterClearBit()

void Dragengine.Scenery.ECComposeForceField.collisionFilterClearBit ( int bit )

Convience function clearing bit in collision filter.

◆ collisionFilterSetBit()

void Dragengine.Scenery.ECComposeForceField.collisionFilterSetBit ( int bit )

Convience function setting bit in collision filter.

◆ createForceField()

ForceField Dragengine.Scenery.ECComposeForceField.createForceField	(	Element	element,
		StubElement	stub
	)

Initialize force field for element from stub.

◆ createTriggerEnable() [1/2]

TSTriggerExpression Dragengine.Scenery.ECComposeForceField.createTriggerEnable	(	Element	element,
		StubElement	stub
	)

Create activate force field trigger expression from stub or null if not used.

◆ createTriggerEnable() [2/2]

TSTriggerExpression Dragengine.Scenery.ECComposeForceField.createTriggerEnable	(	Element	element,
		StubElement	stub,
		String	defaultValue
	)

Create activate force field trigger expression from stub or null if not used.

◆ getApplicationType()

ECPEnumeration Dragengine.Scenery.ECComposeForceField.getApplicationType ( )

Force application type.

◆ getCollisionFilter()

CollisionFilter Dragengine.Scenery.ECComposeForceField.getCollisionFilter ( )

Collision filter.

◆ getDirection()

ECPVector Dragengine.Scenery.ECComposeForceField.getDirection ( )

Force direction.

◆ getEnabled()

ECPBoolean Dragengine.Scenery.ECComposeForceField.getEnabled ( )

Initial force field enabled state.

◆ getExponent()

ECPFloat Dragengine.Scenery.ECComposeForceField.getExponent ( )

Falloff exponent.

◆ getFieldType()

ECPEnumeration Dragengine.Scenery.ECComposeForceField.getFieldType ( )

Field type.

◆ getFluctuationDirection()

ECPFloat Dragengine.Scenery.ECComposeForceField.getFluctuationDirection ( )

Fluctuation of direction in degrees.

◆ getFluctuationForce()

ECPFloat Dragengine.Scenery.ECComposeForceField.getFluctuationForce ( )

Fluctuation of force in newton.

◆ getForce()

ECPFloat Dragengine.Scenery.ECComposeForceField.getForce ( )

Force in newton.

◆ getInfluenceArea()

ECPShapeList Dragengine.Scenery.ECComposeForceField.getInfluenceArea ( )

Influence area.

◆ getPrefix()

String Dragengine.Scenery.ECComposeForceField.getPrefix ( )

Property prefix.

◆ getRadius()

ECPFloat Dragengine.Scenery.ECComposeForceField.getRadius ( )

Falloff radius.

◆ getShape()

ECPShapeList Dragengine.Scenery.ECComposeForceField.getShape ( )

Shape from which force originates.

◆ new() [1/2]

ECComposeForceField Dragengine.Scenery.ECComposeForceField.new ( ElementClass ownerClass )

Create composable element class.

Adds all properties to ownerClass. If you do not want a property to be configurable using XML subclassing use ownerClass.removeProperty() to remove them.

◆ new() [2/2]

ECComposeForceField Dragengine.Scenery.ECComposeForceField.new	(	ElementClass	ownerClass,
		String	prefix
	)