Dragengine.Scenery.ECBehaviorCamera.Factory Class Reference

Behavior factory. More...

Inheritance diagram for Dragengine.Scenery.ECBehaviorCamera.Factory:

Classes
class	Instance
	Behavior instance. More...

Public Member Functions
ECBehavior	addBehavior (BehaviorElementClass eclass, String id, Dictionary parameters)
	Add behavior to element class.
void	addIgnoreComponent (ECBehaviorComponent component)
	Add component to ignore while rendering.
void	dispose ()
	Dispose of behavior.
void	forEachIgnoreComponent (Block ablock)
	Visit components to ignore while rendering using block.
ECPFloat	getAdaptionTime ()
	Adaption time of the eye in seconds.
ECComposeAttachResource	getAttach ()
	Attach resource.
ECBehaviorCollider	getCollider ()
	Collider behavior or null to not attach.
ECPBoolean	getEnableGI ()
	Enable global illumination (GI) if supported.
ECPBoolean	getEnableHDRR ()
	Enable high definition range rendering (HDRR) if supported.
ECPFloat	getExposure ()
	Exposure.
ECPFloat	getFov ()
	Vertical field of view in degrees for the entire view.
ECPFloat	getFovRatio ()
	Aspect ratio of the horizontal field of view to the vertical field of view.
ECPFloat	getHighestIntensity ()
	Highest intensity the eye can adapt to.
ECPFloat	getImageDistance ()
	Distance to the image plane.
LayerMask	getLayerMask ()
	Layer mask.
LoadCamera	getLoadCamera ()
	Camera loader or null.
ECPFloat	getLowestIntensity ()
	Lowest intensity the eye can adapt to.
ECPString	getPathParameters ()
	Path to camera parameters file (*.decamera) to use or null/empty string.
ECPFloat	getViewDistance ()
	Viewing distance up to which world geometry is rendered.
Instance	instance (BehaviorElement element)
	Get instance in element from owner element class.
Factory	new ()
Factory	new (BehaviorElementClass eclass, ECBehaviorCollider collider)
	Create behavior element class.
Factory	new (BehaviorElementClass eclass, ECBehaviorCollider collider, String id)
Factory	new (BehaviorElementClass eclass, ECBehaviorCollider collider, String id, String prefix)
void	setLayerMask (LayerMask layerMask)
	Set layer mask.
void	setLoadCamera (LoadCamera loader)
	Set camera loader or null.
Public Member Functions inherited from Dragengine.Scenery.DefaultBehaviorFactory
void	assertIdEmpty (String id)
	Assert id is empty string.
String	factoryId ()
	Unique identifier of factory.
BindingManager	getBindingManagerFor (String value)
	Binding manager matching value.
CommandManager	getCommandManagerFor (String value)
	Command manager matching value.
BehaviorFactoryHelper	getHelper ()
	Helper to use.
ECBehaviorPlayerControllable.Tracker	getPlayerControllableActorFor (String value)
	Player controllable actor matching value.
ECBehaviorPlayerControllable.Tracker	getPlayerControlledActorFor (String value)
	Trigger table matching value.
SimpleConversationConverter	getSimpleConversationConverterFor (String value)
	Simple conversation converter matching value.
ConversationPlaybackSubTitle	getSubTitleFor (String value)
	Conversation playback subtitle matching value.
GuiTheme	getSubtitleThemeFor (String value)
	Subtitle gui theme matching value.
TranslationManager	getTranslationManagerFor (String value)
	Translation manager matching value.
TSTriggerTable	getTriggerTableFor (String value)
	Trigger table matching value.
DefaultBehaviorFactory	new (String id)
void	setHelper (BehaviorFactoryHelper helper)
	Set helper to use.

Static Public Member Functions
static ECBehaviorCamera	getBehaviorIn (BehaviorElementClass eclass)
	Get behavior in element class or null if absent.

Public Attributes
ECPFloat	pAdaptionTime
ECComposeAttachResource	pAttach
ECBehaviorCollider	pCollider
ECPBoolean	pEnableGI
ECPBoolean	pEnableHDRR
ECPFloat	pExposure
ECPFloat	pFov
ECPFloat	pFovRatio
ECPFloat	pHighestIntensity
Array	pIgnoreComponents
ECPFloat	pImageDistance
LayerMask	pLayerMask
LoadCamera	pLoadCamera
ECPFloat	pLowestIntensity
ECPString	pPathParameters
ECPFloat	pViewDistance
Public Attributes inherited from Dragengine.Scenery.DefaultBehaviorFactory
String	pFactoryId
BehaviorFactoryHelper	pHelper

Detailed Description

Behavior factory.

Version

1.25

Automatically assigns these behaviors if present before adding:

• Optional: ECBehaviorCollider

Example XML element class:

<behavior type='ECBehaviorCamera'>
  <!-- optional: set layer mask (default empty). list of bits to set. -->
  <string name='layerMask'>0 1 4</string>
 
  <!-- optional: list of ECBehaviorComponent identifiers to ignore -->
  <list name='ignoreComponents'>
    <string>first</string>
    <string>second</string>
  </list>
</behavior>
 
<!-- for adding multiple behaviors use unique identifiers -->
<behavior type='ECBehaviorCamera' id='second'>
  ...
</behavior>

Element class properties added by the behavior can also be set directly inside the tag be removing the property name prefix and starting with a "." (for example ".propertyName").

Member Function Documentation

addBehavior()

ECBehavior Dragengine.Scenery.ECBehaviorCamera.Factory.addBehavior	(	BehaviorElementClass	eclass,
		String	id,
		Dictionary	parameters
	)

Add behavior to element class.

Some behaviors support parameters. Parameters are provided as a Dictionary with parameter name as String key and parameter value as Object value. The type and format of value depends on the parameter name. Usually parameters indicate a dependency behavior to use. In this case the parameter name indicates the target behavior slot to assign the behavior to and the value is a String with the identifier of the behavior to assign. The target slot defines what what existing behaviors are matched against this identifier. Value can be also null to assign the null behavior.

Parameters

eclass	Element class to add behavior to.
id	Identifier to use. Has to be unique amongst same type behaviors.
parameters	Parameters as Dictionary with String name and Object value.

Implements Dragengine.Scenery.BehaviorFactory.

addIgnoreComponent()

void Dragengine.Scenery.ECBehaviorCamera.Factory.addIgnoreComponent

(

ECBehaviorComponent

component

)

Add component to ignore while rendering.

Version

1.32

dispose()

void Dragengine.Scenery.ECBehaviorCamera.Factory.dispose

(

)

Dispose of behavior.

forEachIgnoreComponent()

void Dragengine.Scenery.ECBehaviorCamera.Factory.forEachIgnoreComponent

(

Block

ablock

)

Visit components to ignore while rendering using block.

Version

1.32

getAdaptionTime()

ECPFloat Dragengine.Scenery.ECBehaviorCamera.Factory.getAdaptionTime

(

)

Adaption time of the eye in seconds.

getAttach()

ECComposeAttachResource Dragengine.Scenery.ECBehaviorCamera.Factory.getAttach

(

)

Attach resource.

getBehaviorIn()

static ECBehaviorCamera Dragengine.Scenery.ECBehaviorCamera.Factory.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.

getCollider()

ECBehaviorCollider Dragengine.Scenery.ECBehaviorCamera.Factory.getCollider

(

)

Collider behavior or null to not attach.

getEnableGI()

ECPBoolean Dragengine.Scenery.ECBehaviorCamera.Factory.getEnableGI

(

)

Enable global illumination (GI) if supported.

getEnableHDRR()

ECPBoolean Dragengine.Scenery.ECBehaviorCamera.Factory.getEnableHDRR

(

)

Enable high definition range rendering (HDRR) if supported.

getExposure()

ECPFloat Dragengine.Scenery.ECBehaviorCamera.Factory.getExposure

(

)

Exposure.

getFov()

ECPFloat Dragengine.Scenery.ECBehaviorCamera.Factory.getFov

(

)

Vertical field of view in degrees for the entire view.

getFovRatio()

ECPFloat Dragengine.Scenery.ECBehaviorCamera.Factory.getFovRatio

(

)

Aspect ratio of the horizontal field of view to the vertical field of view.

getHighestIntensity()

ECPFloat Dragengine.Scenery.ECBehaviorCamera.Factory.getHighestIntensity

(

)

Highest intensity the eye can adapt to.

getImageDistance()

ECPFloat Dragengine.Scenery.ECBehaviorCamera.Factory.getImageDistance

(

)

Distance to the image plane.

getLayerMask()

LayerMask Dragengine.Scenery.ECBehaviorCamera.Factory.getLayerMask

(

)

Layer mask.

getLoadCamera()

LoadCamera Dragengine.Scenery.ECBehaviorCamera.Factory.getLoadCamera

(

)

Camera loader or null.

Version

1.22

By default set to BehaviorElementClass.sharedFactoryHelper.getLoaders().getCamera().

getLowestIntensity()

ECPFloat Dragengine.Scenery.ECBehaviorCamera.Factory.getLowestIntensity

(

)

Lowest intensity the eye can adapt to.

getPathParameters()

ECPString Dragengine.Scenery.ECBehaviorCamera.Factory.getPathParameters

(

)

Path to camera parameters file (*.decamera) to use or null/empty string.

Version

1.22

If not null/empty path the settings override the manual settings. Requires camera loader to be set.

getViewDistance()

ECPFloat Dragengine.Scenery.ECBehaviorCamera.Factory.getViewDistance

(

)

Viewing distance up to which world geometry is rendered.

instance()

Instance Dragengine.Scenery.ECBehaviorCamera.Factory.instance

(

BehaviorElement

element

)

Get instance in element from owner element class.

new() [1/4]

Factory Dragengine.Scenery.ECBehaviorCamera.Factory.new

(

)

new() [2/4]

Factory Dragengine.Scenery.ECBehaviorCamera.Factory.new	(	BehaviorElementClass	eclass,
		ECBehaviorCollider	collider
	)

Create behavior element class.

These values are optional and can be null: collider.

new() [3/4]

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

new() [4/4]

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

setLayerMask()

void Dragengine.Scenery.ECBehaviorCamera.Factory.setLayerMask

(

LayerMask

layerMask

)

Set layer mask.

setLoadCamera()

void Dragengine.Scenery.ECBehaviorCamera.Factory.setLoadCamera

(

LoadCamera

loader

)

Set camera loader or null.

Version

1.22

Member Data Documentation

pAdaptionTime

ECPFloat Dragengine.Scenery.ECBehaviorCamera.Factory.pAdaptionTime

pAttach

ECComposeAttachResource Dragengine.Scenery.ECBehaviorCamera.Factory.pAttach

pCollider

ECBehaviorCollider Dragengine.Scenery.ECBehaviorCamera.Factory.pCollider

pEnableGI

ECPBoolean Dragengine.Scenery.ECBehaviorCamera.Factory.pEnableGI

pEnableHDRR

ECPBoolean Dragengine.Scenery.ECBehaviorCamera.Factory.pEnableHDRR

pExposure

ECPFloat Dragengine.Scenery.ECBehaviorCamera.Factory.pExposure

pFov

ECPFloat Dragengine.Scenery.ECBehaviorCamera.Factory.pFov

pFovRatio

ECPFloat Dragengine.Scenery.ECBehaviorCamera.Factory.pFovRatio

pHighestIntensity

ECPFloat Dragengine.Scenery.ECBehaviorCamera.Factory.pHighestIntensity

pIgnoreComponents

Array Dragengine.Scenery.ECBehaviorCamera.Factory.pIgnoreComponents

pImageDistance

ECPFloat Dragengine.Scenery.ECBehaviorCamera.Factory.pImageDistance

pLayerMask

LayerMask Dragengine.Scenery.ECBehaviorCamera.Factory.pLayerMask

pLoadCamera

LoadCamera Dragengine.Scenery.ECBehaviorCamera.Factory.pLoadCamera

pLowestIntensity

ECPFloat Dragengine.Scenery.ECBehaviorCamera.Factory.pLowestIntensity

pPathParameters

ECPString Dragengine.Scenery.ECBehaviorCamera.Factory.pPathParameters

pViewDistance

ECPFloat Dragengine.Scenery.ECBehaviorCamera.Factory.pViewDistance

---

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

• ECBehaviorCamera.ds