Drag[en]gine Script Module DragonScript  1.23
Dragengine.Scenery.ECBehaviorRenderableCamera Class Reference

Behavior element behavior adding a camera renderable. More...

Inheritance diagram for Dragengine.Scenery.ECBehaviorRenderableCamera:
Dragengine.Scenery.DefaultECBehavior Dragengine.Scenery.ECBehavior Dragengine.Scenery.BehaviorCompatiblePersistency

Classes

class  Instance
 Behavior instance. More...
 

Public Member Functions

ECBehaviorInstance createInstance (BehaviorElement element)
 Create Behavior instance. More...
 
void dispose ()
 Dispose of behavior. More...
 
ECBehaviorCamera getCamera ()
 Camera behavior. More...
 
ECBehaviorDynamicSkin getDynamicSkin ()
 Dynamic skin behavior. More...
 
ECPString getRenderable ()
 Name of renderable to create or empty string if not used. More...
 
Instance instance (BehaviorElement element)
 Get instance in element from owner element class. More...
 
ECBehaviorRenderableCamera new (BehaviorElementClass eclass, ECBehaviorDynamicSkin dynamicSkin, ECBehaviorCamera camera)
 Create behavior element class. More...
 
ECBehaviorRenderableCamera new (BehaviorElementClass eclass, ECBehaviorDynamicSkin dynamicSkin, ECBehaviorCamera camera, String id)
 Create behavior element class. More...
 
ECBehaviorRenderableCamera new (BehaviorElementClass eclass, ECBehaviorDynamicSkin dynamicSkin, ECBehaviorCamera camera, 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 ECBehaviorRenderableCamera getBehaviorIn (BehaviorElementClass eclass)
 Get behavior in element class or null if absent. More...
 
static ECBehaviorRenderableCamera 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 a camera renderable.

To use this behavior add an ECBehaviorDynamicSkin to the element class before adding this behavior. Create ECBehaviorRenderableCamera behavior and set the dynamic skin and camera. Now you can add other behaviors targeting the ECBehaviorRenderableCamera to alter the renderable if desired.

Using a camera renderable or a canvas renderable with a render world canvas behaves differently. A render world canvas sets a fixed render size and allows to embed the camera view into other canvas to create elaborate results. A camera renderable does not force a specific render size. The graphic module is free to choose a resolution or to render the camera renderable directly. Render world canvas always renders into an image that can be reused. Camera renderables are usually more efficient and have better resolution since these requirements are not needed. On the other hand camera renderables prevent them to be embedded into canvas views. You need to use camera effects to add overlays or other manipulations. Nevertheless using camera renderable is faster and higher resolution and should be used unless complex canvas processing effects are required.

By default the ECBehaviorCamera with empty identifier is used if present. Use setCameraID() to change the identifier.

Multiple ECBehaviorRenderableCamera instances can be added to affect individual dynamic skin textures. The example below uses one component with one dynamic skin to two individual renderables named "camera1" and "camera2" each showing a different camera view.

class MyElement extends BehaviorElementClass
public func new()
var ECBehaviorComponent component = ECBehaviorComponent.new(this, null)
var ECBehaviorCollider collider = ECBehaviorCollider.new(this, component)
var DynamicSkin dynamicSkin = ECBehaviorDynamicSkin.new(this, component)
var ECBehaviorCamera camera1 = ECBehaviorCamera.new(this, collider, "camera1")
var ECBehaviorCamera camera2 = ECBehaviorCamera.new(this, collider, "camera2")
var ECBehaviorRenderableCamera behavior = ECBehaviorRenderableCamera.new(this, dynamicSkin, camera1)
behavior.getRenderable().setValue("camera1")
behavior = ECBehaviorRenderableCamera.new(this, dynamicSkin, camera2, "renderableCamera2")
behavior.getRenderable().setValue("camera2")
end
end
ECBehaviorRenderableCamera new(BehaviorElementClass eclass, ECBehaviorDynamicSkin dynamicSkin, ECBehaviorCamera camera)
Create behavior element class.
ECPString getRenderable()
Name of renderable to create or empty string if not used.

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

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

Member Function Documentation

◆ createInstance()

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

Create Behavior instance.

Implements Dragengine.Scenery.ECBehavior.

◆ dispose()

void Dragengine.Scenery.ECBehaviorRenderableCamera.dispose ( )

Dispose of behavior.

Reimplemented from Dragengine.Scenery.DefaultECBehavior.

◆ getAllBehaviorsIn()

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

Get list of all behaviors in element.

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

◆ getAllInstancesIn()

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

Get list of all instances in element.

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

◆ getBehaviorIn() [1/2]

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

◆ getCamera()

ECBehaviorCamera Dragengine.Scenery.ECBehaviorRenderableCamera.getCamera ( )

Camera behavior.

◆ getDynamicSkin()

ECBehaviorDynamicSkin Dragengine.Scenery.ECBehaviorRenderableCamera.getDynamicSkin ( )

Dynamic skin behavior.

◆ getInstanceIn() [1/2]

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

◆ getInstanceIn() [2/2]

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

◆ getRenderable()

ECPString Dragengine.Scenery.ECBehaviorRenderableCamera.getRenderable ( )

Name of renderable to create or empty string if not used.

◆ instance()

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

Get instance in element from owner element class.

◆ new() [1/3]

ECBehaviorRenderableCamera Dragengine.Scenery.ECBehaviorRenderableCamera.new ( BehaviorElementClass  eclass,
ECBehaviorDynamicSkin  dynamicSkin,
ECBehaviorCamera  camera 
)

Create behavior element class.

◆ new() [2/3]

ECBehaviorRenderableCamera Dragengine.Scenery.ECBehaviorRenderableCamera.new ( BehaviorElementClass  eclass,
ECBehaviorDynamicSkin  dynamicSkin,
ECBehaviorCamera  camera,
String  id 
)

Create behavior element class.

◆ new() [3/3]

ECBehaviorRenderableCamera Dragengine.Scenery.ECBehaviorRenderableCamera.new ( BehaviorElementClass  eclass,
ECBehaviorDynamicSkin  dynamicSkin,
ECBehaviorCamera  camera,
String  id,
String  prefix 
)

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