Class Bone

Bone structure for inverse kinematics interactor.

Hierarchy

Bone

Constructors

constructor

new Bone(path: string, description?: string): Bone
Creates a bone structure. (path) - HeadNode - Head + x-rotation + position (path).e1 - YRotNode - y-rotation (path).e1.e1 - ZRotNode - z-rotation (+ geometry) (path).e1.e1.e1 - TailNode - Tail (path).e1.e1.eX - optional additional nodes
Parameters
- path: string
  
  The path for the head of the bone
- Optional description: string
  
  Name of the bone (e.g. "Bone 1")
Returns Bone
- Defined in IGX.Eval.d.ts:811

Properties

`Private` AddGeometryNode

AddGeometryNode: any

AdditionalNodes

AdditionalNodes: Product[]

sibling nodes to the tail node

`Private` GeometryNode

GeometryNode: any

`Private` GeometryNodes

GeometryNodes: any

HeadNode

HeadNode: Product

head node and node for x-rotation & position (path)

`Private` Path

Path: any

TailNode

TailNode: Product

tail node (path.e1.e1.e1)

YRotNode

YRotNode: Product

node for y-rotation (path.e1)

ZRotNode

ZRotNode: Product

node for z-rotation and geometry (path.e1.e1)

Methods

AddEvaluator

AddEvaluator(evaluator: string, description?: string, offsetPosition?: number[], offsetRotation?: number[], scale?: number[]): number
Adds a sibling node (path.e1.e1.eX) to the tail node (path.e1.e1.e1) and returns it's id (X). You need this id for SetEvaluatorParameters. And you can access the node by Bone.AdditionalNodes[id].

Returns
id of the additional node
Parameters
- evaluator: string
  
  The evaluator to add
- Optional description: string
  
  Description of node
- Optional offsetPosition: number[]
  
  [posX, posY, posZ]
- Optional offsetRotation: number[]
  
  [rotX, rotY, rotZ]
- Optional scale: number[]
  
  [scaX, scaY, scaZ]
Returns number
- Defined in IGX.Eval.d.ts:864

AddNode

AddNode(description?: string, offsetPosition?: number[], offsetRotation?: number[], scale?: number[]): number
Adds a sibling node (path.e1.e1.eX) to the tail node (path.e1.e1.e1) and returns it's id (X). You can access the node by Bone.AdditionalNodes[id].
Parameters
- Optional description: string
  
  Description of node
- Optional offsetPosition: number[]
  
  [posX, posY, posZ]
- Optional offsetRotation: number[]
  
  [rotX, rotY, rotZ]
- Optional scale: number[]
  
  [scaX, scaY, scaZ]
Returns number
- Defined in IGX.Eval.d.ts:882

PushIntoResponse

PushIntoResponse(response: EvalResponse, debug?: boolean): void
Pushes the created nodes into given response object (bones + optional additional nodes). Requires that the response.EvaluatorParameters array is already initialized.
Parameters
- response: EvalResponse
  
  EvalResponse
- Optional debug: boolean
  
  debug logs for evaluator params
Returns void
- Defined in IGX.Eval.d.ts:890

SetBonePosition

SetBonePosition(position: number[]): void
Parameters
- position: number[]
Returns void
- Defined in IGX.Eval.d.ts:812

SetEvaluatorParameters

SetEvaluatorParameters(id: number, params: {
[parameter: string]: any;
}): void
Sets the parameters for the evaluator at a specific node
Parameters
- id: number
  
  id of the additional node
- params: {
  [parameter: string]: any;
  }
  
  evaluator parameters
  - [parameter: string]: any
Returns void
- Defined in IGX.Eval.d.ts:870

SetGeometry

SetGeometry(geometry: string, offsetPos?: number[], offsetRot?: number[], scale?: number[]): number
Sets the geometry of the bone. Must be set first before changing other geometry properties like scale etc.

Returns
-1 if no new node was created, else the id of the additional node
Parameters
- geometry: string
  
  name of the geometry
- Optional offsetPos: number[]
  
  (optional) if set this creates a new node especially for the geometry and moves the geometry to given offset position. [posX, posY, posZ]
- Optional offsetRot: number[]
  
  (optional) if set this creates a new node especially for the geometry and rotates the geometry to given offset rotation. [rotX, rotY, rotZ]
- Optional scale: number[]
  
  (optional) if set this creates a new node especially for the geometry and scales the geometry to given values. [scaX, scaY, scaZ]
Returns number
- Defined in IGX.Eval.d.ts:843

SetGeometryParameters

SetGeometryParameters(params: {
[parameter: string]: any;
}): void
Parameters
- params: {
  [parameter: string]: any;
  }
  - [parameter: string]: any
Returns void
- Defined in IGX.Eval.d.ts:844

SetGeometryScale

SetGeometryScale(scale: number[]): void
Parameters
- scale: number[]
Returns void
- Defined in IGX.Eval.d.ts:847

SetGeometryVisible

SetGeometryVisible(visible: any): void
Parameters
- visible: any
Returns void
- Defined in IGX.Eval.d.ts:848

SetLayer

SetLayer(layer: string): void
Parameters
- layer: string
Returns void
- Defined in IGX.Eval.d.ts:851

SetMapping

SetMapping(mapping: Mapping): void
Parameters
- mapping: Mapping
Returns void
- Defined in IGX.Eval.d.ts:850

SetMaterial

SetMaterial(material: string): void
Parameters
- material: string
Returns void
- Defined in IGX.Eval.d.ts:849

SetRotation

SetRotation(rotation: number[]): void
Sets the initial rotation of the bone.
Parameters
- rotation: number[]
  
  Array(3) with [x, y, z]
Returns void
- Defined in IGX.Eval.d.ts:830

SetTail

SetTail(offset: number, axis?: string): void
Sets the position of the tail
Parameters
- offset: number
  
  length of the bone
- Optional axis: string
  
  if not given this is "z"
Returns void
- Defined in IGX.Eval.d.ts:825

SetTailOffset

SetTailOffset(position: number[]): void
Deprecated
This vector must have a positive number on your chosen axis. The other two direction are set to 0. E.g. z-axis: [0, 0, 1.35]
Parameters
- position: number[]
Returns void
- Defined in IGX.Eval.d.ts:819

Class Bone

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

path: string

Optional description: string

Returns Bone

Properties

Private AddGeometryNode

AdditionalNodes

Private GeometryNode

Private GeometryNodes

HeadNode

Private Path

TailNode

YRotNode

ZRotNode

Methods

AddEvaluator

Returns

Parameters

evaluator: string

Optional description: string

Optional offsetPosition: number[]

Optional offsetRotation: number[]

Optional scale: number[]

Returns number

AddNode

Parameters

Optional description: string

Optional offsetPosition: number[]

Optional offsetRotation: number[]

Optional scale: number[]

Returns number

PushIntoResponse

Parameters

response: EvalResponse

Optional debug: boolean

Returns void

SetBonePosition

Parameters

position: number[]

Returns void

SetEvaluatorParameters

Parameters

id: number

params: { [parameter: string]: any; }

[parameter: string]: any

Returns void

SetGeometry

Returns

Parameters

geometry: string

Optional offsetPos: number[]

Optional offsetRot: number[]

Optional scale: number[]

Returns number

SetGeometryParameters

Parameters

params: { [parameter: string]: any; }

[parameter: string]: any

Returns void

SetGeometryScale

Parameters

scale: number[]

Returns void

SetGeometryVisible

Parameters

visible: any

Returns void

SetLayer

Parameters

layer: string

Returns void

SetMapping

`Optional` description: string

`Private` AddGeometryNode

`Private` GeometryNode

`Private` GeometryNodes

`Private` Path

`Optional` description: string

`Optional` offsetPosition: number[]

`Optional` offsetRotation: number[]

`Optional` scale: number[]

`Optional` description: string

`Optional` offsetPosition: number[]

`Optional` offsetRotation: number[]

`Optional` scale: number[]

`Optional` debug: boolean

params: {
[parameter: string]: any;
}

`Optional` offsetPos: number[]

`Optional` offsetRot: number[]

`Optional` scale: number[]

params: {
[parameter: string]: any;
}

`Optional` axis: string