User Tools

Site Tools


dragengine:modules:dragonscript:behavior_vrhand

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revisionPrevious revision
dragengine:modules:dragonscript:behavior_vrhand [2024/03/14 16:57] dragonlorddragengine:modules:dragonscript:behavior_vrhand [2025/03/12 22:29] (current) dragonlord
Line 24: Line 24:
 ====== Element Class Properties ====== ====== Element Class Properties ======
  
-Element class properties have the prefix **vrHand.** or **vrHand(id).** if id is not empty.+Element class properties have the prefix ''vrHand.'' or ''vrHand(id).'' if id is not empty.
  
 ===== useVendorModel ===== ===== useVendorModel =====
-Determines if the Vendor Specific 3D Model is used to show the device. The Vendor Specific 3D Model is provided by the VR Runtime installation. If set to false **vrHand(id).component.* ** properties can be used to define the model to use. +Determines if the Vendor Specific 3D Model is used to show the device. The Vendor Specific 3D Model is provided by the VR Runtime installation. If set to false ''vrHand(id).component.*'' properties can be used to define the model to use. 
-  * Full name: "vrHand.useVendorModelor "vrHand(id).useVendorModel"+  * Full name: ''vrHand.useVendorModel'' or ''vrHand(id).useVendorModel''
   * Type: boolean   * Type: boolean
-  * Default Value: true+  * Default Value: ''true''
   * Example (*.deeclass): <code xml><boolean name='vrHand(right).useVendorModel'>false</boolean></code>   * Example (*.deeclass): <code xml><boolean name='vrHand(right).useVendorModel'>false</boolean></code>
  
 ===== showHand ===== ===== showHand =====
 Determines if the device is shown in the 3D view. Set this to true if you use a separate model to show the hands. Set to false if you use the regular animated actor support to animate the hands using the hand position and orientation as input. Determines if the device is shown in the 3D view. Set this to true if you use a separate model to show the hands. Set to false if you use the regular animated actor support to animate the hands using the hand position and orientation as input.
-  * Full name: "vrHand.showHandor "vrHand(id).showHand"+  * Full name: ''vrHand.showHand'' or ''vrHand(id).showHand''
   * Type: boolean   * Type: boolean
-  * Default value: true+  * Default value: ''true''
   * Example (*.deeclass): <code xml><boolean name='vrHand(left).showHand'>false</boolean></code>   * Example (*.deeclass): <code xml><boolean name='vrHand(left).showHand'>false</boolean></code>
  
 ===== component.* ===== ===== component.* =====
-This behavior adds a child [[behavior_component|ECBehaviorComponent]] to the element class to show the hand in the game world. The child behavior has the identifier "vrHand" or "vrHand(id)". The child behavior has the element class property prefix "vrHand.component." or "vrHand(id).component.". 
  
-Hence to set for example the component model of the right hand use the element class property "vrHand(right).component.model"+This behavior adds a child [[behavior_component|ECBehaviorComponent]] to the element class to show the hand in the game world. The child behavior has the identifier ''vrHand'' or ''vrHand(id)''. The child behavior has the element class property prefix ''vrHand.component.'' or ''vrHand(id).component.''
 + 
 +Hence to set for example the component model of the right hand use the element class property ''vrHand(right).component.model''
 + 
 +====== Events ====== 
 + 
 +===== controllerAttached ===== 
 + 
 +Hand controller attached and ready to use. 
 + 
 +===== controllerDetached ===== 
 + 
 +Hand controller detached and no more usable.
  
 ====== Required Behaviors ====== ====== Required Behaviors ======
Line 61: Line 72:
 #@LinkApiDocDEDS2_HTML~classDragengine_1_1Scenery_1_1ECBehaviorVRHand.html,ECBehaviorVRHand~@#. #@LinkApiDocDEDS2_HTML~classDragengine_1_1Scenery_1_1ECBehaviorVRHand.html,ECBehaviorVRHand~@#.
  
-Since DragonScript Module Version **1.6**+Since DragonScript Module Version ''1.6''
  
 ====== Use Cases ====== ====== Use Cases ======
Line 73: Line 84:
 <code> <code>
 class MyElement extends BehaviorElementClass class MyElement extends BehaviorElementClass
-  public func new()+  func new()
     // Add VR Playspace behavior. Base behavior required by all VR behaviors     // Add VR Playspace behavior. Base behavior required by all VR behaviors
     var ECBehaviorVRPlayspace vrPlayspace = ECBehaviorVRPlayspace.new(this)     var ECBehaviorVRPlayspace vrPlayspace = ECBehaviorVRPlayspace.new(this)
Line 87: Line 98:
   end   end
 end end
 +</code>
 +
 +====== Behavior Factory ======
 +
 +Using element class supporting adding behaviors the behavior can be added like this:
 +<code xml>
 +<?xml version='1.0' encoding='UTF-8'?>
 +<elementClass name='MyClass' class='GenericBehaviorElement'>
 +  <behavior type='ECBehaviorVRPlayspace'/>
 +  <behavior type='ECBehaviorVRHMD'/>
 +  
 +  <behavior type='ECBehaviorVRHand' id='right'>
 +    <!-- required: use BaseGameApp input device type. Constant of InputDeviceType.
 +                   use either 'vrRightHand' or 'vrLeftHand'. -->
 +    <string name='inputDeviceType'>vrRightHand</string>
 +    
 +    <!-- optional: use BaseGameApp binding manager. game can add more supported values.
 +                   default is 'default' -->
 +    <string name='bindingManager'>default</string>
 +    
 +    <!-- optional: set collision filter. default value '' which means empty category
 +                   and full filter. format is '', 'category' or 'category:filter'
 +                   where category and filter are a list of bits to set. -->
 +    <string name='collisionFilter'>6:0 1 2 3 5</string>
 +    
 +    <!-- set element properties. omit property prefix if used inside behavior tag -->
 +    <boolean name='.useVendorModel'>true</boolean>
 +  </behavior>
 +  
 +  <behavior type='ECBehaviorVRHand' id='left'>
 +    ...
 +  </behavior>
 +</elementClass>
 </code> </code>
  
dragengine/modules/dragonscript/behavior_vrhand.txt · Last modified: 2025/03/12 22:29 by dragonlord