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

Behavior adding support to VR hand action to control desktops. More...

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

Classes

class  Instance
 Behavior instance. More...
 

Public Member Functions

void dispose ()
 Dispose of behavior. More...
 
ECBehaviorVRHandPointAt getPointAt ()
 VR Hand point at behavior or null. More...
 
Instance instance (BehaviorElement element)
 Get instance in element from owner element class. More...
 
ECBehaviorVRControlDesktop new (BehaviorElementClass eclass, ECBehaviorVRHandPointAt pointAt)
 Create behavior element class. More...
 
ECBehaviorVRControlDesktop new (BehaviorElementClass eclass, ECBehaviorVRHandPointAt pointAt, String id)
 Create behavior element class. More...
 
ECBehaviorVRControlDesktop new (BehaviorElementClass eclass, ECBehaviorVRHandPointAt pointAt, String id, String prefix)
 Create behavior element class. 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...
 
- Public Member Functions inherited from Dragengine.Scenery.ECBehavior
ECBehaviorInstance createInstance (BehaviorElement element)
 Create Behavior instance. More...
 

Static Public Member Functions

static ECBehaviorVRControlDesktop getBehaviorIn (BehaviorElementClass eclass)
 Get behavior in element class 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 adding support to VR hand action to control desktops.

Version
1.12

To be used with BaseVRHandAction subclasses. Tracks ECBehaviorVRHandPointAt. If an element is pointed at that supports ECBehaviorControlDesktop moves the mouse pointer and uses trigger pulling to simulate mouse click. Each hand can individually interact with different ECBehaviorControlDesktop. Hand action has to call pointAt(), pointAtPull() and pointAtRelease() to interact.

Requires these behaviors:

Element class property prefix is "vrControlDesktop." or "vrControlDesktop(id).".

Example usage:

class MyHandAction extends BaseVRHandAction implements BAAVRTriggerInput
protected var ECBehaviorVRControlDesktop.Instance controlDesktop
// Create action.
public func new()
end
// Init behaviors. This stores aside the behavior matching the VR hand this action belongs to.
protected func void initBehaviors()
super.initBehaviors()
if vrHand.getECBehavior().getID().equals(BaseVRActorClass.idVRRightHand)
controlDesktop = ECBehaviorVRControlDesktop.getInstanceIn(actor, BaseVRActorClass.idVRRightHand)
else
controlDesktop = ECBehaviorVRControlDesktop.getInstanceIn(actor, BaseVRActorClass.idVRLeftHand)
end
end
// Activate hand behavior. Enable hand point at to enable controlling desktops.
public func void activate(BehaviorElement actor, ECBehaviorVRHand.Instance vrHand)
super.activate(actor, vrHand)
handPointAt.setEnabled(true)
end
// Deactivate hand behavior. Disable hand point at and stop interacting with desktop.
// Do not stop interacting here if you want to switch to another action that should
// keep on using the desktop.
public func void deactivate()
controlDesktop.pointAtRelease()
handPointAt.setEnabled(false)
super.deactivate()
end
// Frame update. Interact with control desktop if pointed at. The if check allows
// to test various possible interactions stopping at the first one that works.
// Make sure super.think(elapsed) is alway called even if exiting early
public func void think(float elapsed)
if controlDesktop.pointAt()
super.think(elapsed)
return
end
// Here you could test for other possible interactions
super.think(elapsed)
end
// Events by BAAVRTriggerInput we do not use for this example but have to be declared.
public func void triggerTouch()
end
public func void triggerUntouch()
end
public func void triggerAnalog(float value)
end
// Trigger is pulled. Sends left mouse press to desktop if one is controlled.
// The if check allows to test various possible interactions stopping at the
// first one that works.
public func void triggerPull()
if controlDesktop.pointAtPull()
return
end
// Here you could test for other possible interactions
end
// Trigger has been released. Sends left mouse release to desktop if one is
// controlled. // The if check allows to test various possible interactions
// stopping at the first one that works.
public func void triggerRelease()
if controlDesktop.pointAtRelease()
return
end
end
end
ECBehaviorVRControlDesktop new(BehaviorElementClass eclass, ECBehaviorVRHandPointAt pointAt)
Create behavior element class.

Member Function Documentation

◆ dispose()

void Dragengine.Scenery.ECBehaviorVRControlDesktop.dispose ( )

Dispose of behavior.

Reimplemented from Dragengine.Scenery.DefaultECBehavior.

◆ getBehaviorIn()

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

◆ getPointAt()

ECBehaviorVRHandPointAt Dragengine.Scenery.ECBehaviorVRControlDesktop.getPointAt ( )

VR Hand point at behavior or null.

◆ instance()

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

Get instance in element from owner element class.

◆ new() [1/3]

ECBehaviorVRControlDesktop Dragengine.Scenery.ECBehaviorVRControlDesktop.new ( BehaviorElementClass  eclass,
ECBehaviorVRHandPointAt  pointAt 
)

Create behavior element class.

◆ new() [2/3]

ECBehaviorVRControlDesktop Dragengine.Scenery.ECBehaviorVRControlDesktop.new ( BehaviorElementClass  eclass,
ECBehaviorVRHandPointAt  pointAt,
String  id 
)

Create behavior element class.

◆ new() [3/3]

ECBehaviorVRControlDesktop Dragengine.Scenery.ECBehaviorVRControlDesktop.new ( BehaviorElementClass  eclass,
ECBehaviorVRHandPointAt  pointAt,
String  id,
String  prefix 
)

Create behavior element class.


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