dragengine:modules:dragonscript:behavior_actorik
Differences
This shows you the differences between two versions of the page.
| Both sides previous revisionPrevious revisionNext revision | Previous revision | ||
| dragengine:modules:dragonscript:behavior_actorik [2020/06/01 11:36] – [Element Class Example] dragonlord | dragengine:modules:dragonscript:behavior_actorik [2025/06/23 16:14] (current) – [Element Class Example] dragonlord | ||
|---|---|---|---|
| Line 1: | Line 1: | ||
| {{tag> | {{tag> | ||
| <WRAP youarehere> | <WRAP youarehere> | ||
| - | [[: | + | [[: |
| </ | </ | ||
| Line 16: | Line 16: | ||
| [[behavior_component|ECBehaviorComponent]]. | [[behavior_component|ECBehaviorComponent]]. | ||
| - | The behavior supports | + | The behavior supports |
| The **IK Position Controller** is used to set position of the target relative to the component assigned to the animator. The position is assigned as //vector value//. | The **IK Position Controller** is used to set position of the target relative to the component assigned to the animator. The position is assigned as //vector value//. | ||
| Line 22: | Line 22: | ||
| The **IK Rotation Controller** is used to set orientation of the target relative to the component assigned to the animator. The orientation is assigned as //vector value//. | The **IK Rotation Controller** is used to set orientation of the target relative to the component assigned to the animator. The orientation is assigned as //vector value//. | ||
| - | The **IK Height Controller** is used to set the height of the target above the ground. This is the same value as //position.getY()// | + | The **IK Height Controller** is used to set the height of the target above the ground. This is the same value as '' |
| allows to fine tune animators to different target heights above ground. To get the best results you usually have to use an animation for reaching at objects in upright and crouched position. Using this controller you can blend between such animations. | allows to fine tune animators to different target heights above ground. To get the best results you usually have to use an animation for reaching at objects in upright and crouched position. Using this controller you can blend between such animations. | ||
| + | |||
| + | The **IK Pan Controller** is used to set the left-right position of the target. This is the same value as '' | ||
| + | |||
| + | The **IK Distance Controller** is used to set the forward-backward position of the target. This is the same value as '' | ||
| + | |||
| + | The **IK Azimuth Controller** is used to set the left-right rotation of the target. This is the same value as '' | ||
| + | |||
| + | The **IK Elevation Controller** is used to set the up-down rotation of the target. This is the same value as '' | ||
| ====== Instance Counts ====== | ====== Instance Counts ====== | ||
| Line 31: | Line 39: | ||
| ====== Element Class Properties ====== | ====== Element Class Properties ====== | ||
| - | Element class properties have the prefix | + | Element class properties have the prefix |
| ===== controllerIKPosition ===== | ===== controllerIKPosition ===== | ||
| - | Name of the controller to assign IK Position | + | Name of the controller to assign IK position |
| - | * Full name: "actorIK.controllerIKPosition" | + | * Full name: '' |
| * Type string | * Type string | ||
| - | * Default Value //ik.position// | + | * Default Value '' |
| * Example (*.deeclass) <code xml>< | * Example (*.deeclass) <code xml>< | ||
| ===== controllerIKRotation ===== | ===== controllerIKRotation ===== | ||
| - | Name of the controller to assign IK Rotatio | + | Name of the controller to assign IK rotation |
| - | * Full name: "actorIK.controllerIKRotation" | + | * Full name: '' |
| * Type string | * Type string | ||
| - | * Default Value //ik.rotation// | + | * Default Value '' |
| * Example (*.deeclass) <code xml>< | * Example (*.deeclass) <code xml>< | ||
| ===== controllerIKHeight ===== | ===== controllerIKHeight ===== | ||
| - | Name of the controller to assign IK Height | + | Name of the controller to assign IK height (Y axis position) |
| - | * Full name: "actorIK.controllerIKHeight" | + | * Full name: '' |
| * Type string | * Type string | ||
| - | * Default Value //ik.height// | + | * Default Value '' |
| * Example (*.deeclass) <code xml>< | * Example (*.deeclass) <code xml>< | ||
| + | |||
| + | ===== controllerIKPan ===== | ||
| + | Name of the controller to assign IK pan (X axis position) to using //value//. If the controller is not found it is ignored. | ||
| + | * Full name: '' | ||
| + | * Type string | ||
| + | * Default Value '' | ||
| + | * Example (*.deeclass) <code xml>< | ||
| + | |||
| + | ===== controllerIKDistance ===== | ||
| + | Name of the controller to assign IK distance (Z axis position) to using //value//. If the controller is not found it is ignored. | ||
| + | * Full name: '' | ||
| + | * Type string | ||
| + | * Default Value '' | ||
| + | * Example (*.deeclass) <code xml>< | ||
| + | |||
| + | ===== controllerIKAzimuth ===== | ||
| + | Name of the controller to assign IK azimuth (Y axis rotation) to using //value//. If the controller is not found it is ignored. | ||
| + | * Full name: '' | ||
| + | * Type string | ||
| + | * Default Value '' | ||
| + | * Example (*.deeclass) <code xml>< | ||
| + | |||
| + | ===== controllerIKElevation ===== | ||
| + | Name of the controller to assign IK elevation (X axis rotation) to using //value//. If the controller is not found it is ignored. | ||
| + | * Full name: '' | ||
| + | * Type string | ||
| + | * Default Value '' | ||
| + | * Example (*.deeclass) <code xml>< | ||
| + | |||
| + | ====== Events ====== | ||
| + | |||
| + | This behavior has no events. | ||
| ====== Required Behaviors ====== | ====== Required Behaviors ====== | ||
| Line 61: | Line 101: | ||
| ====== Persistency ====== | ====== Persistency ====== | ||
| - | This behavior | + | This behavior |
| - | * Enabled | + | |
| - | * Target Matrix | + | |
| - | * Target Element | + | |
| - | * Target Bone | + | |
| ====== API Documentation ====== | ====== API Documentation ====== | ||
| - | [[https:// | + | # |
| - | Since DragonScript Module Version | + | Since DragonScript Module Version |
| ====== Use Cases ====== | ====== Use Cases ====== | ||
| Line 83: | Line 119: | ||
| | | ||
| - | public | + | func new() super(" |
| // the base actor class creates an actor animated behavior we can use | // the base actor class creates an actor animated behavior we can use | ||
| Line 98: | Line 134: | ||
| | | ||
| - | public | + | func new() |
| end | end | ||
| Line 109: | Line 145: | ||
| // enable IK while this action is assigned to an actor then disable it again. | // enable IK while this action is assigned to an actor then disable it again. | ||
| // using disable() instead of setEnabled(false) also clears the target | // using disable() instead of setEnabled(false) also clears the target | ||
| - | public | + | func void activate() |
| super.activate() | super.activate() | ||
| actorIK.setTarget(targetElementToTouch) | actorIK.setTarget(targetElementToTouch) | ||
| Line 115: | Line 151: | ||
| end | end | ||
| - | public | + | func void deactivate() |
| actorIK.disable() | actorIK.disable() | ||
| super.deactivate() | super.deactivate() | ||
| Line 130: | Line 166: | ||
| | | ||
| - | public | + | func new() super(" |
| // the base actor class creates an actor animated behavior we can use | // the base actor class creates an actor animated behavior we can use | ||
| Line 154: | Line 190: | ||
| | | ||
| - | public | + | func new() |
| end | end | ||
| Line 169: | Line 205: | ||
| // from the point of view of the element. the target position is always | // from the point of view of the element. the target position is always | ||
| // relative to the target element. | // relative to the target element. | ||
| - | public | + | func void activate() |
| super.activate() | super.activate() | ||
| | | ||
| Line 181: | Line 217: | ||
| end | end | ||
| - | public | + | func void deactivate() |
| actorIKLeft.disable() | actorIKLeft.disable() | ||
| actorIKRight.disable() | actorIKRight.disable() | ||
| Line 188: | Line 224: | ||
| end | end | ||
| </ | </ | ||
| + | |||
| + | ====== Behavior Factory ====== | ||
| + | |||
| + | Using element class supporting adding behaviors the behavior can be added like this: | ||
| + | <code xml> | ||
| + | <?xml version=' | ||
| + | < | ||
| + | < | ||
| + | < | ||
| + | < | ||
| + | | ||
| + | < | ||
| + | <!-- optional: use actor animated with id instead of empty string --> | ||
| + | <string name=' | ||
| + | | ||
| + | <!-- set element properties. omit property prefix if used inside behavior tag --> | ||
| + | <string name=' | ||
| + | <string name=' | ||
| + | </ | ||
| + | | ||
| + | <!-- for adding multiple behaviors use unique identifiers --> | ||
| + | < | ||
| + | </ | ||
| + | </ | ||
| + | |||
| + | ====== Live Examples ====== | ||
| + | |||
| + | * [[https:// | ||
| + | |||
dragengine/modules/dragonscript/behavior_actorik.1591011415.txt.gz · Last modified: 2020/06/01 11:36 by dragonlord
Page Tools
Except where otherwise noted, content on this wiki is licensed under the following license: CC Attribution-Noncommercial-Share Alike 4.0 International
