r3constructor

r3constructor

Class

real/objects/r3constructor.h

Library

r3obj

Description:

Constructor object.

See Also

real/objects/r3level.h

Super Class

r3Level

R3CLID_LEVEL

JavaScript

r3Constructor

Class Identifier

R3CLID_CONSTRUCTOR - 1810

Methods

TRANSFORMATTR, RECONSTRUCT, ENUMTARGETATT, DORECONSTRUCT, DEFORMTARGETP, PREPARE, RELEASE, ENUMTARGETPNU, ENUMTARGETOBJ, NEWCHOR, DELCHOR, ENUMTARGETPOI, BIND, BINDSIBLINGS, UNBINDSIBLING, BEGIN, END, BINDOBJ, UNBINDOBJ,

Attributes

Enabled, Target, Animator,

R3CONSTRUCTORM_TRANSFORMATTR

Method

TRANSFORMATTR

Identifier

R3CONSTRUCTORM_TRANSFORMATTR

Return

R3BOOL, the super class returns FALSE if the object is disabled (R3CONSTRUCTORA_Enabled=FALSE) * in which case the derived classes should not touch the target attribute.

Param 1:

R3OBJ*, target object

Param 3:

void*, attribute channel buffer.

JavaScript

rc = obj.TRANSFORMATTR(p1, p3);

Description

Transform the given target attribute.

R3CONSTRUCTORM_RECONSTRUCT

Method

RECONSTRUCT

Identifier

R3CONSTRUCTORM_RECONSTRUCT

JavaScript

obj.RECONSTRUCT();

Description

Run reconstruction. This method is typically called from R3MM_CHANGED, R3PRIMM_SIBLINGCHANGED or R3PRIMM_CHILDCHANGED depending on the constructor.

R3CONSTRUCTORM_ENUMTARGETATT

Method

ENUMTARGETATT

Identifier

R3CONSTRUCTORM_ENUMTARGETATT

Return

R3INT, true if attribute was defined.

Param 1:

R3OBJ*, object to be called

Param 2:

R3INT, callback method

Param 3:

R3INT, attribute to be passed to the callback method.

JavaScript

rc = obj.ENUMTARGETATT(p1, p2, p3);

Description

Call the given object with given attribute.

R3CONSTRUCTORM_DORECONSTRUCT

Method

DORECONSTRUCT

Identifier

R3CONSTRUCTORM_DORECONSTRUCT

JavaScript

obj.DORECONSTRUCT();

Description

Private: optimized reconstruction. Call R3CONSTRUCTORM_RECONSTRUCT to ask the reconstruction.

R3CONSTRUCTORM_DEFORMTARGETP

Method

DEFORMTARGETP

Identifier

R3CONSTRUCTORM_DEFORMTARGETP

Param 1:

R3OBJ*, constructor object to be called

Param 2:

R3INT, callback method for the constructor object

Param 3:

void*, callback data

JavaScript

obj.DEFORMTARGETP(p1, p2, p3);

Description

Recursively enumerate target points for a given constructor. If the constructor's callback method returns TRUE, the point in question is assigned back to object by calling R3PRIMM_SETPOINT. This method is typically used by deformators.

R3CONSTRUCTORM_PREPARE

Method

PREPARE

Identifier

R3CONSTRUCTORM_PREPARE

Return

R3BOOL, true if succeeded

Param 1:

R3INT, tag

Param 2:

R3INT, index

JavaScript

rc = obj.PREPARE(p1, p2, 0);

Description

Restore given attribute. This executes internal 'restore origval ' * constructor.

R3CONSTRUCTORM_RELEASE

Method

RELEASE

Identifier

R3CONSTRUCTORM_RELEASE

Return

R3BOOL, true if succeeded

Param 1:

R3INT, tag

Param 2:

R3INT, index

JavaScript

rc = obj.RELEASE(p1, p2, 0);

Description

Detach the constructor from the target objects.

R3CONSTRUCTORM_ENUMTARGETPNU

Method

ENUMTARGETPNU

Identifier

R3CONSTRUCTORM_ENUMTARGETPNU

Return

R3BOOL, true if object handled.

Param 1:

R3OBJ*, callback object

Param 2:

R3INT*, callback method

JavaScript

rc = obj.ENUMTARGETPNU(p1, p2, 0);

Description

Enumerate geometric points, associated surface normals and uvw coordinates from the target objects. It is up to sub classes to implement this method. Some geometric classes may not support uvw coordinates or surface normals, in which case NULL should be passed in corresponding parameter. Callback is called as: R3DoA3(callbackobj, callbackmth, obj, index, p_n_uvw); where R3VECTOR *p_n_uvw[3]; p_n_uvw[0] = &vertex; p_n_uvw[1] = &normal; p_n_uvw[2] = &uvw;

R3CONSTRUCTORM_ENUMTARGETOBJ

Method

ENUMTARGETOBJ

Identifier

R3CONSTRUCTORM_ENUMTARGETOBJ

Return

R3BOOL, return value from the constructors callback method

Param 1:

R3OBJ*, callback object

Param 2:

R3INT, callback method

Param 3:

void*, callback data

JavaScript

rc = obj.ENUMTARGETOBJ(p1, p2, p3);

Description

Enum target objects for the constructor.

R3CONSTRUCTORM_NEWCHOR

Method

NEWCHOR

Identifier

R3CONSTRUCTORM_NEWCHOR

Return

R3OBJ*, chor object for the target object

Param 1:

R3INT, attribute

Param 3:

R3INT, attribute index (-1 if regular attribute)

JavaScript

rc = obj.NEWCHOR(p1, p3);

Description

Callback method for creating the chor. associated with the constructor

R3CONSTRUCTORM_DELCHOR

Method

DELCHOR

Identifier

R3CONSTRUCTORM_DELCHOR

Return

R3BOOL, true if succeeded

JavaScript

rc = obj.DELCHOR();

Description

Callback method for deleting chor objects associated with the constructors.

R3CONSTRUCTORM_ENUMTARGETPOI

Method

ENUMTARGETPOI

Identifier

R3CONSTRUCTORM_ENUMTARGETPOI

Param 1:

R3OBJ*, constructor object to be called

Param 2:

R3INT, callback method for the constructor object

Param 3:

void*, callback data

JavaScript

obj.ENUMTARGETPOI(p1, p2, p3);

Description

Recursively enumerate target points for a given constructor.

R3CONSTRUCTORM_BIND

Method

BIND

Identifier

R3CONSTRUCTORM_BIND

Return

R3BOOL, true if succeeded

Param 1:

R3BOOL, recursive

Param 3:

R3OBJ*, target object

JavaScript

rc = obj.BIND(p1, p3);

Description

Bind constructor to the given target object

R3CONSTRUCTORM_BINDSIBLINGS

Method

BINDSIBLINGS

Identifier

R3CONSTRUCTORM_BINDSIBLINGS

JavaScript

obj.BINDSIBLINGS();

Description

Bind to the sibling objects.

R3CONSTRUCTORM_UNBINDSIBLING

Method

UNBINDSIBLING

Identifier

R3CONSTRUCTORM_UNBINDSIBLING

JavaScript

obj.UNBINDSIBLING();

Description

Unbind from the sibling objects

R3CONSTRUCTORM_BEGIN

Method

BEGIN

Identifier

R3CONSTRUCTORM_BEGIN

Return

R3BOOL, the state of the _Enabled attribute.

JavaScript

rc = obj.BEGIN();

Description

Start construction. If the constructor's R3CONSTRUCTORA_Enabled is FALSE, * the base class returns FALSE and the derived classes should not touch * the target attributes.

R3CONSTRUCTORM_END

Method

END

Identifier

R3CONSTRUCTORM_END

JavaScript

obj.END();

Description

Tells the object that the construction cycle is done.

R3CONSTRUCTORM_BINDOBJ

Method

BINDOBJ

Identifier

R3CONSTRUCTORM_BINDOBJ

Return

R3BOOL, true if succeeded

Param 3:

R3OBJ*, target

JavaScript

rc = obj.BINDOBJ(p3);

Description

Bind to the given target object.

R3CONSTRUCTORM_UNBINDOBJ

Method

UNBINDOBJ

Identifier

R3CONSTRUCTORM_UNBINDOBJ

Return

R3BOOL, true if succeeded

Param 3:

R3OBJ*, target

JavaScript

rc = obj.UNBINDOBJ(p3);

Description

Unbind the given target object.

Enabled

Attribute

Enabled

Identifier

R3CONSTRUCTORA_Enabled

JavaScript type

Boolean

C type

R3BOOL

Description

Syntax


jsobj.SetEnabled(value);
value = jsobj.GetEnabled();


R3BOOL value = ...;
R3SetAttrs(r3obj, R3CONSTRUCTORA_Enabled, value, R3TAG_END);
R3BOOL value;
R3GetAttrs(r3obj, R3CONSTRUCTORA_Enabled, &value, R3TAG_END);

Target

Attribute

Target

Identifier

R3CONSTRUCTORA_Target

JavaScript type

Boolean

C type

R3BOOL

Description

true means other constructors can control this constructor

Syntax


jsobj.SetTarget(value);
value = jsobj.GetTarget();


R3BOOL value = ...;
R3SetAttrs(r3obj, R3CONSTRUCTORA_Target, value, R3TAG_END);
R3BOOL value;
R3GetAttrs(r3obj, R3CONSTRUCTORA_Target, &value, R3TAG_END);

Animator

Attribute

Animator

Identifier

R3CONSTRUCTORA_Animator

JavaScript type

Boolean

C type

R3BOOL

Description

true if this object acts as an active animator rather than just a deformator

Syntax


jsobj.SetAnimator(value);
value = jsobj.GetAnimator();


R3BOOL value = ...;
R3SetAttrs(r3obj, R3CONSTRUCTORA_Animator, value, R3TAG_END);
R3BOOL value;
R3GetAttrs(r3obj, R3CONSTRUCTORA_Animator, &value, R3TAG_END);

Tags

Tags

R3CONSTRUCTORA_ChorMth
R3CONSTRUCTORA_ChorObj
R3CONSTRUCTORA_Recursive
R3CONSTRUCTORA_SiblingsOnly
R3CONSTRUCTORA_Force
<sect6> <title>r3cobend</title>

r3cobend

Class

real/objects/r3cobend.h

Library

r3obj

Description:

Bend constructor

See Also

real/objects/r3constructor.h

Super Class

r3Constructor

R3CLID_CONSTRUCTOR

JavaScript

r3Bendconstructor

Class Identifier

R3CLID_BENDCONSTRUCTOR - 1782

Methods

Attributes

AxisOrigin, AxisEnd, ArcOrigin, ArcEnd, Angle,

Registration

int R3RegisterBendConstructorClass(R3APP *app);

AxisOrigin

Attribute

AxisOrigin

Identifier

R3COBENDA_AxisOrigin

Type

r3Vect

Description

initial origin

Syntax


jsobj.SetAxisOrigin(value);
value = jsobj.GetAxisOrigin();


R3VECTOR value = ...;
R3SetAttrs(r3obj, R3COBENDA_AxisOrigin, value, R3TAG_END);
R3VECTOR value;
R3GetAttrs(r3obj, R3COBENDA_AxisOrigin, &value, R3TAG_END);

AxisEnd

Attribute

AxisEnd

Identifier

R3COBENDA_AxisEnd

Type

r3Vect

Description

original end point

Syntax


jsobj.SetAxisEnd(value);
value = jsobj.GetAxisEnd();


R3VECTOR value = ...;
R3SetAttrs(r3obj, R3COBENDA_AxisEnd, value, R3TAG_END);
R3VECTOR value;
R3GetAttrs(r3obj, R3COBENDA_AxisEnd, &value, R3TAG_END);

ArcOrigin

Attribute

ArcOrigin

Identifier

R3COBENDA_ArcOrigin

Type

r3Vect

Description

current origin

Syntax


jsobj.SetArcOrigin(value);
value = jsobj.GetArcOrigin();


R3VECTOR value = ...;
R3SetAttrs(r3obj, R3COBENDA_ArcOrigin, value, R3TAG_END);
R3VECTOR value;
R3GetAttrs(r3obj, R3COBENDA_ArcOrigin, &value, R3TAG_END);

ArcEnd

Attribute

ArcEnd

Identifier

R3COBENDA_ArcEnd

Type

r3Vect

Description

current (bended) end point

Syntax


jsobj.SetArcEnd(value);
value = jsobj.GetArcEnd();


R3VECTOR value = ...;
R3SetAttrs(r3obj, R3COBENDA_ArcEnd, value, R3TAG_END);
R3VECTOR value;
R3GetAttrs(r3obj, R3COBENDA_ArcEnd, &value, R3TAG_END);

Angle

Attribute

Angle

Identifier

R3COBENDA_Angle

JavaScript type

Number

C type

R3FLOAT

Description

bending angle -2PI...2PI (optional)

Syntax


jsobj.SetAngle(value);
value = jsobj.GetAngle();


R3FLOAT value = ...;
R3SetAttrs(r3obj, R3COBENDA_Angle, value, R3TAG_END);
R3FLOAT value;
R3GetAttrs(r3obj, R3COBENDA_Angle, &value, R3TAG_END);

geometric points

R3COBEND_NUMPOINTS

R3_ARCORIGIN
R3_ARCEND
R3_AXISORIGIN
R3_AXISEND

</sect6>
<sect6> <title>r3carriage</title>

r3carriage

Class

plugins/objects/carriage/r3carriage.h

Library

r3carriage

Description:

Carriage object converts deformations to linear transformations.

See Also

real/objects/r3constructor.h

Super Class

r3Constructor

R3CLID_CONSTRUCTOR

JavaScript

r3Carriage

Class Identifier

R3CLID_CARRIAGE - 2441

Methods

Attributes

Origin, X, Y, Z,

Origin

Attribute

Origin

Identifier

R3CARRIAGEA_Origin

Type

r3Vect

Description

CARRIAGE point

Syntax


jsobj.SetOrigin(value);
value = jsobj.GetOrigin();


R3VECTOR value = ...;
R3SetAttrs(r3obj, R3CARRIAGEA_Origin, value, R3TAG_END);
R3VECTOR value;
R3GetAttrs(r3obj, R3CARRIAGEA_Origin, &value, R3TAG_END);

X

Attribute

X

Identifier

R3CARRIAGEA_X

Type

r3Vect

Description

point in 'x' direction

Syntax


jsobj.SetX(value);
value = jsobj.GetX();


R3VECTOR value = ...;
R3SetAttrs(r3obj, R3CARRIAGEA_X, value, R3TAG_END);
R3VECTOR value;
R3GetAttrs(r3obj, R3CARRIAGEA_X, &value, R3TAG_END);

Y

Attribute

Y

Identifier

R3CARRIAGEA_Y

Type

r3Vect

Description

point in 'y' direction

Syntax


jsobj.SetY(value);
value = jsobj.GetY();


R3VECTOR value = ...;
R3SetAttrs(r3obj, R3CARRIAGEA_Y, value, R3TAG_END);
R3VECTOR value;
R3GetAttrs(r3obj, R3CARRIAGEA_Y, &value, R3TAG_END);

Z

Attribute

Z

Identifier

R3CARRIAGEA_Z

Type

r3Vect

Description

point in 'z' direction

Syntax


jsobj.SetZ(value);
value = jsobj.GetZ();


R3VECTOR value = ...;
R3SetAttrs(r3obj, R3CARRIAGEA_Z, value, R3TAG_END);
R3VECTOR value;
R3GetAttrs(r3obj, R3CARRIAGEA_Z, &value, R3TAG_END);

</sect6>
<sect6> <title>r3cogroup</title>

r3cogroup

Class

real/objects/r3cogroup.h

Library

r3obj

Description:

Sub group constructor object.

See Also

real/objects/r3constructor.h

Super Class

r3Constructor

R3CLID_CONSTRUCTOR

JavaScript

r3Cogroup

Class Identifier

R3CLID_COGROUP - 1759

Methods

CREATEFROMSELECTE, INVERTREFERENCES, XOR, ENUMTARGETPOINTS, SELECTTARGETPOINT,

Attributes

PointCount, Positions, Weight,

R3COGROUPM_CREATEFROMSELECTE

Method

CREATEFROMSELECTE

Identifier

R3COGROUPM_CREATEFROMSELECTE

JavaScript

obj.CREATEFROMSELECTE();

Description

Create group points from the currently selected * target points.

R3COGROUPM_INVERTREFERENCES

Method

INVERTREFERENCES

Identifier

R3COGROUPM_INVERTREFERENCES

JavaScript

obj.INVERTREFERENCES();

Description

Invert group references - a referred point becomes unreferred and vise versa.

R3COGROUPM_XOR

Method

XOR

Identifier

R3COGROUPM_XOR

Param 3:

R3OBJ*, array of groups

JavaScript

obj.XOR(p3);

Description

Apply XOR boolean operation between referred points. as a result, mutually referred points are removed from the given sub groups.

R3COGROUPM_ENUMTARGETPOINTS

Method

ENUMTARGETPOINTS

Identifier

R3COGROUPM_ENUMTARGETPOINTS

Param 3:

R3TAG*, R3RA_Hook, R3RA_HookData

JavaScript

obj.ENUMTARGETPOINTS(p3);

Description

Enumerate target points

R3COGROUPM_SELECTTARGETPOINT

Method

SELECTTARGETPOINT

Identifier

R3COGROUPM_SELECTTARGETPOINT

Param 3:

R3BOOL, if true selects, otherwise deselects

JavaScript

obj.SELECTTARGETPOINT(p3);

Description

Select/deselect all target points.

PointCount

Attribute

PointCount

Identifier

R3COGROUPA_PointCount

JavaScript type

Integer

C type

R3INT

Description

number of points

Syntax


jsobj.SetPointCount(value);
value = jsobj.GetPointCount();


R3INT value = ...;
R3SetAttrs(r3obj, R3COGROUPA_PointCount, value, R3TAG_END);
R3INT value;
R3GetAttrs(r3obj, R3COGROUPA_PointCount, &value, R3TAG_END);

Positions

Attribute

Positions

Identifier

R3COGROUPA_Positions

Type

r3Vect

Description

current points

Syntax


jsobj.SetPositions(value);
value = jsobj.GetPositions();


R3VECTOR* value = ...;
R3SetAttrs(r3obj, R3COGROUPA_Positions, value, R3TAG_END);
R3VECTOR* value;
R3GetAttrs(r3obj, R3COGROUPA_Positions, &value, R3TAG_END);

Weight

Attribute

Weight

Identifier

R3COGROUPA_Weight

JavaScript type

Number

C type

R3FLOAT

Description

weight

Syntax


jsobj.SetWeight(value);
value = jsobj.GetWeight();


R3FLOAT value = ...;
R3SetAttrs(r3obj, R3COGROUPA_Weight, value, R3TAG_END);
R3FLOAT value;
R3GetAttrs(r3obj, R3COGROUPA_Weight, &value, R3TAG_END);

handles

R3COGRHT_VERTEX

index of the point to be controlled

unique id specifying the target object

Tags

Tags

R3COGROUPA_OrigPositions
</sect6>
<sect6> <title>r3constr</title>

r3constr

Class

plugins/objects/constraint/r3constr.h

Library

r3constr

Description:

Base class for constraints

See Also

real/objects/r3constructor.h

Super Class

r3Constructor

R3CLID_CONSTRUCTOR

JavaScript

r3Constraint

Class Identifier

R3CLID_CONSTRAINT - 1497

Methods

SETTARGETS,

Attributes

R3CONSTRM_SETTARGETS

Method

SETTARGETS

Identifier

R3CONSTRM_SETTARGETS

Return

R3BOOL, true if succeeded

Param 1:

R3BOOL, recursive

Param 3:

R3OBJ**, null terminated array of objects to be constrained.

JavaScript

rc = obj.SETTARGETS(p1, p3);

Description

Set objects to be constrained

Registry function

<sect7> <title>r3cnslng</title>

r3cnslng

Class

plugins/objects/constraint/r3cnslng.h

Library

r3constr

Description:

Base class for programming language based constraints

See Also

plugins/objects/constraint/r3constr.h

Super Class

r3Constraint

R3CLID_CONSTRAINT

JavaScript

r3Cnslng

Class Identifier

R3CLID_CNSLNG - 1427

Methods

EXECUTE, UPDATETARGET, ALLOCINTERP, FINDINTERP, GETINTERPCLID,

Attributes

Script, ScriptClid, ScriptObj,

super clas

R3CNSLNGM_EXECUTE

Method

EXECUTE

Identifier

R3CNSLNGM_EXECUTE

JavaScript

obj.EXECUTE();

Description

Execute constraint procedure.

R3CNSLNGM_UPDATETARGET

Method

UPDATETARGET

Identifier

R3CNSLNGM_UPDATETARGET

Return

R3BOOL, true if succeeded

JavaScript

rc = obj.UPDATETARGET();

Description

Call the target object's

R3CNSLNGM_ALLOCINTERP

Method

ALLOCINTERP

Identifier

R3CNSLNGM_ALLOCINTERP

Return

R3OBJ*, interpreter

JavaScript

rc = obj.ALLOCINTERP();

Description

Allocate interpreter used for executing the constraint program.

R3CNSLNGM_FINDINTERP

Method

FINDINTERP

Identifier

R3CNSLNGM_FINDINTERP

Return

R3OBJ*, null if no interpreter was found.

Param 3:

R3CLID, interpreter to be found

JavaScript

rc = obj.FINDINTERP(p3);

Description

Find interpreter of given type

R3CNSLNGM_GETINTERPCLID

Method

GETINTERPCLID

Identifier

R3CNSLNGM_GETINTERPCLID

Return

R3CLID, interpreter class to be used.

JavaScript

rc = obj.GETINTERPCLID();

Description

Derived classes must provide information about the actual interpreter class to be used.

Script

Attribute

Script

Identifier

R3CNSLNGA_Script

JavaScript type

String

C type

char*

Description

buffer containg the program to be executed

Syntax


jsobj.SetScript(value);
value = jsobj.GetScript();


char* value = ...;
R3SetAttrs(r3obj, R3CNSLNGA_Script, value, R3TAG_END);
char* value;
R3GetAttrs(r3obj, R3CNSLNGA_Script, &value, R3TAG_END);

ScriptClid

Attribute

ScriptClid

Identifier

R3CNSLNGA_ScriptClid

JavaScript type

Integer

C type

R3CLID

Description

class of scripting engine

Syntax


jsobj.SetScriptClid(value);
value = jsobj.GetScriptClid();


R3CLID value = ...;
R3SetAttrs(r3obj, R3CNSLNGA_ScriptClid, value, R3TAG_END);
R3CLID value;
R3GetAttrs(r3obj, R3CNSLNGA_ScriptClid, &value, R3TAG_END);

ScriptObj

Attribute

ScriptObj

Identifier

R3CNSLNGA_ScriptObj

JavaScript type

Object

C type

R3OBJ*

Description

scripting object

Syntax


jsobj.SetScriptObj(value);
value = jsobj.GetScriptObj();


R3OBJ* value = ...;
R3SetAttrs(r3obj, R3CNSLNGA_ScriptObj, value, R3TAG_END);
R3OBJ* value;
R3GetAttrs(r3obj, R3CNSLNGA_ScriptObj, &value, R3TAG_END);

Registry function

</sect7>
</sect6>
<sect6> <title>r3drag</title>

r3drag

Class

real/objects/r3drag.h

Library

r3obj

Description:

Drag animation object. Moves based on collisions between ground and animated object.

See Also

real/objects/r3constructor.h

Super Class

r3Constructor

R3CLID_CONSTRUCTOR

JavaScript

r3Drag

Class Identifier

R3CLID_DRAG - 640

Methods

Attributes

From, To, Friction, Rebound,

From

Attribute

From

Identifier

R3DRAGA_From

Type

r3Vect

Description

two points ...

Syntax


jsobj.SetFrom(value);
value = jsobj.GetFrom();


R3VECTOR value = ...;
R3SetAttrs(r3obj, R3DRAGA_From, value, R3TAG_END);
R3VECTOR value;
R3GetAttrs(r3obj, R3DRAGA_From, &value, R3TAG_END);

To

Attribute

To

Identifier

R3DRAGA_To

Type

r3Vect

Description

... defining the direction of the gravity

Syntax


jsobj.SetTo(value);
value = jsobj.GetTo();


R3VECTOR value = ...;
R3SetAttrs(r3obj, R3DRAGA_To, value, R3TAG_END);
R3VECTOR value;
R3GetAttrs(r3obj, R3DRAGA_To, &value, R3TAG_END);

Friction

Attribute

Friction

Identifier

R3DRAGA_Friction

JavaScript type

Number

C type

R3FLOAT

Description

surface friction 0 ... 1

Syntax


jsobj.SetFriction(value);
value = jsobj.GetFriction();


R3FLOAT value = ...;
R3SetAttrs(r3obj, R3DRAGA_Friction, value, R3TAG_END);
R3FLOAT value;
R3GetAttrs(r3obj, R3DRAGA_Friction, &value, R3TAG_END);

Rebound

Attribute

Rebound

Identifier

R3DRAGA_Rebound

JavaScript type

Number

C type

R3FLOAT

Description

rebound energy 0 ... 1

Syntax


jsobj.SetRebound(value);
value = jsobj.GetRebound();


R3FLOAT value = ...;
R3SetAttrs(r3obj, R3DRAGA_Rebound, value, R3TAG_END);
R3FLOAT value;
R3GetAttrs(r3obj, R3DRAGA_Rebound, &value, R3TAG_END);

attach translation to target by using dynamic tag

Tags

Tags

R3DRAGA_PrevPoints
</sect6>
<sect6> <title>r3fiber</title>

r3fiber

Class

real/objects/r3fiber.h

Library

r3obj

Description:

Fiber class. Creates fibers (curves) by evaluating sub objects

See Also

real/objects/r3constructor.h

Super Class

r3Constructor

R3CLID_CONSTRUCTOR

JavaScript

r3Fiber

Class Identifier

R3CLID_FIBER - 682

Methods

Attributes

OrientationU, OrientationV, CurveCount, PointCount, Displacement, DisplacementClid, DisplacementRnd, DisplacementChannel,

Registration

int R3RegisterFiberClass(R3APP *app);

OrientationU

Attribute

OrientationU

Identifier

R3FIBERA_OrientationU

JavaScript type

Boolean

C type

R3BOOL

Description

Syntax


jsobj.SetOrientationU(value);
value = jsobj.GetOrientationU();


R3BOOL value = ...;
R3SetAttrs(r3obj, R3FIBERA_OrientationU, value, R3TAG_END);
R3BOOL value;
R3GetAttrs(r3obj, R3FIBERA_OrientationU, &value, R3TAG_END);

OrientationV

Attribute

OrientationV

Identifier

R3FIBERA_OrientationV

JavaScript type

Boolean

C type

R3BOOL

Description

Syntax


jsobj.SetOrientationV(value);
value = jsobj.GetOrientationV();


R3BOOL value = ...;
R3SetAttrs(r3obj, R3FIBERA_OrientationV, value, R3TAG_END);
R3BOOL value;
R3GetAttrs(r3obj, R3FIBERA_OrientationV, &value, R3TAG_END);

CurveCount

Attribute

CurveCount

Identifier

R3FIBERA_CurveCount

JavaScript type

Integer

C type

R3INT

Description

number of curves per interval

Syntax


jsobj.SetCurveCount(value);
value = jsobj.GetCurveCount();


R3INT value = ...;
R3SetAttrs(r3obj, R3FIBERA_CurveCount, value, R3TAG_END);
R3INT value;
R3GetAttrs(r3obj, R3FIBERA_CurveCount, &value, R3TAG_END);

PointCount

Attribute

PointCount

Identifier

R3FIBERA_PointCount

JavaScript type

Integer

C type

R3INT

Description

number of points per interval

Syntax


jsobj.SetPointCount(value);
value = jsobj.GetPointCount();


R3INT value = ...;
R3SetAttrs(r3obj, R3FIBERA_PointCount, value, R3TAG_END);
R3INT value;
R3GetAttrs(r3obj, R3FIBERA_PointCount, &value, R3TAG_END);

Displacement

Attribute

Displacement

Identifier

R3FIBERA_Displacement

JavaScript type

Number

C type

R3FLOAT

Description

displacement

Syntax


jsobj.SetDisplacement(value);
value = jsobj.GetDisplacement();


R3FLOAT value = ...;
R3SetAttrs(r3obj, R3FIBERA_Displacement, value, R3TAG_END);
R3FLOAT value;
R3GetAttrs(r3obj, R3FIBERA_Displacement, &value, R3TAG_END);

DisplacementClid

Attribute

DisplacementClid

Identifier

R3FIBERA_DisplacementClid

JavaScript type

Integer

C type

R3CLID

Description

class id of the property

Syntax


jsobj.SetDisplacementClid(value);
value = jsobj.GetDisplacementClid();


R3CLID value = ...;
R3SetAttrs(r3obj, R3FIBERA_DisplacementClid, value, R3TAG_END);
R3CLID value;
R3GetAttrs(r3obj, R3FIBERA_DisplacementClid, &value, R3TAG_END);

DisplacementRnd

Attribute

DisplacementRnd

Identifier

R3FIBERA_DisplacementRnd

JavaScript type

Number

C type

R3FLOAT

Description

random factor for the displacement

Syntax


jsobj.SetDisplacementRnd(value);
value = jsobj.GetDisplacementRnd();


R3FLOAT value = ...;
R3SetAttrs(r3obj, R3FIBERA_DisplacementRnd, value, R3TAG_END);
R3FLOAT value;
R3GetAttrs(r3obj, R3FIBERA_DisplacementRnd, &value, R3TAG_END);

DisplacementChannel

Attribute

DisplacementChannel

Identifier

R3FIBERA_DisplacementChannel

JavaScript type

String

C type

char*

Description

name of the channel where displacement is evaluated

Syntax


jsobj.SetDisplacementChannel(value);
value = jsobj.GetDisplacementChannel();


char* value = ...;
R3SetAttrs(r3obj, R3FIBERA_DisplacementChannelName, value, R3TAG_END);
char* value;
R3GetAttrs(r3obj, R3FIBERA_DisplacementChannelName, &value, R3TAG_END);

</sect6>
<sect6> <title>r3gm</title>

R3GMM_GETCLIENTCS

Method

GETCLIENTCS

Identifier

R3GMM_GETCLIENTCS

Param 3:

R3COORDSYS, fetch coordinate system specifying the packing space

JavaScript

obj.GETCLIENTCS(p3);

Description

Get client space

R3GMM_SETCLIENTCS

Method

SETCLIENTCS

Identifier

R3GMM_SETCLIENTCS

Param 3:

R3COORDSYS, set coordinate system specifying the packing space

JavaScript

obj.SETCLIENTCS(p3);

Description

Set client space

R3GMM_FIT

Method

FIT

Identifier

R3GMM_FIT

JavaScript

obj.FIT();

Description

Compute the size for the gmanager geometry based on the current slaves. * This method is called when sub objects change and the gmanager size needs to be recomputed.

R3GMM_REFRESH

Method

REFRESH

Identifier

R3GMM_REFRESH

JavaScript

obj.REFRESH();

Description

Refresh sub objects to match the gmanagers geometry. Typically * called when gmanager size is changed and the children need to be * updated accordingly. Update is done in an optimized way using the DOWHENIDLE method.

R3GMM_GETMINSIZE

Method

GETMINSIZE

Identifier

R3GMM_GETMINSIZE

Param 3:

R3VECTOR, minimum size

JavaScript

obj.GETMINSIZE(p3);

Description

Fetch the current minimum size of the cs. in object's local space. *

R3GMM_SETMINSIZE

Method

SETMINSIZE

Identifier

R3GMM_SETMINSIZE

Param 3:

R3VECTOR, set minimum size for the gmanager.

JavaScript

obj.SETMINSIZE(p3);

Description

Set minimum size of the cs in object's local space.

R3GMM_GETBBSIZE

Method

GETBBSIZE

Identifier

R3GMM_GETBBSIZE

Param 3:

R3VECTOR, current size

JavaScript

obj.GETBBSIZE(p3);

Description

Fetch the current size of the bounding box in object's local space.

R3GMM_SETBBSIZE

Method

SETBBSIZE

Identifier

R3GMM_SETBBSIZE

Param 3:

R3VECTOR, new size

JavaScript

obj.SETBBSIZE(p3);

Description

Set the current size of the bounding box in object's local space.

R3GMM_ROTCLIENTSPACE

Method

ROTCLIENTSPACE

Identifier

R3GMM_ROTCLIENTSPACE

Param 1:

R3VECTOR, rotation center

Param 2:

R3VECTOR, rotation axis

Param 3:

R3FLOAT, rotation angle

JavaScript

obj.ROTCLIENTSPACE(p1, p2, p3);

Description

Rotate the packing cs in object's local space.

R3GMM_SNAPCSTOMODULO

Method

SNAPCSTOMODULO

Identifier

R3GMM_SNAPCSTOMODULO

Param 3:

R3VECTOR, size to be snapped

JavaScript

obj.SNAPCSTOMODULO(p3);

Description

Snap the size of the cs to the current modulo.

R3GMM_NORMALIZESLAVES

Method

NORMALIZESLAVES

Identifier

R3GMM_NORMALIZESLAVES

JavaScript

obj.NORMALIZESLAVES();

Description

This method can be called right after the slaves has * been inserted. The method rotates the slave spaces to match the * orientation so that the actual geometry remains unchanged in the abs space.

R3GMM_UPDATEMINSIZE

Method

UPDATEMINSIZE

Identifier

R3GMM_UPDATEMINSIZE

JavaScript

obj.UPDATEMINSIZE();

Description

Sets the minimum size to match the current cs size.

R3GMM_SETCSSIZE

Method

SETCSSIZE

Identifier

R3GMM_SETCSSIZE

Param 3:

R3VECTOR, size

JavaScript

obj.SETCSSIZE(p3);

Description

Set the size of the cs in objects local space.

R3GMM_GETCSSIZE

Method

GETCSSIZE

Identifier

R3GMM_GETCSSIZE

Param 3:

R3VECTOR, size of the packing cube

JavaScript

obj.GETCSSIZE(p3);

Description

Get the size of the cs in objects local space

R3GMM_DOREFRESH

Method

DOREFRESH

Identifier

R3GMM_DOREFRESH

Param 3:

R3BOOL, true to force update

JavaScript

obj.DOREFRESH(p3);

Description

Refresh sub objects to match the gmanager. Typically * called when gmanager size is changed and the children need to be * updated accordingly.

R3GMM_resev

Method

resev

Identifier

R3GMM_resev

JavaScript

obj.resev();

Description

R3GMM_GETREQSIZE

Method

GETREQSIZE

Identifier

R3GMM_GETREQSIZE

Param 3:

R3VECTOR, required size

JavaScript

obj.GETREQSIZE(p3);

Description

Fetch the minimum required size.

R3GMM_SETSLAVEATTRS

Method

SETSLAVEATTRS

Identifier

R3GMM_SETSLAVEATTRS

Param 1:

R3INT, indexed attribute to be set

Param 3:

void*, value for the indexed attribute to be set

JavaScript

obj.SETSLAVEATTRS(p1, p3);

Description

Set options for all the slaves.

R3GMCM_REGISTERINSERTHANDLER

Method

REGISTERINSERTHANDLER

Identifier

R3GMCM_REGISTERINSERTHANDLER

Return

R3BOOL, true if succeeded

JavaScript

rc = obj.REGISTERINSERTHANDLER();

Description

Register insert handler, which is called whenever * new object is inserted into the gmanager.

Width

Attribute

Width

Identifier

R3GMA_Width

JavaScript type

Number

C type

R3FLOAT*

Description

width in abs space

Syntax


jsobj.SetWidth(value);
value = jsobj.GetWidth();


R3FLOAT* value = ...;
R3SetAttrs(r3obj, R3GMA_Width, value, R3TAG_END);
R3FLOAT* value;
R3GetAttrs(r3obj, R3GMA_Width, &value, R3TAG_END);

Height

Attribute

Height

Identifier

R3GMA_Height

JavaScript type

Number

C type

R3FLOAT*

Description

height

Syntax


jsobj.SetHeight(value);
value = jsobj.GetHeight();


R3FLOAT* value = ...;
R3SetAttrs(r3obj, R3GMA_Height, value, R3TAG_END);
R3FLOAT* value;
R3GetAttrs(r3obj, R3GMA_Height, &value, R3TAG_END);

Depth

Attribute

Depth

Identifier

R3GMA_Depth

JavaScript type

Number

C type

R3FLOAT*

Description

depth

Syntax


jsobj.SetDepth(value);
value = jsobj.GetDepth();


R3FLOAT* value = ...;
R3SetAttrs(r3obj, R3GMA_Depth, value, R3TAG_END);
R3FLOAT* value;
R3GetAttrs(r3obj, R3GMA_Depth, &value, R3TAG_END);

X

Attribute

X

Identifier

R3GMA_X

JavaScript type

Number

C type

R3FLOAT

Description

left edge in abs space

Syntax


jsobj.SetX(value);
value = jsobj.GetX();


R3FLOAT value = ...;
R3SetAttrs(r3obj, R3GMA_X, value, R3TAG_END);
R3FLOAT value;
R3GetAttrs(r3obj, R3GMA_X, &value, R3TAG_END);

Y

Attribute

Y

Identifier

R3GMA_Y

JavaScript type

Number

C type

R3FLOAT

Description

top edge

Syntax


jsobj.SetY(value);
value = jsobj.GetY();


R3FLOAT value = ...;
R3SetAttrs(r3obj, R3GMA_Y, value, R3TAG_END);
R3FLOAT value;
R3GetAttrs(r3obj, R3GMA_Y, &value, R3TAG_END);

Z

Attribute

Z

Identifier

R3GMA_Z

JavaScript type

Number

C type

R3FLOAT

Description

face edge

Syntax


jsobj.SetZ(value);
value = jsobj.GetZ();


R3FLOAT value = ...;
R3SetAttrs(r3obj, R3GMA_Z, value, R3TAG_END);
R3FLOAT value;
R3GetAttrs(r3obj, R3GMA_Z, &value, R3TAG_END);

P0

Attribute

P0

Identifier

R3GMA_P0

Type

r3Vect

Description

origin of the cs defining packing cube

Syntax


jsobj.SetP0(value);
value = jsobj.GetP0();


R3VECTOR value = ...;
R3SetAttrs(r3obj, R3GMA_P0, value, R3TAG_END);
R3VECTOR value;
R3GetAttrs(r3obj, R3GMA_P0, &value, R3TAG_END);

P1

Attribute

P1

Identifier

R3GMA_P1

Type

r3Vect

Description

end point for the x axis

Syntax


jsobj.SetP1(value);
value = jsobj.GetP1();


R3VECTOR value = ...;
R3SetAttrs(r3obj, R3GMA_P1, value, R3TAG_END);
R3VECTOR value;
R3GetAttrs(r3obj, R3GMA_P1, &value, R3TAG_END);

P2

Attribute

P2

Identifier

R3GMA_P2

Type

r3Vect

Description

end point for the y axis

Syntax


jsobj.SetP2(value);
value = jsobj.GetP2();


R3VECTOR value = ...;
R3SetAttrs(r3obj, R3GMA_P2, value, R3TAG_END);
R3VECTOR value;
R3GetAttrs(r3obj, R3GMA_P2, &value, R3TAG_END);

P3

Attribute

P3

Identifier

R3GMA_P3

Type

r3Vect

Description

end point for the z axis

Syntax


jsobj.SetP3(value);
value = jsobj.GetP3();


R3VECTOR value = ...;
R3SetAttrs(r3obj, R3GMA_P3, value, R3TAG_END);
R3VECTOR value;
R3GetAttrs(r3obj, R3GMA_P3, &value, R3TAG_END);

Geometry

Attribute

Geometry

Identifier

R3GMA_Geometry

JavaScript type

Object

C type

R3OBJ*

Description

the actual geometry object

Syntax


value = jsobj.GetGeometry();


R3OBJ* value;
R3GetAttrs(r3obj, R3GMA_Geometry, &value, R3TAG_END);

MinWidth

Attribute

MinWidth

Identifier

R3GMA_MinWidth

JavaScript type

Number

C type

R3FLOAT

Description

minimum width

Syntax


jsobj.SetMinWidth(value);
value = jsobj.GetMinWidth();


R3FLOAT value = ...;
R3SetAttrs(r3obj, R3GMA_MinWidth, value, R3TAG_END);
R3FLOAT value;
R3GetAttrs(r3obj, R3GMA_MinWidth, &value, R3TAG_END);

MinHeight

Attribute

MinHeight

Identifier

R3GMA_MinHeight

JavaScript type

Number

C type

R3FLOAT

Description

minimum height

Syntax


jsobj.SetMinHeight(value);
value = jsobj.GetMinHeight();


R3FLOAT value = ...;
R3SetAttrs(r3obj, R3GMA_MinHeight, value, R3TAG_END);
R3FLOAT value;
R3GetAttrs(r3obj, R3GMA_MinHeight, &value, R3TAG_END);

MinDepth

Attribute

MinDepth

Identifier

R3GMA_MinDepth

JavaScript type

Number

C type

R3FLOAT

Description

minimum depth

Syntax


jsobj.SetMinDepth(value);
value = jsobj.GetMinDepth();


R3FLOAT value = ...;
R3SetAttrs(r3obj, R3GMA_MinDepth, value, R3TAG_END);
R3FLOAT value;
R3GetAttrs(r3obj, R3GMA_MinDepth, &value, R3TAG_END);

ModuloWidth

Attribute

ModuloWidth

Identifier

R3GMA_ModuloWidth

JavaScript type

Number

C type

R3FLOAT

Description

modulo in width direction

Syntax


jsobj.SetModuloWidth(value);
value = jsobj.GetModuloWidth();


R3FLOAT value = ...;
R3SetAttrs(r3obj, R3GMA_ModuloWidth, value, R3TAG_END);
R3FLOAT value;
R3GetAttrs(r3obj, R3GMA_ModuloWidth, &value, R3TAG_END);

ModuloHeight

Attribute

ModuloHeight

Identifier

R3GMA_ModuloHeight

JavaScript type

Number

C type

R3FLOAT

Description

modulo in height direction

Syntax


jsobj.SetModuloHeight(value);
value = jsobj.GetModuloHeight();


R3FLOAT value = ...;
R3SetAttrs(r3obj, R3GMA_ModuloHeight, value, R3TAG_END);
R3FLOAT value;
R3GetAttrs(r3obj, R3GMA_ModuloHeight, &value, R3TAG_END);

ModuloDepth

Attribute

ModuloDepth

Identifier

R3GMA_ModuloDepth

JavaScript type

Number

C type

R3FLOAT

Description

modulo in depth direction

Syntax


jsobj.SetModuloDepth(value);
value = jsobj.GetModuloDepth();


R3FLOAT value = ...;
R3SetAttrs(r3obj, R3GMA_ModuloDepth, value, R3TAG_END);
R3FLOAT value;
R3GetAttrs(r3obj, R3GMA_ModuloDepth, &value, R3TAG_END);

Sampling

Attribute

Sampling

Identifier

R3GMA_Sampling

JavaScript type

Integer

C type

R3INT

Description

sampling

Syntax


jsobj.SetSampling(value);
value = jsobj.GetSampling();


R3INT value = ...;
R3SetAttrs(r3obj, R3GMA_Sampling, value, R3TAG_END);
R3INT value;
R3GetAttrs(r3obj, R3GMA_Sampling, &value, R3TAG_END);

Orientation

Attribute

Orientation

Identifier

R3GMA_Orientation

JavaScript type

Integer

C type

R3INT

Description

see orientations below

Syntax


jsobj.SetOrientation(value);
value = jsobj.GetOrientation();


R3INT value = ...;
R3SetAttrs(r3obj, R3GMA_Orientation, value, R3TAG_END);
R3INT value;
R3GetAttrs(r3obj, R3GMA_Orientation, &value, R3TAG_END);

PrimarySnapDir

Attribute

PrimarySnapDir

Identifier

R3GMA_PrimarySnapDir

JavaScript type

Integer

C type

R3INT

Description

see search directions below

Syntax


jsobj.SetPrimarySnapDir(value);
value = jsobj.GetPrimarySnapDir();


R3INT value = ...;
R3SetAttrs(r3obj, R3GMA_PrimarySnapDir, value, R3TAG_END);
R3INT value;
R3GetAttrs(r3obj, R3GMA_PrimarySnapDir, &value, R3TAG_END);

SecondSnapDir

Attribute

SecondSnapDir

Identifier

R3GMA_SecondSnapDir

JavaScript type

Integer

C type

R3INT

Description

see search directions below

Syntax


jsobj.SetSecondSnapDir(value);
value = jsobj.GetSecondSnapDir();


R3INT value = ...;
R3SetAttrs(r3obj, R3GMA_SecondSnapDir, value, R3TAG_END);
R3INT value;
R3GetAttrs(r3obj, R3GMA_SecondSnapDir, &value, R3TAG_END);

ThirdSnapDir

Attribute

ThirdSnapDir

Identifier

R3GMA_ThirdSnapDir

JavaScript type

Integer

C type

R3INT

Description

see search directions below

Syntax


jsobj.SetThirdSnapDir(value);
value = jsobj.GetThirdSnapDir();


R3INT value = ...;
R3SetAttrs(r3obj, R3GMA_ThirdSnapDir, value, R3TAG_END);
R3INT value;
R3GetAttrs(r3obj, R3GMA_ThirdSnapDir, &value, R3TAG_END);

RotateType

Attribute

RotateType

Identifier

R3GMA_RotateType

JavaScript type

Integer

C type

R3INT

Description

see rotate methods

Syntax


jsobj.SetRotateType(value);
value = jsobj.GetRotateType();


R3INT value = ...;
R3SetAttrs(r3obj, R3GMA_RotateType, value, R3TAG_END);
R3INT value;
R3GetAttrs(r3obj, R3GMA_RotateType, &value, R3TAG_END);

RotateAxis

Attribute

RotateAxis

Identifier

R3GMA_RotateAxis

JavaScript type

Integer

C type

R3INT

Description

see axis definitions

Syntax


jsobj.SetRotateAxis(value);
value = jsobj.GetRotateAxis();


R3INT value = ...;
R3SetAttrs(r3obj, R3GMA_RotateAxis, value, R3TAG_END);
R3INT value;
R3GetAttrs(r3obj, R3GMA_RotateAxis, &value, R3TAG_END);

SnapRange

Attribute

SnapRange

Identifier

R3GMA_SnapRange

JavaScript type

Number

C type

R3FLOAT

Description

snapping range

Syntax


jsobj.SetSnapRange(value);
value = jsobj.GetSnapRange();


R3FLOAT value = ...;
R3SetAttrs(r3obj, R3GMA_SnapRange, value, R3TAG_END);
R3FLOAT value;
R3GetAttrs(r3obj, R3GMA_SnapRange, &value, R3TAG_END);

SnapContact

Attribute

SnapContact

Identifier

R3GMA_SnapContact

JavaScript type

Integer

C type

R3INT

Description

see contact definitions

Syntax


jsobj.SetSnapContact(value);
value = jsobj.GetSnapContact();


R3INT value = ...;
R3SetAttrs(r3obj, R3GMA_SnapContact, value, R3TAG_END);
R3INT value;
R3GetAttrs(r3obj, R3GMA_SnapContact, &value, R3TAG_END);

Snap orientation defines which coordinate system is used for snapping and rotations

R3SNAPCS_OBJECT
R3SNAPCS_ABS
R3SNAPCS_IPLANE

Snap search directions

R3SNAPDIR_ALL
R3SNAPDIR_X
R3SNAPDIR_Y
R3SNAPDIR_Z
R3SNAPDIR_XY
R3SNAPDIR_YZ
R3SNAPDIR_XZ
R3SNAPDIR_NONE

Rotation method at snap

R3SNAPROT_SHORTESTROUTE
R3SNAPROT_HEADPITCH
R3SNAPROT_HEADONLY
R3SNAPROT_NONE

Rotation axis

R3SNAPROTAX_ANY
R3SNAPROTAX_X
R3SNAPROTAX_XNEG
R3SNAPROTAX_Y
R3SNAPROTAX_YNEG
R3SNAPROTAX_Z
R3SNAPROTAX_ZNEG

R3SNAP_BBOX
R3SNAP_PIVOT
R3SNAP_SURFACE

Tags

Tags

R3GMA_ResLocalX
R3GMA_ResLocalY
R3GMA_ResLocalZ
<sect7> <title>r3gmpack</title>

r3gmpack

Class

plugins/objects/gmanag/r3gmpack.h

Library

r3gmanag

Description:

Packer Geometry Manager. Packs sub objects.

See Also

plugins/objects/gmanag/r3gm.h

Super Class

r3Gm

R3CLID_GM

JavaScript

r3Gmpacker

Class Identifier

R3CLID_GMPACKER - 2585

Methods

INITDIR, INITORDER,

Attributes

Orientation, Expand, FillX, FillY, FillZ, Anchor, Unmanage, PadX, PadY, PadZ, IPadX, IPadY, IPadZ, DefaultAnchor, DefaultExpand, DefaultFillX, DefaultFillY, DefaultFillZ,

R3GMPACKERM_INITDIR

Method

INITDIR

Identifier

R3GMPACKERM_INITDIR

Return

R3BOOL, true if found.

JavaScript

rc = obj.INITDIR();

Description

This method should be called right after the slaves has * been inserted. The method finds the packing direction by studying * the slave's COG attribute.

R3GMPACKERM_INITORDER

Method

INITORDER

Identifier

R3GMPACKERM_INITORDER

Return

R3BOOL, true if found.

JavaScript

rc = obj.INITORDER();

Description

Sort the children list based on their pivot points. * This method should be called right after the slaves has * been inserted.

Orientation

Attribute

Orientation

Identifier

R3GMPACKERA_Orientation

JavaScript type

Integer

C type

R3INT

Description

see orientation codes

Syntax


jsobj.SetOrientation(value);
value = jsobj.GetOrientation();


R3INT value = ...;
R3SetAttrs(r3obj, R3GMPACKERA_Orientation, value, R3TAG_END);
R3INT value;
R3GetAttrs(r3obj, R3GMPACKERA_Orientation, &value, R3TAG_END);

Expand

Attribute

Expand

Identifier

R3GMPACKERA_Expand

JavaScript type

Boolean

C type

R3BOOL

Description

indexed attribute for the managed sub

Syntax


jsobj.SetExpand(index, value);
value = jsobj.GetExpand(index);


R3BOOL value = ...;
R3SetAttrs(r3obj, R3GMPACKERA_Expand, value, R3TAG_END);
R3BOOL value;
R3GetAttrs(r3obj, R3GMPACKERA_Expand, &value, R3TAG_END);

FillX

Attribute

FillX

Identifier

R3GMPACKERA_FillX

JavaScript type

Boolean

C type

R3BOOL

Description

indexed attribute, fill in x

Syntax


jsobj.SetFillX(index, value);
value = jsobj.GetFillX(index);


R3BOOL value = ...;
R3SetAttrs(r3obj, R3GMPACKERA_FillX, value, R3TAG_END);
R3BOOL value;
R3GetAttrs(r3obj, R3GMPACKERA_FillX, &value, R3TAG_END);

FillY

Attribute

FillY

Identifier

R3GMPACKERA_FillY

JavaScript type

Boolean

C type

R3BOOL

Description

indexed attribute, fill in y

Syntax


jsobj.SetFillY(index, value);
value = jsobj.GetFillY(index);


R3BOOL value = ...;
R3SetAttrs(r3obj, R3GMPACKERA_FillY, value, R3TAG_END);
R3BOOL value;
R3GetAttrs(r3obj, R3GMPACKERA_FillY, &value, R3TAG_END);

FillZ

Attribute

FillZ

Identifier

R3GMPACKERA_FillZ

JavaScript type

Boolean

C type

R3BOOL

Description

indexed attribute, fill in z

Syntax


jsobj.SetFillZ(index, value);
value = jsobj.GetFillZ(index);


R3BOOL value = ...;
R3SetAttrs(r3obj, R3GMPACKERA_FillZ, value, R3TAG_END);
R3BOOL value;
R3GetAttrs(r3obj, R3GMPACKERA_FillZ, &value, R3TAG_END);

Anchor

Attribute

Anchor

Identifier

R3GMPACKERA_Anchor

JavaScript type

Integer

C type

R3INT

Description

indexed attribute, anchor code

Syntax


jsobj.SetAnchor(index, value);
value = jsobj.GetAnchor(index);


R3INT value = ...;
R3SetAttrs(r3obj, R3GMPACKERA_Anchor, value, R3TAG_END);
R3INT value;
R3GetAttrs(r3obj, R3GMPACKERA_Anchor, &value, R3TAG_END);

Unmanage

Attribute

Unmanage

Identifier

R3GMPACKERA_Unmanage

JavaScript type

Boolean

C type

R3BOOL

Description

indexed attribute, don't manage this child

Syntax


jsobj.SetUnmanage(index, value);
value = jsobj.GetUnmanage(index);


R3BOOL value = ...;
R3SetAttrs(r3obj, R3GMPACKERA_Unmanage, value, R3TAG_END);
R3BOOL value;
R3GetAttrs(r3obj, R3GMPACKERA_Unmanage, &value, R3TAG_END);

PadX

Attribute

PadX

Identifier

R3GMPACKERA_PadX

JavaScript type

Number

C type

R3FLOAT

Description

indexed attribute, pad in x

Syntax


jsobj.SetPadX(index, value);
value = jsobj.GetPadX(index);


R3FLOAT value = ...;
R3SetAttrs(r3obj, R3GMPACKERA_PadX, value, R3TAG_END);
R3FLOAT value;
R3GetAttrs(r3obj, R3GMPACKERA_PadX, &value, R3TAG_END);

PadY

Attribute

PadY

Identifier

R3GMPACKERA_PadY

JavaScript type

Number

C type

R3FLOAT

Description

indexed attribute, pad in y

Syntax


jsobj.SetPadY(index, value);
value = jsobj.GetPadY(index);


R3FLOAT value = ...;
R3SetAttrs(r3obj, R3GMPACKERA_PadY, value, R3TAG_END);
R3FLOAT value;
R3GetAttrs(r3obj, R3GMPACKERA_PadY, &value, R3TAG_END);

PadZ

Attribute

PadZ

Identifier

R3GMPACKERA_PadZ

JavaScript type

Number

C type

R3FLOAT

Description

indexed attribute, pad in z

Syntax


jsobj.SetPadZ(index, value);
value = jsobj.GetPadZ(index);


R3FLOAT value = ...;
R3SetAttrs(r3obj, R3GMPACKERA_PadZ, value, R3TAG_END);
R3FLOAT value;
R3GetAttrs(r3obj, R3GMPACKERA_PadZ, &value, R3TAG_END);

IPadX

Attribute

IPadX

Identifier

R3GMPACKERA_IPadX

JavaScript type

Number

C type

R3FLOAT

Description

indexed attribute, internal pad in x

Syntax


jsobj.SetIPadX(index, value);
value = jsobj.GetIPadX(index);


R3FLOAT value = ...;
R3SetAttrs(r3obj, R3GMPACKERA_IPadX, value, R3TAG_END);
R3FLOAT value;
R3GetAttrs(r3obj, R3GMPACKERA_IPadX, &value, R3TAG_END);

IPadY

Attribute

IPadY

Identifier

R3GMPACKERA_IPadY

JavaScript type

Number

C type

R3FLOAT

Description

indexed attribute, internal pad in y

Syntax


jsobj.SetIPadY(index, value);
value = jsobj.GetIPadY(index);


R3FLOAT value = ...;
R3SetAttrs(r3obj, R3GMPACKERA_IPadY, value, R3TAG_END);
R3FLOAT value;
R3GetAttrs(r3obj, R3GMPACKERA_IPadY, &value, R3TAG_END);

IPadZ

Attribute

IPadZ

Identifier

R3GMPACKERA_IPadZ

JavaScript type

Number

C type

R3FLOAT

Description

indexed attribute, internal padd in z

Syntax


jsobj.SetIPadZ(index, value);
value = jsobj.GetIPadZ(index);


R3FLOAT value = ...;
R3SetAttrs(r3obj, R3GMPACKERA_IPadZ, value, R3TAG_END);
R3FLOAT value;
R3GetAttrs(r3obj, R3GMPACKERA_IPadZ, &value, R3TAG_END);

DefaultAnchor

Attribute

DefaultAnchor

Identifier

R3GMPACKERA_DefaultAnchor

JavaScript type

Integer

C type

R3INT

Description

default anchor option for the newly added slaves

Syntax


jsobj.SetDefaultAnchor(value);
value = jsobj.GetDefaultAnchor();


R3INT value = ...;
R3SetAttrs(r3obj, R3GMPACKERA_DefaultAnchor, value, R3TAG_END);
R3INT value;
R3GetAttrs(r3obj, R3GMPACKERA_DefaultAnchor, &value, R3TAG_END);

DefaultExpand

Attribute

DefaultExpand

Identifier

R3GMPACKERA_DefaultExpand

JavaScript type

Boolean

C type

R3BOOL

Description

default expand option for the newly added slaves

Syntax


jsobj.SetDefaultExpand(value);
value = jsobj.GetDefaultExpand();


R3BOOL value = ...;
R3SetAttrs(r3obj, R3GMPACKERA_DefaultExpand, value, R3TAG_END);
R3BOOL value;
R3GetAttrs(r3obj, R3GMPACKERA_DefaultExpand, &value, R3TAG_END);

DefaultFillX

Attribute

DefaultFillX

Identifier

R3GMPACKERA_DefaultFillX

JavaScript type

Boolean

C type

R3BOOL

Description

default fill x for the slaves

Syntax


jsobj.SetDefaultFillX(value);
value = jsobj.GetDefaultFillX();


R3BOOL value = ...;
R3SetAttrs(r3obj, R3GMPACKERA_DefaultFillX, value, R3TAG_END);
R3BOOL value;
R3GetAttrs(r3obj, R3GMPACKERA_DefaultFillX, &value, R3TAG_END);

DefaultFillY

Attribute

DefaultFillY

Identifier

R3GMPACKERA_DefaultFillY

JavaScript type

Boolean

C type

R3BOOL

Description

default fill y for slaves

Syntax


jsobj.SetDefaultFillY(value);
value = jsobj.GetDefaultFillY();


R3BOOL value = ...;
R3SetAttrs(r3obj, R3GMPACKERA_DefaultFillY, value, R3TAG_END);
R3BOOL value;
R3GetAttrs(r3obj, R3GMPACKERA_DefaultFillY, &value, R3TAG_END);

DefaultFillZ

Attribute

DefaultFillZ

Identifier

R3GMPACKERA_DefaultFillZ

JavaScript type

Boolean

C type

R3BOOL

Description

default fill z for slaves

Syntax


jsobj.SetDefaultFillZ(value);
value = jsobj.GetDefaultFillZ();


R3BOOL value = ...;
R3SetAttrs(r3obj, R3GMPACKERA_DefaultFillZ, value, R3TAG_END);
R3BOOL value;
R3GetAttrs(r3obj, R3GMPACKERA_DefaultFillZ, &value, R3TAG_END);

Codes for R3GMPACKERA_Orientation codes

R3GMPO_HORIZONTAL
R3GMPO_VERTICAL
R3GMPO_NORMAL

Codes for R3GMPACKERA_Anchor

R3GMPAF_CENTER
R3GMPAF_N
R3GMPAF_NE
R3GMPAF_E
R3GMPAF_SE
R3GMPAF_S
R3GMPAF_SW
R3GMPAF_W
R3GMPAF_NW
R3GMPAF_ALIGN

<sect8> <title>r3gmrepl</title>

r3gmrepl

Class

plugins/objects/gmanag/r3gmrepl.h

Library

r3gmanag

Description:

Replicator Geometry Manager. Repls sub objects.

See Also

plugins/objects/gmanag/r3gmpack.h

Super Class

r3Gmpacker

R3CLID_GMPACKER

JavaScript

r3Gmreplicator

Class Identifier

R3CLID_GMREPLICATOR - 2627

Methods

Attributes

MinCount,

MinCount

Attribute

MinCount

Identifier

R3GMREPLICATORA_MinCount

JavaScript type

Integer

C type

R3INT

Description

minimum slave count

Syntax


jsobj.SetMinCount(value);
value = jsobj.GetMinCount();


R3INT value = ...;
R3SetAttrs(r3obj, R3GMREPLICATORA_MinCount, value, R3TAG_END);
R3INT value;
R3GetAttrs(r3obj, R3GMREPLICATORA_MinCount, &value, R3TAG_END);

</sect8>
</sect7>
</sect6>
<sect6> <title>r3invkin</title>

r3invkin

Class

plugins/objects/invkin/r3invkin.h

Library

r3invkin

Description:

Inv.kinem constructor. Applies I.K to the joint it is associated with.

See Also

real/objects/r3constructor.h

Super Class

r3Constructor

R3CLID_CONSTRUCTOR

JavaScript

r3Invkin

Class Identifier

R3CLID_INVKIN - 2466

Methods

Attributes

Position, Direction, Snapto, Radius, Weight,

Position

Attribute

Position

Identifier

R3INVKINA_Position

Type

r3Vect

Description

INVKIN point

Syntax


jsobj.SetPosition(value);
value = jsobj.GetPosition();


R3VECTOR value = ...;
R3SetAttrs(r3obj, R3INVKINA_Position, value, R3TAG_END);
R3VECTOR value;
R3GetAttrs(r3obj, R3INVKINA_Position, &value, R3TAG_END);

Direction

Attribute

Direction

Identifier

R3INVKINA_Direction

Type

r3Vect

Description

second point defining banking

Syntax


jsobj.SetDirection(value);
value = jsobj.GetDirection();


R3VECTOR value = ...;
R3SetAttrs(r3obj, R3INVKINA_Direction, value, R3TAG_END);
R3VECTOR value;
R3GetAttrs(r3obj, R3INVKINA_Direction, &value, R3TAG_END);

Snapto

Attribute

Snapto

Identifier

R3INVKINA_Snapto

JavaScript type

Boolean

C type

R3BOOL

Description

if set snap to center, otherwise maintain relative position

Syntax


jsobj.SetSnapto(value);
value = jsobj.GetSnapto();


R3BOOL value = ...;
R3SetAttrs(r3obj, R3INVKINA_Snapto, value, R3TAG_END);
R3BOOL value;
R3GetAttrs(r3obj, R3INVKINA_Snapto, &value, R3TAG_END);

Radius

Attribute

Radius

Identifier

R3INVKINA_Radius

JavaScript type

Number

C type

R3FLOAT

Description

radius

Syntax


jsobj.SetRadius(value);
value = jsobj.GetRadius();


R3FLOAT value = ...;
R3SetAttrs(r3obj, R3INVKINA_Radius, value, R3TAG_END);
R3FLOAT value;
R3GetAttrs(r3obj, R3INVKINA_Radius, &value, R3TAG_END);

Weight

Attribute

Weight

Identifier

R3INVKINA_Weight

JavaScript type

Number

C type

R3FLOAT

Description

weight

Syntax


jsobj.SetWeight(value);
value = jsobj.GetWeight();


R3FLOAT value = ...;
R3SetAttrs(r3obj, R3INVKINA_Weight, value, R3TAG_END);
R3FLOAT value;
R3GetAttrs(r3obj, R3INVKINA_Weight, &value, R3TAG_END);

</sect6>
<sect6> <title>r3lattic</title>

r3lattic

Class

real/objects/r3lattic.h

Library

r3obj

Description:

3D Lattice.

See Also

real/objects/r3constructor.h

Super Class

r3Constructor

R3CLID_CONSTRUCTOR

JavaScript

r3Lattice

Class Identifier

R3CLID_LATTICE - 320

Methods

REPARAM,

Attributes

Points, CountU, CountV, CountW, OrderU, OrderV, OrderW, Points3,

Registration

int R3RegisterLatticeClass(R3APP *app);

R3LATTM_REPARAM

Method

REPARAM

Identifier

R3LATTM_REPARAM

Return

R3VECTOR, new reparametrized points or NULL.

Param 1:

R3INT, number of points in u dimension

Param 2:

R3INT, number of points in v dimension

Param 3:

R3INT, number of points in w dimension

JavaScript

rc = obj.REPARAM(p1, p2, p3);

Description

Reparametrize the lattice object. The minimum number of points in each dimension is 4.

Points

Attribute

Points

Identifier

R3LATTA_Points

Type

r3Vect

Description

control points

Syntax


jsobj.SetPoints(value);
value = jsobj.GetPoints();


R3VECTOR* value = ...;
R3SetAttrs(r3obj, R3LATTA_Points, value, R3TAG_END);
R3VECTOR* value;
R3GetAttrs(r3obj, R3LATTA_Points, &value, R3TAG_END);

CountU

Attribute

CountU

Identifier

R3LATTA_CountU

JavaScript type

Integer

C type

R3INT

Description

number of control points

Syntax


jsobj.SetCountU(value);
value = jsobj.GetCountU();


R3INT value = ...;
R3SetAttrs(r3obj, R3LATTA_CountU, value, R3TAG_END);
R3INT value;
R3GetAttrs(r3obj, R3LATTA_CountU, &value, R3TAG_END);

CountV

Attribute

CountV

Identifier

R3LATTA_CountV

JavaScript type

Integer

C type

R3INT

Description

number of control points

Syntax


jsobj.SetCountV(value);
value = jsobj.GetCountV();


R3INT value = ...;
R3SetAttrs(r3obj, R3LATTA_CountV, value, R3TAG_END);
R3INT value;
R3GetAttrs(r3obj, R3LATTA_CountV, &value, R3TAG_END);

CountW

Attribute

CountW

Identifier

R3LATTA_CountW

JavaScript type

Integer

C type

R3INT

Description

number of control points

Syntax


jsobj.SetCountW(value);
value = jsobj.GetCountW();


R3INT value = ...;
R3SetAttrs(r3obj, R3LATTA_CountW, value, R3TAG_END);
R3INT value;
R3GetAttrs(r3obj, R3LATTA_CountW, &value, R3TAG_END);

OrderU

Attribute

OrderU

Identifier

R3LATTA_OrderU

JavaScript type

Integer

C type

int

Description

unused, always cubic

Syntax


value = jsobj.GetOrderU();


int value;
R3GetAttrs(r3obj, R3LATTA_OrderU, &value, R3TAG_END);

OrderV

Attribute

OrderV

Identifier

R3LATTA_OrderV

JavaScript type

Integer

C type

int

Description

unused, always cubic,

Syntax


value = jsobj.GetOrderV();


int value;
R3GetAttrs(r3obj, R3LATTA_OrderV, &value, R3TAG_END);

OrderW

Attribute

OrderW

Identifier

R3LATTA_OrderW

JavaScript type

Integer

C type

int

Description

unused, always cubic

Syntax


value = jsobj.GetOrderW();


int value;
R3GetAttrs(r3obj, R3LATTA_OrderW, &value, R3TAG_END);

Points3

Attribute

Points3

Identifier

R3LATTA_Points3

Type

r3Vect

Description

unused, uses R3VECTOR4 always

Syntax


jsobj.SetPoints3(value);
value = jsobj.GetPoints3();


R3VECTOR* value = ...;
R3SetAttrs(r3obj, R3LATTA_Points3, value, R3TAG_END);
R3VECTOR* value;
R3GetAttrs(r3obj, R3LATTA_Points3, &value, R3TAG_END);


r3appobj *

</sect6>
<sect6> <title>r3lookat</title>

r3lookat

Class

plugins/objects/lookat/r3lookat.h

Library

r3lookat

Description:

Look at constructor. Maintains the orientation of the target object relative to the position of the object.

See Also

real/objects/r3constructor.h

Super Class

r3Constructor

R3CLID_CONSTRUCTOR

JavaScript

r3Lookat

Class Identifier

R3CLID_LOOKAT - 2436

Methods

Attributes

Position, Direction, Heading, Pitching, Banking, OrigPosition,

Position

Attribute

Position

Identifier

R3LOOKATA_Position

Type

r3Vect

Description

lookat point

Syntax


jsobj.SetPosition(value);
value = jsobj.GetPosition();


R3VECTOR value = ...;
R3SetAttrs(r3obj, R3LOOKATA_Position, value, R3TAG_END);
R3VECTOR value;
R3GetAttrs(r3obj, R3LOOKATA_Position, &value, R3TAG_END);

Direction

Attribute

Direction

Identifier

R3LOOKATA_Direction

Type

r3Vect

Description

second point defining banking

Syntax


jsobj.SetDirection(value);
value = jsobj.GetDirection();


R3VECTOR value = ...;
R3SetAttrs(r3obj, R3LOOKATA_Direction, value, R3TAG_END);
R3VECTOR value;
R3GetAttrs(r3obj, R3LOOKATA_Direction, &value, R3TAG_END);

Heading

Attribute

Heading

Identifier

R3LOOKATA_Heading

JavaScript type

Boolean

C type

R3BOOL

Description

enable heading

Syntax


jsobj.SetHeading(value);
value = jsobj.GetHeading();


R3BOOL value = ...;
R3SetAttrs(r3obj, R3LOOKATA_Heading, value, R3TAG_END);
R3BOOL value;
R3GetAttrs(r3obj, R3LOOKATA_Heading, &value, R3TAG_END);

Pitching

Attribute

Pitching

Identifier

R3LOOKATA_Pitching

JavaScript type

Boolean

C type

R3BOOL

Description

enable pitching

Syntax


jsobj.SetPitching(value);
value = jsobj.GetPitching();


R3BOOL value = ...;
R3SetAttrs(r3obj, R3LOOKATA_Pitching, value, R3TAG_END);
R3BOOL value;
R3GetAttrs(r3obj, R3LOOKATA_Pitching, &value, R3TAG_END);

Banking

Attribute

Banking

Identifier

R3LOOKATA_Banking

JavaScript type

Boolean

C type

R3BOOL

Description

enable banking

Syntax


jsobj.SetBanking(value);
value = jsobj.GetBanking();


R3BOOL value = ...;
R3SetAttrs(r3obj, R3LOOKATA_Banking, value, R3TAG_END);
R3BOOL value;
R3GetAttrs(r3obj, R3LOOKATA_Banking, &value, R3TAG_END);

OrigPosition

Attribute

OrigPosition

Identifier

R3LOOKATA_OrigPosition

Type

r3Vect

Description

velocity

Syntax


jsobj.SetOrigPosition(value);
value = jsobj.GetOrigPosition();


R3VECTOR value = ...;
R3SetAttrs(r3obj, R3LOOKATA_OrigPosition, value, R3TAG_END);
R3VECTOR value;
R3GetAttrs(r3obj, R3LOOKATA_OrigPosition, &value, R3TAG_END);

lookat needs to save the original position of the target object

R3LOOKATH_JOINT
R3LOOKATH_EDGE

</sect6>
<sect6> <title>r3moveconstructor</title>

r3moveconstructor

Class

real/objects/r3moveconstructor.h

Library

r3obj

Description:

Move constructor class

See Also

real/objects/r3constructor.h

Super Class

r3Constructor

R3CLID_CONSTRUCTOR

JavaScript

r3Moveconstructor

Class Identifier

R3CLID_MOVECONSTRUCTOR - 1811

Methods

Attributes

Position, Direction, Delta,

Registration

int R3RegisterMoveConstructorClass(R3APP *app);

Position

Attribute

Position

Identifier

R3MOVECONSTRUCTORA_Position

Type

r3Vect

Description

origin of the translation vector

Syntax


jsobj.SetPosition(value);
value = jsobj.GetPosition();


R3VECTOR value = ...;
R3SetAttrs(r3obj, R3MOVECONSTRUCTORA_Position, value, R3TAG_END);
R3VECTOR value;
R3GetAttrs(r3obj, R3MOVECONSTRUCTORA_Position, &value, R3TAG_END);

Direction

Attribute

Direction

Identifier

R3MOVECONSTRUCTORA_Direction

Type

r3Vect

Description

second point

Syntax


jsobj.SetDirection(value);
value = jsobj.GetDirection();


R3VECTOR value = ...;
R3SetAttrs(r3obj, R3MOVECONSTRUCTORA_Direction, value, R3TAG_END);
R3VECTOR value;
R3GetAttrs(r3obj, R3MOVECONSTRUCTORA_Direction, &value, R3TAG_END);

Delta

Attribute

Delta

Identifier

R3MOVECONSTRUCTORA_Delta

Type

r3Vect

Description

direction of the translation vector

Syntax


jsobj.SetDelta(value);
value = jsobj.GetDelta();


R3VECTOR value = ...;
R3SetAttrs(r3obj, R3MOVECONSTRUCTORA_Delta, value, R3TAG_END);
R3VECTOR value;
R3GetAttrs(r3obj, R3MOVECONSTRUCTORA_Delta, &value, R3TAG_END);

</sect6>
<sect6> <title>r3pathle</title>

r3pathle

Class

real/objects/r3pathle.h

Library

r3obj

Description:

Path level object. First sub object defiens a path and second sub object defines horizon plane (up direction axis) for convenient banking control

See Also

real/objects/r3constructor.h

Super Class

r3Constructor

R3CLID_CONSTRUCTOR

JavaScript

r3Pathlevel

Class Identifier

R3CLID_PATHLEVEL - 781

Methods

UPDATEORIGSTATE,

Attributes

Type, ConstantSpeed, Origin, End,

R3RPALM_UPDATEORIGSTATE

Method

UPDATEORIGSTATE

Identifier

R3RPALM_UPDATEORIGSTATE

JavaScript

obj.UPDATEORIGSTATE();

Description

Update original space from the current sub object.

Type

Attribute

Type

Identifier

R3PALA_Type

JavaScript type

Integer

C type

R3INT

Description

orientation control method, see defines below

Syntax


jsobj.SetType(value);
value = jsobj.GetType();


R3INT value = ...;
R3SetAttrs(r3obj, R3PALA_Type, value, R3TAG_END);
R3INT value;
R3GetAttrs(r3obj, R3PALA_Type, &value, R3TAG_END);

ConstantSpeed

Attribute

ConstantSpeed

Identifier

R3PALA_ConstantSpeed

JavaScript type

Boolean

C type

R3BOOL

Description

if true path is evaluated at constant curve length speed

Syntax


jsobj.SetConstantSpeed(value);
value = jsobj.GetConstantSpeed();


R3BOOL value = ...;
R3SetAttrs(r3obj, R3PALA_ConstantSpeed, value, R3TAG_END);
R3BOOL value;
R3GetAttrs(r3obj, R3PALA_ConstantSpeed, &value, R3TAG_END);

Origin

Attribute

Origin

Identifier

R3PALA_Origin

Type

r3Vect

Description

origin of axis

Syntax


jsobj.SetOrigin(value);
value = jsobj.GetOrigin();


R3VECTOR value = ...;
R3SetAttrs(r3obj, R3PALA_Origin, value, R3TAG_END);
R3VECTOR value;
R3GetAttrs(r3obj, R3PALA_Origin, &value, R3TAG_END);

End

Attribute

End

Identifier

R3PALA_End

Type

r3Vect

Description

end of axis

Syntax


jsobj.SetEnd(value);
value = jsobj.GetEnd();


R3VECTOR value = ...;
R3SetAttrs(r3obj, R3PALA_End, value, R3TAG_END);
R3VECTOR value;
R3GetAttrs(r3obj, R3PALA_End, &value, R3TAG_END);

R3PATH_NOBANKING
R3PATH_NATURALBANKING
R3PATH_CUMULATIVEBANKING
R3PATH_LOCALBANKING
R3PATH_NOROTATION

</sect6>
<sect6> <title>r3pointdisplacer</title>

r3pointdisplacer

Class

plugins/objects/pointdisplacer/r3pointdisplacer.h

Library

r3pointdisplacer

Description:

Point displacer object. Displaces points of all objects on the same hierarchy level by the value of a given field defined by the material system.

See Also

real/objects/r3constructor.h

Super Class

r3Constructor

R3CLID_CONSTRUCTOR

JavaScript

r3Pointdisplacer

Class Identifier

R3CLID_POINTDISPLACER - 1808

Methods

REGISTERH, TRANSFORMP,

Attributes

Clid, ChannelNam, Space, Scale, 1D,

Registration

int R3RegisterPointDisplacerClass(R3APP *app);

R3POINTDISPLACERCM_REGISTERH

Method

REGISTERH

Identifier

R3POINTDISPLACERCM_REGISTERH

Param 1:

R3CLID, object clid

JavaScript

obj.REGISTERH(p1, 0);

Description

R3POINTDISPLACERM_TRANSFORMP

Method

TRANSFORMP

Identifier

R3POINTDISPLACERM_TRANSFORMP

Return

R3BOOL, true if succeeded.

Param 3:

R3VECTOR, point to be transformed

JavaScript

rc = obj.TRANSFORMP(p3);

Description

Transform given point in space defined by given coord system

Clid

Attribute

Clid

Identifier

R3POINTDISPLACERA_Clid

JavaScript type

Integer

C type

R3INT

Description

field to be evaluated

Syntax


jsobj.SetClid(value);
value = jsobj.GetClid();


R3INT value = ...;
R3SetAttrs(r3obj, R3POINTDISPLACERA_Clid, value, R3TAG_END);
R3INT value;
R3GetAttrs(r3obj, R3POINTDISPLACERA_Clid, &value, R3TAG_END);

ChannelNam

Attribute

ChannelNam

Identifier

R3POINTDISPLACERA_ChannelNam

JavaScript type

String

C type

char*

Description

name of the channel to be evaluated

Syntax


jsobj.SetChannelNam(value);
value = jsobj.GetChannelNam();


char* value = ...;
R3SetAttrs(r3obj, R3POINTDISPLACERA_ChannelName, value, R3TAG_END);
char* value;
R3GetAttrs(r3obj, R3POINTDISPLACERA_ChannelName, &value, R3TAG_END);

Space

Attribute

Space

Identifier

R3POINTDISPLACERA_Space

JavaScript type

Integer

C type

R3INT

Description

see spaces below

Syntax


jsobj.SetSpace(value);
value = jsobj.GetSpace();


R3INT value = ...;
R3SetAttrs(r3obj, R3POINTDISPLACERA_Space, value, R3TAG_END);
R3INT value;
R3GetAttrs(r3obj, R3POINTDISPLACERA_Space, &value, R3TAG_END);

Scale

Attribute

Scale

Identifier

R3POINTDISPLACERA_Scale

JavaScript type

Number

C type

R3FLOAT

Description

Syntax


jsobj.SetScale(value);
value = jsobj.GetScale();


R3FLOAT value = ...;
R3SetAttrs(r3obj, R3POINTDISPLACERA_Scale, value, R3TAG_END);
R3FLOAT value;
R3GetAttrs(r3obj, R3POINTDISPLACERA_Scale, &value, R3TAG_END);

1D

Attribute

1D

Identifier

R3POINTDISPLACERA_1D

JavaScript type

Boolean

C type

R3BOOL

Description

displace only in 'z' direction

Syntax


jsobj.Set1D(value);
value = jsobj.Get1D();


R3BOOL value = ...;
R3SetAttrs(r3obj, R3POINTDISPLACERA_1D, value, R3TAG_END);
R3BOOL value;
R3GetAttrs(r3obj, R3POINTDISPLACERA_1D, &value, R3TAG_END);

spaces

R3PDSPACE_ABSOLUTE
R3PDSPACE_OBJECT
R3PDSPACE_UVW

Registry function

</sect6>
<sect6> <title>r3radialdeformer</title>

r3radialdeformer

Class

plugins/objects/pointdisplacer/r3radialdeformer.h

Library

r3pointdisplacer

Description:

Radial deformator

See Also

real/objects/r3constructor.h

Super Class

r3Constructor

R3CLID_CONSTRUCTOR

JavaScript

r3Radialdeformer

Class Identifier

R3CLID_RADIALDEFORMER - 1785

Methods

CHANGED,

Attributes

Center, Size, Type, Curve, OrigCenter, OrigSize, EnableCurve, CurvePoints, CurvePointCount, CurvePointSize, NoiseSize, NoiseDensity,

Registration

int R3RegisterRadialDeformerClass(R3APP *app);

R3RADDEFM_CHANGED

Method

CHANGED

Identifier

R3RADDEFM_CHANGED

JavaScript

obj.CHANGED();

Description

Private, maps curve changes to us so that we can animate them.

Center

Attribute

Center

Identifier

R3RADDEFA_Center

Type

r3Vect

Description

current center

Syntax


jsobj.SetCenter(value);
value = jsobj.GetCenter();


R3VECTOR value = ...;
R3SetAttrs(r3obj, R3RADDEFA_Center, value, R3TAG_END);
R3VECTOR value;
R3GetAttrs(r3obj, R3RADDEFA_Center, &value, R3TAG_END);

Size

Attribute

Size

Identifier

R3RADDEFA_Size

JavaScript type

Number

C type

R3FLOAT

Description

current size

Syntax


jsobj.SetSize(value);
value = jsobj.GetSize();


R3FLOAT value = ...;
R3SetAttrs(r3obj, R3RADDEFA_Size, value, R3TAG_END);
R3FLOAT value;
R3GetAttrs(r3obj, R3RADDEFA_Size, &value, R3TAG_END);

Type

Attribute

Type

Identifier

R3RADDEFA_Type

JavaScript type

Integer

C type

R3INT

Description

see types below

Syntax


jsobj.SetType(value);
value = jsobj.GetType();


R3INT value = ...;
R3SetAttrs(r3obj, R3RADDEFA_Type, value, R3TAG_END);
R3INT value;
R3GetAttrs(r3obj, R3RADDEFA_Type, &value, R3TAG_END);

Curve

Attribute

Curve

Identifier

R3RADDEFA_Curve

JavaScript type

Object

C type

R3OBJ*

Description

deformation curve

Syntax


jsobj.SetCurve(value);
value = jsobj.GetCurve();


R3OBJ* value = ...;
R3SetAttrs(r3obj, R3RADDEFA_Curve, value, R3TAG_END);
R3OBJ* value;
R3GetAttrs(r3obj, R3RADDEFA_Curve, &value, R3TAG_END);

OrigCenter

Attribute

OrigCenter

Identifier

R3RADDEFA_OrigCenter

Type

r3Vect

Description

original center point

Syntax


jsobj.SetOrigCenter(value);
value = jsobj.GetOrigCenter();


R3VECTOR value = ...;
R3SetAttrs(r3obj, R3RADDEFA_OrigCenter, value, R3TAG_END);
R3VECTOR value;
R3GetAttrs(r3obj, R3RADDEFA_OrigCenter, &value, R3TAG_END);

OrigSize

Attribute

OrigSize

Identifier

R3RADDEFA_OrigSize

JavaScript type

Number

C type

R3FLOAT

Description

original size point

Syntax


jsobj.SetOrigSize(value);
value = jsobj.GetOrigSize();


R3FLOAT value = ...;
R3SetAttrs(r3obj, R3RADDEFA_OrigSize, value, R3TAG_END);
R3FLOAT value;
R3GetAttrs(r3obj, R3RADDEFA_OrigSize, &value, R3TAG_END);

EnableCurve

Attribute

EnableCurve

Identifier

R3RADDEFA_EnableCurve

JavaScript type

Boolean

C type

R3BOOL

Description

enable interpolation curve

Syntax


jsobj.SetEnableCurve(value);
value = jsobj.GetEnableCurve();


R3BOOL value = ...;
R3SetAttrs(r3obj, R3RADDEFA_EnableCurve, value, R3TAG_END);
R3BOOL value;
R3GetAttrs(r3obj, R3RADDEFA_EnableCurve, &value, R3TAG_END);

CurvePoints

Attribute

CurvePoints

Identifier

R3RADDEFA_CurvePoints

JavaScript type

r3List

C type

R3LIST*

Description

curve points

Syntax


jsobj.SetCurvePoints(value);
value = jsobj.GetCurvePoints();


R3LIST* value = ...;
R3SetAttrs(r3obj, R3RADDEFA_CurvePoints, value, R3TAG_END);
R3LIST* value;
R3GetAttrs(r3obj, R3RADDEFA_CurvePoints, &value, R3TAG_END);

CurvePointCount

Attribute

CurvePointCount

Identifier

R3RADDEFA_CurvePointCount

JavaScript type

Integer

C type

R3INT

Description

number of curve points

Syntax


jsobj.SetCurvePointCount(value);
value = jsobj.GetCurvePointCount();


R3INT value = ...;
R3SetAttrs(r3obj, R3RADDEFA_CurvePointCount, value, R3TAG_END);
R3INT value;
R3GetAttrs(r3obj, R3RADDEFA_CurvePointCount, &value, R3TAG_END);

CurvePointSize

Attribute

CurvePointSize

Identifier

R3RADDEFA_CurvePointSize

JavaScript type

Integer

C type

R3INT

Description

sizeof curve point

Syntax


value = jsobj.GetCurvePointSize();


R3INT value;
R3GetAttrs(r3obj, R3RADDEFA_CurvePointSize, &value, R3TAG_END);

NoiseSize

Attribute

NoiseSize

Identifier

R3RADDEFA_NoiseSize

JavaScript type

Number

C type

R3FLOAT

Description

size of noise when R3RADDEFA_Type is R3RDTYPE_NOISE

Syntax


jsobj.SetNoiseSize(value);
value = jsobj.GetNoiseSize();


R3FLOAT value = ...;
R3SetAttrs(r3obj, R3RADDEFA_NoiseSize, value, R3TAG_END);
R3FLOAT value;
R3GetAttrs(r3obj, R3RADDEFA_NoiseSize, &value, R3TAG_END);

NoiseDensity

Attribute

NoiseDensity

Identifier

R3RADDEFA_NoiseDensity

JavaScript type

Number

C type

R3FLOAT

Description

density of noise when R3RADDEFA_Type is R3RDTYPE_NOISE

Syntax


jsobj.SetNoiseDensity(value);
value = jsobj.GetNoiseDensity();


R3FLOAT value = ...;
R3SetAttrs(r3obj, R3RADDEFA_NoiseDensity, value, R3TAG_END);
R3FLOAT value;
R3GetAttrs(r3obj, R3RADDEFA_NoiseDensity, &value, R3TAG_END);

Types

R3RDTYPE_LINEAR
R3RDTYPE_NOISE

</sect6>
<sect6> <title>r3rotatr</title>

r3rotatr

Class

real/objects/r3rotatr.h

Library

r3obj

Description:

Rotator object. Instances and transforms first sub object about the the second sub object.

See Also

real/objects/r3constructor.h

Super Class

r3Constructor

R3CLID_CONSTRUCTOR

JavaScript

r3Rotator

Class Identifier

R3CLID_ROTATOR - 313

Methods

UPDATETARGETS, END,

Attributes

AngleU, AngleV, CountU, CountV, TotalAngleU, TotalAngleV, CopyMethod, TranslationU, TranslationV, TotalTranslationU, TotalTranslationV,

R3RTRM_UPDATETARGETS

Method

UPDATETARGETS

Identifier

R3RTRM_UPDATETARGETS

Return

R3BOOL, TRUE if succeeded

JavaScript

rc = obj.UPDATETARGETS();

Description

Create/update instances according to the current attributes. This method is called when rotator object's attributes or sub objects are changed. If you want to change the behavior of the rotator object, catch this method.

R3RTRM_END

Method

END

Identifier

R3RTRM_END

JavaScript

obj.END();

Description

AngleU

Attribute

AngleU

Identifier

R3RTRA_AngleU

JavaScript type

Number

C type

R3FLOAT

Description

rotation between instances

Syntax


jsobj.SetAngleU(value);
value = jsobj.GetAngleU();


R3FLOAT value = ...;
R3SetAttrs(r3obj, R3RTRA_AngleU, value, R3TAG_END);
R3FLOAT value;
R3GetAttrs(r3obj, R3RTRA_AngleU, &value, R3TAG_END);

AngleV

Attribute

AngleV

Identifier

R3RTRA_AngleV

JavaScript type

Number

C type

R3FLOAT

Description

'R3RTRA_AngleV' not documented

Syntax


jsobj.SetAngleV(value);
value = jsobj.GetAngleV();


R3FLOAT value = ...;
R3SetAttrs(r3obj, R3RTRA_AngleV, value, R3TAG_END);
R3FLOAT value;
R3GetAttrs(r3obj, R3RTRA_AngleV, &value, R3TAG_END);

CountU

Attribute

CountU

Identifier

R3RTRA_CountU

JavaScript type

Integer

C type

R3INT

Description

number of instances

Syntax


jsobj.SetCountU(value);
value = jsobj.GetCountU();


R3INT value = ...;
R3SetAttrs(r3obj, R3RTRA_CountU, value, R3TAG_END);
R3INT value;
R3GetAttrs(r3obj, R3RTRA_CountU, &value, R3TAG_END);

CountV

Attribute

CountV

Identifier

R3RTRA_CountV

JavaScript type

Integer

C type

R3INT

Description

number of instances

Syntax


jsobj.SetCountV(value);
value = jsobj.GetCountV();


R3INT value = ...;
R3SetAttrs(r3obj, R3RTRA_CountV, value, R3TAG_END);
R3INT value;
R3GetAttrs(r3obj, R3RTRA_CountV, &value, R3TAG_END);

TotalAngleU

Attribute

TotalAngleU

Identifier

R3RTRA_TotalAngleU

JavaScript type

Number

C type

R3FLOAT

Description

angle between the first and the last object, optional

Syntax


jsobj.SetTotalAngleU(value);
value = jsobj.GetTotalAngleU();


R3FLOAT value = ...;
R3SetAttrs(r3obj, R3RTRA_TotalAngleU, value, R3TAG_END);
R3FLOAT value;
R3GetAttrs(r3obj, R3RTRA_TotalAngleU, &value, R3TAG_END);

TotalAngleV

Attribute

TotalAngleV

Identifier

R3RTRA_TotalAngleV

JavaScript type

Number

C type

R3FLOAT

Description

angle between the first and the last object, optional

Syntax


jsobj.SetTotalAngleV(value);
value = jsobj.GetTotalAngleV();


R3FLOAT value = ...;
R3SetAttrs(r3obj, R3RTRA_TotalAngleV, value, R3TAG_END);
R3FLOAT value;
R3GetAttrs(r3obj, R3RTRA_TotalAngleV, &value, R3TAG_END);

CopyMethod

Attribute

CopyMethod

Identifier

R3RTRA_CopyMethod

JavaScript type

Integer

C type

R3INT

Description

see copy methods below

Syntax


jsobj.SetCopyMethod(value);
value = jsobj.GetCopyMethod();


R3INT value = ...;
R3SetAttrs(r3obj, R3RTRA_CopyMethod, value, R3TAG_END);
R3INT value;
R3GetAttrs(r3obj, R3RTRA_CopyMethod, &value, R3TAG_END);

TranslationU

Attribute

TranslationU

Identifier

R3RTRA_TranslationU

JavaScript type

Number

C type

R3FLOAT

Description

displacement (along axis) between subsequent copies

Syntax


jsobj.SetTranslationU(value);
value = jsobj.GetTranslationU();


R3FLOAT value = ...;
R3SetAttrs(r3obj, R3RTRA_TranslationU, value, R3TAG_END);
R3FLOAT value;
R3GetAttrs(r3obj, R3RTRA_TranslationU, &value, R3TAG_END);

TranslationV

Attribute

TranslationV

Identifier

R3RTRA_TranslationV

JavaScript type

Number

C type

R3FLOAT

Description

displacement (along axis) between subsequent copies

Syntax


jsobj.SetTranslationV(value);
value = jsobj.GetTranslationV();


R3FLOAT value = ...;
R3SetAttrs(r3obj, R3RTRA_TranslationV, value, R3TAG_END);
R3FLOAT value;
R3GetAttrs(r3obj, R3RTRA_TranslationV, &value, R3TAG_END);

TotalTranslationU

Attribute

TotalTranslationU

Identifier

R3RTRA_TotalTranslationU

JavaScript type

Number

C type

R3FLOAT

Description

displacement between first and last

Syntax


jsobj.SetTotalTranslationU(value);
value = jsobj.GetTotalTranslationU();


R3FLOAT value = ...;
R3SetAttrs(r3obj, R3RTRA_TotalTranslationU, value, R3TAG_END);
R3FLOAT value;
R3GetAttrs(r3obj, R3RTRA_TotalTranslationU, &value, R3TAG_END);

TotalTranslationV

Attribute

TotalTranslationV

Identifier

R3RTRA_TotalTranslationV

JavaScript type

Number

C type

R3FLOAT

Description

displacement between first and last

Syntax


jsobj.SetTotalTranslationV(value);
value = jsobj.GetTotalTranslationV();


R3FLOAT value = ...;
R3SetAttrs(r3obj, R3RTRA_TotalTranslationV, value, R3TAG_END);
R3FLOAT value;
R3GetAttrs(r3obj, R3RTRA_TotalTranslationV, &value, R3TAG_END);

R3RTRCM_INSTANCE
R3RTRCM_DUPLICATE

Tags

Tags

R3RTRA_TargetID
</sect6>
<sect6> <title>r3shrink</title>

r3shrink

Class

real/objects/r3shrink.h

Library

r3obj

See Also

real/objects/r3constructor.h

Super Class

r3Constructor

R3CLID_CONSTRUCTOR

JavaScript

r3Shrink

Class Identifier

R3CLID_SHRINK - 641

Methods

Attributes

From, To,

From

Attribute

From

Identifier

R3SHRINKA_From

Type

r3Vect

Description

'R3SHRINKA_From' not documented

Syntax


jsobj.SetFrom(value);
value = jsobj.GetFrom();


R3VECTOR value = ...;
R3SetAttrs(r3obj, R3SHRINKA_From, value, R3TAG_END);
R3VECTOR value;
R3GetAttrs(r3obj, R3SHRINKA_From, &value, R3TAG_END);

To

Attribute

To

Identifier

R3SHRINKA_To

Type

r3Vect

Description

... defining the direction of the gravity

Syntax


jsobj.SetTo(value);
value = jsobj.GetTo();


R3VECTOR value = ...;
R3SetAttrs(r3obj, R3SHRINKA_To, value, R3TAG_END);
R3VECTOR value;
R3GetAttrs(r3obj, R3SHRINKA_To, &value, R3TAG_END);

Tags

Tags

R3SHRINKA_PrevPoints
</sect6>
<sect6> <title>r3skel</title>

r3skel

Class

real/objects/r3skel.h

Library

r3obj

Description:

Skeleton Class

See Also

real/objects/r3constructor.h

See Also

oops/r3vect.h

Super Class

r3Constructor

R3CLID_CONSTRUCTOR

JavaScript

r3Skeleton

Class Identifier

R3CLID_SKELETON - 133

Methods

GETJOINT, SETJOINT, FINDNEARESTJOINT, GETBONESPACE, EVALJOINTSPACE, ATTACHTOPARENT, ANCHORJOINT, RIGIDJOINT, RESETJOINT, ANIMJOINTASANGLE, GETJOINTFLAG, ISJOINTSSELECTED, SETJOINTFLAG, SETSELECTEDJOINTATTR, UPDATEPARENTDISPLACEME, RESETCONSTRAINTS, SETJOINTFLAGBYINDEX, REGISTERTAGNAMES, REGISTERINDEXEDTAGNAM, ISSELECTED, TRANSLATEMAPRAD, DUPMIRCHILDS, TRANSLATESELECTEDANGLE, BINDSKELETONBYVOLUME, BINDSKELETONNEAREST, BINDPOINTTONEARESTSKEL, TRANSLATEANGLES, FINDNEARESTBONE, BINDPOINTTOJOINT, RECONSTRUCTBYROOT, GETPREVBONESPACE, ROTATESELECTEDBONES, UPDATEANGLES, UPDATEPOSITIONS, BINDSELECTED, UNBINDPOINTFROMJOINT, UNBINDSELECTED, UNBINDPOINTFROMSKELETO, SETFIDELITYTOPOINT, SETFIDELITYTOSELECTED, SETWEIGHTTOPOINT, SETWEIGHTTOSELECTED, GETFIDELITYFROMPOINT, GETFIDELITYFROMSELECTE, GETWEIGHTFROMPOINT, GETWEIGHTFROMSELECTED, UNBINDSKELETON, UNBINDOBJECTFROMSKELET, TRANSLATESELECTEDMINAN, TRANSLATESELECTEDMAXAN, TRANSLATEMINANGLE, TRANSLATEMAXANGLE, GETROOTPOS, SELECTTARGETPOINTS, DESELECTTARGETPOINTS, BINDPOINTTOSKELETONBYV, DISPOSENATIVESTATE, BINDSELECTEDTONEAREST, BONEPARAMTOINDEX, BONEINDEXTOPARAM, FINDNEARESTSELECTEDBON, private2, GETORIGBONE, SETORIGBONE, GETBINDINGID, BINDOBJECTTOSKELETON,

Attributes

Joints, JointCount, CurrentMap, Type, ParentIndex, ParentOffset, AxisCA, AxisCB, AxisCC, Position0, AngleA, IKPosition, IKSampling, IKDepth, PreferredAnimMth, AngleB, AngleC, Angle, Length, UseMapVolume, MapRadius, Anchor, DrawConstraints, RotationHandles, MapCount, Interpolation, AngleSystem, MinAngle, MaxAngle, Thickness, JointPosition, AttachOrientation, AnimRootPos, DrawAngles, JointName,

R3SKM_GETJOINT

Method

GETJOINT

Identifier

R3SKM_GETJOINT

Return

R3BOOL, true if succeeded

Param 3:

R3INT, index

JavaScript

rc = obj.GETJOINT(p3);

Description

Get joint by index

R3SKM_SETJOINT

Method

SETJOINT

Identifier

R3SKM_SETJOINT

Return

R3BOOL

Param 3:

R3TAG*, R3SKA_JNumber, R3SKA_JValue

JavaScript

rc = obj.SETJOINT(p3);

Description

Set joint

R3SKM_FINDNEARESTJOINT

Method

FINDNEARESTJOINT

Identifier

R3SKM_FINDNEARESTJOINT

JavaScript

obj.FINDNEARESTJOINT();

Description

Given point in abs space, find nearest joint.

R3SKM_GETBONESPACE

Method

GETBONESPACE

Identifier

R3SKM_GETBONESPACE

Param 1:

R3INT, space (R3SPACE_ABSOLUTE, R3SPACE_OBJECT)

Param 2:

R3INT, bone index (joint index)

JavaScript

obj.GETBONESPACE(p1, p2, 0);

Description

Given joint index, return bone space.

R3SKM_EVALJOINTSPACE

Method

EVALJOINTSPACE

Identifier

R3SKM_EVALJOINTSPACE

Param 1:

R3VECTOR, polar coord.

Param 2:

R3COORDSYS, bone space

Param 3:

R3VECTOR, result

JavaScript

obj.EVALJOINTSPACE(p1, p2, p3);

Description

Given polar coord and bone space, evaluate direction vector. Returns norm. vector.

R3SKM_ATTACHTOPARENT

Method

ATTACHTOPARENT

Identifier

R3SKM_ATTACHTOPARENT

Return

R3BOOL, TRUE if parent was found

JavaScript

rc = obj.ATTACHTOPARENT();

Description

Attach skeleton to nearest joint of the parent skeleton.

R3SKM_ANCHORJOINT

Method

ANCHORJOINT

Identifier

R3SKM_ANCHORJOINT

Param 3:

R3INT, see anchor codes

JavaScript

obj.ANCHORJOINT(p3);

Description

Fix the position of the selected joints

R3SKM_RIGIDJOINT

Method

RIGIDJOINT

Identifier

R3SKM_RIGIDJOINT

Param 3:

R3BOOL, true/false

JavaScript

obj.RIGIDJOINT(p3);

Description

make the selected joints rigid (set the R3SKELF_RIGID flag)

R3SKM_RESETJOINT

Method

RESETJOINT

Identifier

R3SKM_RESETJOINT

JavaScript

obj.RESETJOINT();

Description

Clear anchor and rigid flags from selected joints

R3SKM_ANIMJOINTASANGLE

Method

ANIMJOINTASANGLE

Identifier

R3SKM_ANIMJOINTASANGLE

Param 3:

R3BOOL, enable/disable

JavaScript

obj.ANIMJOINTASANGLE(p3);

Description

Enable/disable IK keyframing/angle keyframing for the selected joints.

R3SKM_GETJOINTFLAG

Method

GETJOINTFLAG

Identifier

R3SKM_GETJOINTFLAG

Param 1:

R3INT, flag

Param 2:

R3BOOL*, conflict

Param 3:

R3BOOL*, state

JavaScript

obj.GETJOINTFLAG(p1, p2, p3);

Description

Get state of given joint flag.

R3SKM_ISJOINTSSELECTED

Method

ISJOINTSSELECTED

Identifier

R3SKM_ISJOINTSSELECTED

Return

R3BOOL, TRUE if points selected.

JavaScript

rc = obj.ISJOINTSSELECTED();

Description

check if there are selected joints in the skeleton hierarchy.

R3SKM_SETJOINTFLAG

Method

SETJOINTFLAG

Identifier

R3SKM_SETJOINTFLAG

Param 1:

R3INT, flag to be set,

Param 3:

R3BOOL, value

JavaScript

obj.SETJOINTFLAG(p1, p3);

Description

Set/Reset (recursively) given joint flag.

R3SKM_SETSELECTEDJOINTATTR

Method

SETSELECTEDJOINTATTR

Identifier

R3SKM_SETSELECTEDJOINTATTR

Param 3:

R3TAG*, tag list consisting of dynamic tags

JavaScript

obj.SETSELECTEDJOINTATTR(p3);

Description

Set joint attribute

R3SKM_UPDATEPARENTDISPLACEME

Method

UPDATEPARENTDISPLACEME

Identifier

R3SKM_UPDATEPARENTDISPLACEME

JavaScript

obj.UPDATEPARENTDISPLACEME();

Description

Update relative position in parent bone space.

R3SKM_RESETCONSTRAINTS

Method

RESETCONSTRAINTS

Identifier

R3SKM_RESETCONSTRAINTS

Param 3:

R3INT, joint index

JavaScript

obj.RESETCONSTRAINTS(p3);

Description

Reset constraints to their minimum values (current bone angles)

R3SKM_SETJOINTFLAGBYINDEX

Method

SETJOINTFLAGBYINDEX

Identifier

R3SKM_SETJOINTFLAGBYINDEX

Param 3:

R3BOOL, value

JavaScript

obj.SETJOINTFLAGBYINDEX(p3);

Description

Set joint flag

R3SKCM_REGISTERTAGNAMES

Method

REGISTERTAGNAMES

Identifier

R3SKCM_REGISTERTAGNAMES

Return

R3BOOL, true if succeeded.

JavaScript

rc = obj.REGISTERTAGNAMES();

Description

Register extension tagsname array. This is only needed in case dynamic tags needs to be accessed through through R3TAGNAME interface (i.e. to make dynamic tags animateable).

R3SKCM_REGISTERINDEXEDTAGNAM

Method

REGISTERINDEXEDTAGNAM

Identifier

R3SKCM_REGISTERINDEXEDTAGNAM

Return

R3BOOL, true if succeeded.

JavaScript

rc = obj.REGISTERINDEXEDTAGNAM();

Description

Register tag names for indexed dynamic tags.

R3SKM_ISSELECTED

Method

ISSELECTED

Identifier

R3SKM_ISSELECTED

Return

R3BOOL, true if selected

Param 3:

R3INT, index of the joint.

JavaScript

rc = obj.ISSELECTED(p3);

Description

Checks if one of the joint handles associated with 'give joint is selected.

R3SKM_TRANSLATEMAPRAD

Method

TRANSLATEMAPRAD

Identifier

R3SKM_TRANSLATEMAPRAD

Param 3:

R3FLOAT, delta

JavaScript

obj.TRANSLATEMAPRAD(p3);

Description

Translate SKA_MapRadius by given value

R3SKM_DUPMIRCHILDS

Method

DUPMIRCHILDS

Identifier

R3SKM_DUPMIRCHILDS

Return

R3BOOL, number of tentacles mirrored

Param 3:

R3INT, R3SKA_AngleA or R3SKA_AngleB. The default is R3SKA_AngleB (pitching)

JavaScript

rc = obj.DUPMIRCHILDS(p3);

Description

Duplicate and mirror child objects to create symmetric body. Allows the user to create left tentacles and get complete body by duplicating & mirroring them.

R3SKM_TRANSLATESELECTEDANGLE

Method

TRANSLATESELECTEDANGLE

Identifier

R3SKM_TRANSLATESELECTEDANGLE

Param 1:

R3BOOL, disable constraints

Param 3:

R3VECTOR, delta

JavaScript

obj.TRANSLATESELECTEDANGLE(p1, p3);

Description

Edit bone angles of the selected joints

R3SKM_BINDSKELETONBYVOLUME

Method

BINDSKELETONBYVOLUME

Identifier

R3SKM_BINDSKELETONBYVOLUME

Return

R3BOOL, true if succeeded.

Param 3:

R3OBJ*, target object to be attached.

JavaScript

rc = obj.BINDSKELETONBYVOLUME(p3);

Description

Attach skeleton to all target objects. Points are mapped based on * mapping volume / inside test. Each point may get mapped to more than one skeleton / bone.

R3SKM_BINDSKELETONNEAREST

Method

BINDSKELETONNEAREST

Identifier

R3SKM_BINDSKELETONNEAREST

Return

R3BOOL, true if succeeded.

Param 3:

R3OBJ*, target object to be attached.

JavaScript

rc = obj.BINDSKELETONNEAREST(p3);

Description

Attach skeleton to all target objects. Each point is attached to one * bone only, based on shortest distance.

R3SKM_BINDPOINTTONEARESTSKEL

Method

BINDPOINTTONEARESTSKEL

Identifier

R3SKM_BINDPOINTTONEARESTSKEL

Return

R3BOOL, true if succeeded

Param 1:

R3OBJ*, target object

Param 2:

R3INT, point index

Param 3:

R3VECTOR, target's point (in abs space) to be mapped.

JavaScript

rc = obj.BINDPOINTTONEARESTSKEL(p1, p2, p3);

Description

Attach given point to the nearest bone of the skeleton.

R3SKM_TRANSLATEANGLES

Method

TRANSLATEANGLES

Identifier

R3SKM_TRANSLATEANGLES

Param 1:

R3BOOL, if true, disable constraints (constraints are expanded, if needed)

Param 2:

R3INT, index of the bone

Param 3:

R3VECTOR, delta

JavaScript

obj.TRANSLATEANGLES(p1, p2, p3);

Description

Change the angles of the given joint.

R3SKM_FINDNEARESTBONE

Method

FINDNEARESTBONE

Identifier

R3SKM_FINDNEARESTBONE

Return

R3OBJ*, nearest skeleton

Param 1:

R3FLOAT, minimum distance, initialize this to max value prior calling.

Param 2:

R3FLOAT, parameter specifying the nearest bone

Param 3:

R3VECTOR, point to be mapped

JavaScript

rc = obj.FINDNEARESTBONE(p1, p2, p3);

Description

Given a point, find nearest skeleton and bone index in a hierarchical skeleton.

R3SKM_BINDPOINTTOJOINT

Method

BINDPOINTTOJOINT

Identifier

R3SKM_BINDPOINTTOJOINT

Param 3:

R3TAG*, R3SKA_JointParam, R3SKA_TargetIndex, R3SKA_TargetObject, R3SKA_MapId

JavaScript

obj.BINDPOINTTOJOINT(p3);

Description

Attach given target point to bone.

R3SKM_RECONSTRUCTBYROOT

Method

RECONSTRUCTBYROOT

Identifier

R3SKM_RECONSTRUCTBYROOT

JavaScript

obj.RECONSTRUCTBYROOT();

Description

R3SKM_GETPREVBONESPACE

Method

GETPREVBONESPACE

Identifier

R3SKM_GETPREVBONESPACE

Param 1:

R3INT, space in which the cs is returned (R3SPACE_ABSOLUTE, R3SPACE_OBJECT)

Param 2:

R3INT, index of the bone

Param 3:

R3COORDSYS, result buffer

JavaScript

obj.GETPREVBONESPACE(p1, p2, p3);

Description

Given bone index, returns the coord system of the previous bone.

R3SKM_ROTATESELECTEDBONES

Method

ROTATESELECTEDBONES

Identifier

R3SKM_ROTATESELECTEDBONES

Param 1:

R3VECTOR, rotation axis

Param 3:

R3FLOAT, angle

JavaScript

obj.ROTATESELECTEDBONES(p1, p3);

Description

Rotate selected bones.

R3SKM_UPDATEANGLES

Method

UPDATEANGLES

Identifier

R3SKM_UPDATEANGLES

Param 3:

R3BOOL, if true, propagates to children.

JavaScript

obj.UPDATEANGLES(p3);

Description

Update angles when one of the joint positions has changed.

R3SKM_UPDATEPOSITIONS

Method

UPDATEPOSITIONS

Identifier

R3SKM_UPDATEPOSITIONS

Param 1:

R3BOOL, if true, constraints are expanded, if needed.

Param 3:

R3BOOL, if true, bone lengths are updated.

JavaScript

obj.UPDATEPOSITIONS(p1, p3);

Description

Update joint positions when one or more bone angles has changed.

R3SKM_BINDSELECTED

Method

BINDSELECTED

Identifier

R3SKM_BINDSELECTED

Return

R3BOOL, true if succeeded

Param 3:

R3OBJ*, object to be attached

JavaScript

rc = obj.BINDSELECTED(p3);

Description

Attach selected points to selected bone.

R3SKM_UNBINDPOINTFROMJOINT

Method

UNBINDPOINTFROMJOINT

Identifier

R3SKM_UNBINDPOINTFROMJOINT

Param 3:

R3TAG*, R3SKA_TargetIndex, R3SKA_TargetObject, R3SKA_MapId

JavaScript

obj.UNBINDPOINTFROMJOINT(p3);

Description

Detach given point from the given joint. R3SKA_MapId is needed * if multi mapping is used to identify the map set. *

R3SKM_UNBINDSELECTED

Method

UNBINDSELECTED

Identifier

R3SKM_UNBINDSELECTED

Param 3:

R3OBJ*, target object to be detached.

JavaScript

obj.UNBINDSELECTED(p3);

Description

Detach selected points from the selected bone.

R3SKM_UNBINDPOINTFROMSKELETO

Method

UNBINDPOINTFROMSKELETO

Identifier

R3SKM_UNBINDPOINTFROMSKELETO

JavaScript

obj.UNBINDPOINTFROMSKELETO();

Description

Detach given point from the skeleton.

R3SKM_SETFIDELITYTOPOINT

Method

SETFIDELITYTOPOINT

Identifier

R3SKM_SETFIDELITYTOPOINT

Return

R3BOOL, true if succeeded

Param 1:

R3FLOAT, fidelity

Param 2:

R3INT, index of the target point

Param 3:

R3OBJ*, target object

JavaScript

rc = obj.SETFIDELITYTOPOINT(p1, p2, p3);

Description

Set fidelity of the given target point.

R3SKM_SETFIDELITYTOSELECTED

Method

SETFIDELITYTOSELECTED

Identifier

R3SKM_SETFIDELITYTOSELECTED

Param 1:

R3OBJ*, target object

Param 3:

R3FLOAT, fidelity

JavaScript

obj.SETFIDELITYTOSELECTED(p1, p3);

Description

Set fidelity to selected points attached to the selected bone.

R3SKM_SETWEIGHTTOPOINT

Method

SETWEIGHTTOPOINT

Identifier

R3SKM_SETWEIGHTTOPOINT

Return

R3BOOL, true if succeeded

Param 1:

R3FLOAT, weight

Param 2:

R3INT, index of the target point

Param 3:

R3OBJ*, target object

JavaScript

rc = obj.SETWEIGHTTOPOINT(p1, p2, p3);

Description

Set weight of the given target point. The stronger the weight, the stronger the bone affects the point.

R3SKM_SETWEIGHTTOSELECTED

Method

SETWEIGHTTOSELECTED

Identifier

R3SKM_SETWEIGHTTOSELECTED

Param 1:

R3OBJ*, target object

Param 3:

R3FLOAT, weight

JavaScript

obj.SETWEIGHTTOSELECTED(p1, p3);

Description

Set weight to selected points attached to the selected bone.

R3SKM_GETFIDELITYFROMPOINT

Method

GETFIDELITYFROMPOINT

Identifier

R3SKM_GETFIDELITYFROMPOINT

Return

R3BOOL, true if succeeded

Param 1:

R3FLOAT, fidelity

Param 2:

R3INT, index of the target point

Param 3:

R3OBJ*, target object

JavaScript

rc = obj.GETFIDELITYFROMPOINT(p1, p2, p3);

Description

Fetch fidelity of the given target point.

R3SKM_GETFIDELITYFROMSELECTE

Method

GETFIDELITYFROMSELECTE

Identifier

R3SKM_GETFIDELITYFROMSELECTE

Return

R3BOOL, true if all points had the same fidelitu value.

Param 1:

R3OBJ*, target object

Param 3:

R3FLOAT, fidelity

JavaScript

rc = obj.GETFIDELITYFROMSELECTE(p1, p3);

Description

Get fidelity from selected points attached to the selected bone.

R3SKM_GETWEIGHTFROMPOINT

Method

GETWEIGHTFROMPOINT

Identifier

R3SKM_GETWEIGHTFROMPOINT

Return

R3BOOL, true if succeeded

Param 1:

R3FLOAT, weight

Param 2:

R3INT, index of the target point

Param 3:

R3OBJ*, target object

JavaScript

rc = obj.GETWEIGHTFROMPOINT(p1, p2, p3);

Description

Get weight of the given target point. The stronger the weight, the stronger the bone affects the point.

R3SKM_GETWEIGHTFROMSELECTED

Method

GETWEIGHTFROMSELECTED

Identifier

R3SKM_GETWEIGHTFROMSELECTED

Return

R3BOOL, true if all points had the same weight.

Param 1:

R3OBJ*, target object

Param 3:

R3FLOAT, weight

JavaScript

rc = obj.GETWEIGHTFROMSELECTED(p1, p3);

Description

Get weight of the selected points attached to the selected bone.

R3SKM_UNBINDSKELETON

Method

UNBINDSKELETON

Identifier

R3SKM_UNBINDSKELETON

Param 3:

R3BOOL, keep target data

JavaScript

obj.UNBINDSKELETON(p3);

Description

Detach all objects from this skeleton. If p3 is true, binding information * associated with the target objects is not deleted.

R3SKM_UNBINDOBJECTFROMSKELET

Method

UNBINDOBJECTFROMSKELET

Identifier

R3SKM_UNBINDOBJECTFROMSKELET

Return

R3BOOL, true if succeeded

Param 1:

R3BOOL, if true unbinds sub objects as well

Param 3:

R3OBJ*, target object to be removed

JavaScript

rc = obj.UNBINDOBJECTFROMSKELET(p1, p3);

Description

Detach given object from the skeleton

R3SKM_TRANSLATESELECTEDMINAN

Method

TRANSLATESELECTEDMINAN

Identifier

R3SKM_TRANSLATESELECTEDMINAN

JavaScript

obj.TRANSLATESELECTEDMINAN();

Description

Edit min constraint angles

R3SKM_TRANSLATESELECTEDMAXAN

Method

TRANSLATESELECTEDMAXAN

Identifier

R3SKM_TRANSLATESELECTEDMAXAN

JavaScript

obj.TRANSLATESELECTEDMAXAN();

Description

Edit max constraint angles

R3SKM_TRANSLATEMINANGLE

Method

TRANSLATEMINANGLE

Identifier

R3SKM_TRANSLATEMINANGLE

Param 1:

R3INT, index of the joint

JavaScript

obj.TRANSLATEMINANGLE(p1, 0);

Description

Edit min constraint angle

R3SKM_TRANSLATEMAXANGLE

Method

TRANSLATEMAXANGLE

Identifier

R3SKM_TRANSLATEMAXANGLE

Param 1:

R3INT, index of the bone

JavaScript

obj.TRANSLATEMAXANGLE(p1, 0);

Description

Edit max constraint angle

R3SKM_GETROOTPOS

Method

GETROOTPOS

Identifier

R3SKM_GETROOTPOS

Param 1:

R3INT, space

JavaScript

obj.GETROOTPOS(p1, 0);

Description

Give the current root postion, as determined by our parent * skeleton and our displacement offset.

R3SKM_SELECTTARGETPOINTS

Method

SELECTTARGETPOINTS

Identifier

R3SKM_SELECTTARGETPOINTS

Return

R3INT, number of points selected

JavaScript

rc = obj.SELECTTARGETPOINTS();

Description

Select target points mapped to the selected bones of the skeleton

R3SKM_DESELECTTARGETPOINTS

Method

DESELECTTARGETPOINTS

Identifier

R3SKM_DESELECTTARGETPOINTS

Return

R3INT, number of points deselected

JavaScript

rc = obj.DESELECTTARGETPOINTS();

Description

Deselect target points mapped to the selected bones of the skeleton

R3SKM_BINDPOINTTOSKELETONBYV

Method

BINDPOINTTOSKELETONBYV

Identifier

R3SKM_BINDPOINTTOSKELETONBYV

Return

R3BOOL, true if succeeded

Param 1:

R3OBJ*, target object

Param 2:

R3INT, point index

Param 3:

R3VECTOR, target's point (in abs space) to be mapped.

JavaScript

rc = obj.BINDPOINTTOSKELETONBYV(p1, p2, p3);

Description

Attach given point to bones using mapping volume

R3SKM_DISPOSENATIVESTATE

Method

DISPOSENATIVESTATE

Identifier

R3SKM_DISPOSENATIVESTATE

JavaScript

obj.DISPOSENATIVESTATE();

Description

When skeleton is bound for the first time, native pose is allocated and created. * When skeleton is modified, the deformation is computed as nativepose -> currentpose. This method discards the native pose data. Called when the skeleton is unbind.

R3SKM_BINDSELECTEDTONEAREST

Method

BINDSELECTEDTONEAREST

Identifier

R3SKM_BINDSELECTEDTONEAREST

JavaScript

obj.BINDSELECTEDTONEAREST();

Description

Bind selected handles to nearest bones.

R3SKM_BONEPARAMTOINDEX

Method

BONEPARAMTOINDEX

Identifier

R3SKM_BONEPARAMTOINDEX

Param 1:

R3FLOAT, parameter value 0 ... 1

Param 3:

R3INT, joint index.

JavaScript

obj.BONEPARAMTOINDEX(p1, p3);

Description

Binding system uses normalized parametrization to specify points position on the skeleton so that deleting joints etc. can be easily handled. This method converts given bone parameter (0 ...1) to joint index.

R3SKM_BONEINDEXTOPARAM

Method

BONEINDEXTOPARAM

Identifier

R3SKM_BONEINDEXTOPARAM

Param 1:

R3INT, joint index 0 ... count-1

Param 3:

R3FLOAT, parameter value

JavaScript

obj.BONEINDEXTOPARAM(p1, p3);

Description

Binding system uses normalized parametrization to specify points position on the skeleton so that deleting joints etc. can be easily handled. This method converts given joint index to normalized parameter value.

R3SKM_FINDNEARESTSELECTEDBON

Method

FINDNEARESTSELECTEDBON

Identifier

R3SKM_FINDNEARESTSELECTEDBON

Return

R3OBJ*, nearest skeleton

Param 1:

R3FLOAT, minimum distance, initialize this to max value prior calling.

Param 2:

R3FLOAT, parameter specifying the bone

Param 3:

R3VECTOR, point

JavaScript

rc = obj.FINDNEARESTSELECTEDBON(p1, p2, p3);

Description

Given a point, find nearest skeleton and bone param in a hierarchical skeleton.

R3SKM_private2

Method

private2

Identifier

R3SKM_private2

JavaScript

obj.private2();

Description

R3SKM_GETORIGBONE

Method

GETORIGBONE

Identifier

R3SKM_GETORIGBONE

Return

R3BOOL, TRUE if initial orientation was found. FALSE if undefined

Param 1:

R3INT, bone index

Param 3:

R3COORDSYS, coordinate system

JavaScript

rc = obj.GETORIGBONE(p1, p3);

Description

Find out the initial bone orientation.

R3SKM_SETORIGBONE

Method

SETORIGBONE

Identifier

R3SKM_SETORIGBONE

Return

R3BOOL, true if succeeded

Param 1:

R3INT, index of the bone

JavaScript

rc = obj.SETORIGBONE(p1, 0);

Description

Set initial bone orientation. The transformation defined by * the bone is computed as 'current orientation - initial orientation'.

R3SKM_GETBINDINGID

Method

GETBINDINGID

Identifier

R3SKM_GETBINDINGID

Return

R3INT, binding identifier

Param 3:

R3INT, index (0 ... R3SKA_MapCount-1)

JavaScript

rc = obj.GETBINDINGID(p3);

Description

Given binding index, fetch the unique identifier specifying target objects bound * to this skeleton.

R3SKM_BINDOBJECTTOSKELETON

Method

BINDOBJECTTOSKELETON

Identifier

R3SKM_BINDOBJECTTOSKELETON

Return

R3INT, number of points bound

Param 1:

R3BOOL, if true binds sub objects as well

Param 3:

R3OBJ*, target to be bound

JavaScript

rc = obj.BINDOBJECTTOSKELETON(p1, p3);

Description

Bind all target points in the given target object to the nearest bones.

Joints

Attribute

Joints

Identifier

R3SKA_Joints

JavaScript type

String

C type

void*

Description

'R3SKA_Joints' not documented

Syntax


jsobj.SetJoints(value);
value = jsobj.GetJoints();


void* value = ...;
R3SetAttrs(r3obj, R3SKA_Joints, value, R3TAG_END);
void* value;
R3GetAttrs(r3obj, R3SKA_Joints, &value, R3TAG_END);

JointCount

Attribute

JointCount

Identifier

R3SKA_JointCount

JavaScript type

Integer

C type

int

Description

number of joints

Syntax


jsobj.SetJointCount(value);
value = jsobj.GetJointCount();


int value = ...;
R3SetAttrs(r3obj, R3SKA_JointCount, value, R3TAG_END);
int value;
R3GetAttrs(r3obj, R3SKA_JointCount, &value, R3TAG_END);

CurrentMap

Attribute

CurrentMap

Identifier

R3SKA_CurrentMap

JavaScript type

Integer

C type

R3INT

Description

index of the current map

Syntax


jsobj.SetCurrentMap(value);
value = jsobj.GetCurrentMap();


R3INT value = ...;
R3SetAttrs(r3obj, R3SKA_CurrentMap, value, R3TAG_END);
R3INT value;
R3GetAttrs(r3obj, R3SKA_CurrentMap, &value, R3TAG_END);

Type

Attribute

Type

Identifier

R3SKA_Type

JavaScript type

Integer

C type

R3INT

Description

see skeleton types below

Syntax


jsobj.SetType(value);
value = jsobj.GetType();


R3INT value = ...;
R3SetAttrs(r3obj, R3SKA_Type, value, R3TAG_END);
R3INT value;
R3GetAttrs(r3obj, R3SKA_Type, &value, R3TAG_END);

ParentIndex

Attribute

ParentIndex

Identifier

R3SKA_ParentIndex

JavaScript type

Integer

C type

R3INT

Description

R3SK_NOINDEX or 0 ... n

Syntax


jsobj.SetParentIndex(value);
value = jsobj.GetParentIndex();


R3INT value = ...;
R3SetAttrs(r3obj, R3SKA_ParentIndex, value, R3TAG_END);
R3INT value;
R3GetAttrs(r3obj, R3SKA_ParentIndex, &value, R3TAG_END);

ParentOffset

Attribute

ParentOffset

Identifier

R3SKA_ParentOffset

Type

r3Vect

Description

displacement from parent joint

Syntax


jsobj.SetParentOffset(value);
value = jsobj.GetParentOffset();


R3VECTOR value = ...;
R3SetAttrs(r3obj, R3SKA_ParentOffset, value, R3TAG_END);
R3VECTOR value;
R3GetAttrs(r3obj, R3SKA_ParentOffset, &value, R3TAG_END);

AxisCA

Attribute

AxisCA

Identifier

R3SKA_AxisCA

Type

r3Vect

Description

space for the first joint

Syntax


jsobj.SetAxisCA(value);
value = jsobj.GetAxisCA();


R3VECTOR value = ...;
R3SetAttrs(r3obj, R3SKA_AxisCA, value, R3TAG_END);
R3VECTOR value;
R3GetAttrs(r3obj, R3SKA_AxisCA, &value, R3TAG_END);

AxisCB

Attribute

AxisCB

Identifier

R3SKA_AxisCB

Type

r3Vect

Description

'R3SKA_AxisCB' not documented

Syntax


jsobj.SetAxisCB(value);
value = jsobj.GetAxisCB();


R3VECTOR value = ...;
R3SetAttrs(r3obj, R3SKA_AxisCB, value, R3TAG_END);
R3VECTOR value;
R3GetAttrs(r3obj, R3SKA_AxisCB, &value, R3TAG_END);

AxisCC

Attribute

AxisCC

Identifier

R3SKA_AxisCC

Type

r3Vect

Description

'R3SKA_AxisCC' not documented

Syntax


jsobj.SetAxisCC(value);
value = jsobj.GetAxisCC();


R3VECTOR value = ...;
R3SetAttrs(r3obj, R3SKA_AxisCC, value, R3TAG_END);
R3VECTOR value;
R3GetAttrs(r3obj, R3SKA_AxisCC, &value, R3TAG_END);

Position0

Attribute

Position0

Identifier

R3SKA_Position0

Type

r3Vect

Description

position of the root joint in object space

Syntax


jsobj.SetPosition0(value);
value = jsobj.GetPosition0();


R3VECTOR value = ...;
R3SetAttrs(r3obj, R3SKA_Position0, value, R3TAG_END);
R3VECTOR value;
R3GetAttrs(r3obj, R3SKA_Position0, &value, R3TAG_END);

AngleA

Attribute

AngleA

Identifier

R3SKA_AngleA

JavaScript type

Number

C type

R3FLOAT

Description

indexed, heading angle

Syntax


jsobj.SetAngleA(index, value);
value = jsobj.GetAngleA(index);


R3FLOAT value = ...;
R3SetAttrs(r3obj, R3SKA_AngleA, value, R3TAG_END);
R3FLOAT value;
R3GetAttrs(r3obj, R3SKA_AngleA, &value, R3TAG_END);

IKPosition

Attribute

IKPosition

Identifier

R3SKA_IKPosition

Type

r3Vect

Description

joint position in object space

Syntax


jsobj.SetIKPosition(index, value);
value = jsobj.GetIKPosition(index);


R3VECTOR value = ...;
R3SetAttrs(r3obj, R3SKA_IKPosition, value, R3TAG_END);
R3VECTOR value;
R3GetAttrs(r3obj, R3SKA_IKPosition, &value, R3TAG_END);

IKSampling

Attribute

IKSampling

Identifier

R3SKA_IKSampling

JavaScript type

Integer

C type

R3INT

Description

1 or higher, the higher the value, the better the I.K finds the solution, and the slower the I.K gets

Syntax


jsobj.SetIKSampling(value);
value = jsobj.GetIKSampling();


R3INT value = ...;
R3SetAttrs(r3obj, R3SKA_IKSampling, value, R3TAG_END);
R3INT value;
R3GetAttrs(r3obj, R3SKA_IKSampling, &value, R3TAG_END);

IKDepth

Attribute

IKDepth

Identifier

R3SKA_IKDepth

JavaScript type

Integer

C type

R3INT

Description

number of parent levels to be affected

Syntax


jsobj.SetIKDepth(value);
value = jsobj.GetIKDepth();


R3INT value = ...;
R3SetAttrs(r3obj, R3SKA_IKDepth, value, R3TAG_END);
R3INT value;
R3GetAttrs(r3obj, R3SKA_IKDepth, &value, R3TAG_END);

PreferredAnimMth

Attribute

PreferredAnimMth

Identifier

R3SKA_PreferredAnimMth

JavaScript type

Integer

C type

int

Description

enum r3skelanimmode, preferred way of animating

Syntax


jsobj.SetPreferredAnimMth(value);
value = jsobj.GetPreferredAnimMth();


int value = ...;
R3SetAttrs(r3obj, R3SKA_PreferredAnimMth, value, R3TAG_END);
int value;
R3GetAttrs(r3obj, R3SKA_PreferredAnimMth, &value, R3TAG_END);

AngleB

Attribute

AngleB

Identifier

R3SKA_AngleB

JavaScript type

Number

C type

R3FLOAT

Description

indexed, heading

Syntax


jsobj.SetAngleB(index, value);
value = jsobj.GetAngleB(index);


R3FLOAT value = ...;
R3SetAttrs(r3obj, R3SKA_AngleB, value, R3TAG_END);
R3FLOAT value;
R3GetAttrs(r3obj, R3SKA_AngleB, &value, R3TAG_END);

AngleC

Attribute

AngleC

Identifier

R3SKA_AngleC

JavaScript type

Number

C type

R3FLOAT

Description

indexed, pitching

Syntax


jsobj.SetAngleC(index, value);
value = jsobj.GetAngleC(index);


R3FLOAT value = ...;
R3SetAttrs(r3obj, R3SKA_AngleC, value, R3TAG_END);
R3FLOAT value;
R3GetAttrs(r3obj, R3SKA_AngleC, &value, R3TAG_END);

Angle

Attribute

Angle

Identifier

R3SKA_Angle

Type

r3Vect

Description

indexed, hpb angles

Syntax


jsobj.SetAngle(index, value);
value = jsobj.GetAngle(index);


R3VECTOR value = ...;
R3SetAttrs(r3obj, R3SKA_Angle, value, R3TAG_END);
R3VECTOR value;
R3GetAttrs(r3obj, R3SKA_Angle, &value, R3TAG_END);

Length

Attribute

Length

Identifier

R3SKA_Length

JavaScript type

Number

C type

R3FLOAT

Description

indexed, length of the bone (dist. to next bone)

Syntax


jsobj.SetLength(index, value);
value = jsobj.GetLength(index);


R3FLOAT value = ...;
R3SetAttrs(r3obj, R3SKA_Length, value, R3TAG_END);
R3FLOAT value;
R3GetAttrs(r3obj, R3SKA_Length, &value, R3TAG_END);

UseMapVolume

Attribute

UseMapVolume

Identifier

R3SKA_UseMapVolume

JavaScript type

Boolean

C type

R3BOOL

Description

activate mapping volume

Syntax


jsobj.SetUseMapVolume(value);
value = jsobj.GetUseMapVolume();


R3BOOL value = ...;
R3SetAttrs(r3obj, R3SKA_UseMapVolume, value, R3TAG_END);
R3BOOL value;
R3GetAttrs(r3obj, R3SKA_UseMapVolume, &value, R3TAG_END);

MapRadius

Attribute

MapRadius

Identifier

R3SKA_MapRadius

JavaScript type

Number

C type

R3FLOAT

Description

max distance for point mapping

Syntax


jsobj.SetMapRadius(value);
value = jsobj.GetMapRadius();


R3FLOAT value = ...;
R3SetAttrs(r3obj, R3SKA_MapRadius, value, R3TAG_END);
R3FLOAT value;
R3GetAttrs(r3obj, R3SKA_MapRadius, &value, R3TAG_END);

Anchor

Attribute

Anchor

Identifier

R3SKA_Anchor

JavaScript type

Integer

C type

R3INT

Description

index attr, see anchor codes

Syntax


jsobj.SetAnchor(index, value);
value = jsobj.GetAnchor(index);


R3INT value = ...;
R3SetAttrs(r3obj, R3SKA_Anchor, value, R3TAG_END);
R3INT value;
R3GetAttrs(r3obj, R3SKA_Anchor, &value, R3TAG_END);

DrawConstraints

Attribute

DrawConstraints

Identifier

R3SKA_DrawConstraints

JavaScript type

Boolean

C type

R3BOOL

Description

show / hide constraints

Syntax


jsobj.SetDrawConstraints(value);
value = jsobj.GetDrawConstraints();


R3BOOL value = ...;
R3SetAttrs(r3obj, R3SKA_DrawConstraints, value, R3TAG_END);
R3BOOL value;
R3GetAttrs(r3obj, R3SKA_DrawConstraints, &value, R3TAG_END);

RotationHandles

Attribute

RotationHandles

Identifier

R3SKA_RotationHandles

JavaScript type

Boolean

C type

R3BOOL

Description

if true, skeleton supports joint rotation handles

Syntax


jsobj.SetRotationHandles(value);
value = jsobj.GetRotationHandles();


R3BOOL value = ...;
R3SetAttrs(r3obj, R3SKA_RotationHandles, value, R3TAG_END);
R3BOOL value;
R3GetAttrs(r3obj, R3SKA_RotationHandles, &value, R3TAG_END);

MapCount

Attribute

MapCount

Identifier

R3SKA_MapCount

JavaScript type

Integer

C type

R3INT

Description

for multi mapping

Syntax


value = jsobj.GetMapCount();


R3INT value;
R3GetAttrs(r3obj, R3SKA_MapCount, &value, R3TAG_END);

Interpolation

Attribute

Interpolation

Identifier

R3SKA_Interpolation

JavaScript type

Integer

C type

R3INT

Description

see interpolation codes below

Syntax


jsobj.SetInterpolation(value);
value = jsobj.GetInterpolation();


R3INT value = ...;
R3SetAttrs(r3obj, R3SKA_Interpolation, value, R3TAG_END);
R3INT value;
R3GetAttrs(r3obj, R3SKA_Interpolation, &value, R3TAG_END);

AngleSystem

Attribute

AngleSystem

Identifier

R3SKA_AngleSystem

JavaScript type

Integer

C type

R3INT

Description

see angle spaces below

Syntax


jsobj.SetAngleSystem(value);
value = jsobj.GetAngleSystem();


R3INT value = ...;
R3SetAttrs(r3obj, R3SKA_AngleSystem, value, R3TAG_END);
R3INT value;
R3GetAttrs(r3obj, R3SKA_AngleSystem, &value, R3TAG_END);

MinAngle

Attribute

MinAngle

Identifier

R3SKA_MinAngle

Type

r3Vect

Description

indexed, min constraint angles

Syntax


jsobj.SetMinAngle(index, value);
value = jsobj.GetMinAngle(index);


R3VECTOR value = ...;
R3SetAttrs(r3obj, R3SKA_MinAngle, value, R3TAG_END);
R3VECTOR value;
R3GetAttrs(r3obj, R3SKA_MinAngle, &value, R3TAG_END);

MaxAngle

Attribute

MaxAngle

Identifier

R3SKA_MaxAngle

Type

r3Vect

Description

indexed, max constraint angles

Syntax


jsobj.SetMaxAngle(index, value);
value = jsobj.GetMaxAngle(index);


R3VECTOR value = ...;
R3SetAttrs(r3obj, R3SKA_MaxAngle, value, R3TAG_END);
R3VECTOR value;
R3GetAttrs(r3obj, R3SKA_MaxAngle, &value, R3TAG_END);

Thickness

Attribute

Thickness

Identifier

R3SKA_Thickness

JavaScript type

Number

C type

R3FLOAT

Description

indexed attribute

Syntax


jsobj.SetThickness(index, value);
value = jsobj.GetThickness(index);


R3FLOAT value = ...;
R3SetAttrs(r3obj, R3SKA_Thickness, value, R3TAG_END);
R3FLOAT value;
R3GetAttrs(r3obj, R3SKA_Thickness, &value, R3TAG_END);

JointPosition

Attribute

JointPosition

Identifier

R3SKA_JointPosition

Type

r3Vect

Description

indexed attr, joint position in abs space

Syntax


jsobj.SetJointPosition(index, value);
value = jsobj.GetJointPosition(index);


R3VECTOR value = ...;
R3SetAttrs(r3obj, R3SKA_JointPosition, value, R3TAG_END);
R3VECTOR value;
R3GetAttrs(r3obj, R3SKA_JointPosition, &value, R3TAG_END);

AttachOrientation

Attribute

AttachOrientation

Identifier

R3SKA_AttachOrientation

JavaScript type

Boolean

C type

R3BOOL

Description

false indicates only the position is controlled by the parent

Syntax


jsobj.SetAttachOrientation(value);
value = jsobj.GetAttachOrientation();


R3BOOL value = ...;
R3SetAttrs(r3obj, R3SKA_AttachOrientation, value, R3TAG_END);
R3BOOL value;
R3GetAttrs(r3obj, R3SKA_AttachOrientation, &value, R3TAG_END);

AnimRootPos

Attribute

AnimRootPos

Identifier

R3SKA_AnimRootPos

JavaScript type

Boolean

C type

R3BOOL

Description

enable/disable keyframing for the root position

Syntax


jsobj.SetAnimRootPos(value);
value = jsobj.GetAnimRootPos();


R3BOOL value = ...;
R3SetAttrs(r3obj, R3SKA_AnimRootPos, value, R3TAG_END);
R3BOOL value;
R3GetAttrs(r3obj, R3SKA_AnimRootPos, &value, R3TAG_END);

DrawAngles

Attribute

DrawAngles

Identifier

R3SKA_DrawAngles

JavaScript type

Boolean

C type

R3BOOL

Description

show / hide angle handles

Syntax


jsobj.SetDrawAngles(value);
value = jsobj.GetDrawAngles();


R3BOOL value = ...;
R3SetAttrs(r3obj, R3SKA_DrawAngles, value, R3TAG_END);
R3BOOL value;
R3GetAttrs(r3obj, R3SKA_DrawAngles, &value, R3TAG_END);

JointName

Attribute

JointName

Identifier

R3SKA_JointName

JavaScript type

String

C type

char*

Description

indexed attribute, joint name

Syntax


jsobj.SetJointName(index, value);
value = jsobj.GetJointName(index);


char* value = ...;
R3SetAttrs(r3obj, R3SKA_JointName, value, R3TAG_END);
char* value;
R3GetAttrs(r3obj, R3SKA_JointName, &value, R3TAG_END);

R3SKA_FIRSTDYNATTR
R3SK_JOINTNAMELEN
R3SK_NOINDEX

I.K Modes

R3IKM_BOTH
R3IKM_PARENT
R3IKM_TAIL
R3IKM_NONE

Each joint is described by this structure

origin defines the beginning of the bone, horiz. axis defines direction

distance to the next joint

joint friction

friction caused by medium, if 1, the joint cannot be moved

rotate about cs.norm

rotate about cs.vert

torsion, rotate about cs.hor

see flags below

R3OBJ *, R3CLID_TTAG object for joint specific extensions

R3VECTOR, for internal use only

data below this is for internal use only, initialize to zero

name for the joint

flags

R3JOINTF_ANCHOR
R3JOINTF_RIGID
R3JOINTF_IK
R3JOINTF_ANGLE
R3JOINTF_NOHEADIK
R3JOINTF_NOTAILIK
R3JOINTF_POSCHANGED
R3JOINTF_LENCHANGED
R3JOINTF_ANGLECHANGED
R3JOINTF_BINDCHANGED

Handles

R3SKHT_JOINT
R3SKHT_TORSION
R3SKHT_MINA
R3SKHT_MAXA
R3SKHT_MINB
R3SKHT_MAXB
R3SKHT_BONE

Method for moving joints

R3SKT_INVERSEKINEMATICS
R3SKT_FORWARDKINEMATICS
R3SKT_MOVE
R3SKT_TELESCOPE
R3SKT_NATIVE
R3SKT_IKHEAD
R3SKT_IKTAIL

interpolation

R3SKI_ANGLE
R3SKI_QUATERNION

angle spaces

R3SKS_HPT
R3SKS_HPB

values for enum PreferredAnimMth attribute

R3ANIMMTH_ANGLES
R3ANIMMTH_POSITION
R3ANIMMTH_NONE

target point - bone binding

parameter specifying the joint

multi binding over adjacent bones

binding weight

R3MAXIKDEPTH

Tags

Tags

R3SKA_JointParam
R3SKA_TargetIndex
R3SKA_TargetObject
R3SKA_MapId
R3SKA_Fidelity
R3SKA_Weight
R3SKA_IKSpace
R3SKA_IKNoChange
R3SKA_JointFidelity
</sect6>