Drag[en]gine Wiki

This page is read only. You can view the source, but not change it. Ask your administrator if you think this is wrong.
{{tag>motioncapture democap behavior}}
<WRAP youarehere>
[[:start|Start Page]] >> [[main|DEMoCap: Drag[en]gine Motion Capture]] >> [[democap:elementclasses|XML Element Classes]] >> ** ECBHighlightPointedAt **
</WRAP>

====== ECBHighlightPointedAt ======

Behavior adding support to highlight element if pointed at by the user. Uses [[dragengine:modules:dragonscript:behavior_outline|ECBehaviorOutline]] to do the highlighting in response to [[dragengine:modules:dragonscript:behavior_vrhandpointedat|ECBehaviorVRHandPointedAt]] events.

====== Instance Counts ======

This behavior can be used only once on an element.

====== Element Class Properties ======

Element class properties have the prefix ''highlightPointedAt.''.

===== outline(highlightPointedAt).* =====

Set properties of [[dragengine:modules:dragonscript:behavior_outline|ECBehaviorOutline]] behavior added by this behavior. use property prefix ''myBehavior.outline(highlightPointedAt).'' for these properties.

Sets these default values:

  * ''myBehavior.outline(highlightPointedAt).skin'' = ''/content/materials/outline/outlinePointAt.deskin'''

====== Events ======

This behavior has no events.

====== Conversation Commands ======

This behavior adds no conversation commands.

====== Conversation Conditions ======

This behavior adds no conversation conditions.

====== Behavior Tree Actions ======

This behavior adds no behavior tree actions.

====== Behavior Tree Conditions ======

This behavior adds no behavior tree conditions.

====== Required Behaviors ======

  * [[dragengine:modules:dragonscript:behavior_component|ECBehaviorComponent]]
  * [[dragengine:modules:dragonscript:behavior_collider|ECBehaviorCollider]]
  * [[dragengine:modules:dragonscript:behavior_vrhandpointedat|ECBehaviorVRHandPointedAt]]

====== Optional Behaviors ======

This behavior does not support optional behaviors.

====== API Documentation ======

Since DEMoCap Version ''1.3''

====== Use Cases ======

  * Highlight object if pointed at by actor.

====== Element Class Example ======

<code>
class MyElement extends BehaviorElementClass
  public var ECBehaviorComponent component
  public var ECBehaviorCollider collider
  public var ECBehaviorVRHandPointedAt vrHandPointedAt
  public var ECBHighlightPointedAt highlightPointedAt
  func new()
    component = ECBehaviorComponent.new(this, null)
    collider = ECBehaviorCollider.new(this, component)
    vrHandPointedAt = ECBehaviorVRHandPointedAt.new(this)
    highlightPointedAt = ECBHighlightPointedAt.new(this, component, collider, vrHandPointedAt)
  end
end
</code>

====== Behavior Factory ======

Using element class supporting adding behaviors the behavior can be added like this (again create an example which creates a valid element class):

<code xml>
<?xml version='1.0' encoding='UTF-8'?>
<elementClass name='MyClass' class='GenericBehaviorElement'>
  <behavior type='ECBehaviorComponent'/>
  <behavior type='ECBehaviorCollider'/>
  <behavior type='ECBehaviorVRHandPointedAt'/>
  
  <behavior type='ECBHighlightPointedAt'>
    <!-- optional: use component with id instead of empty string -->
    <string name='component'>second</string>
    
    <!-- set element properties. omit property prefix if used inside behavior tag -->
    <string name='.outline(highlightPointedAt).skin'>/content/materials/outline/outlinePointAt.deskin</string>
  </behavior>
</elementClass>
</code>

====== Live Examples ======
Drag[en]gine Wiki

User Tools

Site Tools

Page Tools
