API

Interface FBXConstraintData

A constraint object of the file, with its targets and parameters resolved.

interface FBXConstraintData {
    active: boolean;
    affectRotation: Bool3;
    affectScale: Bool3;
    affectTranslation: Bool3;
    aimVector: Vec3;
    id: number;
    ikEffectorId?: number;
    ikEndJointId?: number;
    ikFirstJointId?: number;
    ikPoleVector: Vec3;
    name: string;
    nodeId?: number;
    offsetRotation: Vec3;
    offsetScale: Vec3;
    offsetTranslation: Vec3;
    targets: FBXConstraintTarget[];
    type: FBXConstraintType;
    typeName: string;
    upVector: Vec3;
    weight: number;
    worldUpNodeId?: number;
    worldUpType: number;
    worldUpVector: Vec3;
}
Index
active: boolean

False when the constraint is switched off in the file

affectRotation: Bool3

Which rotation axes the constraint drives

affectScale: Bool3

Which scale axes the constraint drives

affectTranslation: Bool3

Which translation axes the constraint drives

aimVector: Vec3

Aim: local axis that points at the target

id: number

Constraint object id

ikEffectorId?: number

Single chain IK: model id of the effector

ikEndJointId?: number

Single chain IK: model id of the last joint of the chain

ikFirstJointId?: number

Single chain IK: model id of the first joint of the chain

ikPoleVector: Vec3

Single chain IK: pole vector

name: string

Constraint name

nodeId?: number

Constrained model

offsetRotation: Vec3

Rotation offset of the constrained node, in degrees

offsetScale: Vec3

Scale offset of the constrained node

offsetTranslation: Vec3

Translation offset of the constrained node

Weighted targets in file order

Resolved constraint kind

typeName: string

Constraint type name as written in the file (e.g. "Parent-Child")

upVector: Vec3

Aim: local axis aligned with the up direction

weight: number

Global weight (file value / 100)

worldUpNodeId?: number

Aim: model id of the world up object (world up modes 1 and 2)

worldUpType: number

Aim: 0 scene up, 1 aim up node, 2 align to node, 3 vector, 4 none

worldUpVector: Vec3

Aim: world up direction (world up modes 2 and 3)