IRdIkLock Interface Reference

Inherits IRsObject.

List of all members.

Properties
RtUlong *	Type [get]
RtUlong	Type [set]
RtBool *	LockX [get]
RtBool	LockX [set]
RtBool *	LockY [get]
RtBool	LockY [set]
RtBool *	LockZ [get]
RtBool	LockZ [set]
RtMatrixf *	LocalTransform [get, set]
IRsNode **	BoneNode [get]
IRsNode *	BoneNode [set]
RtFloat *	Strength [get]
RtFloat	Strength [set]
RtBool *	UseWithPhysics [get]
RtBool	UseWithPhysics [set]
RtIkLockSymmetry *	Symmetry [get]
RtIkLockSymmetry	Symmetry [set]
BSTR *	Tag [get]
BSTR	Tag [set]
RtBool *	Fixed [get]
RtBool	Fixed [set]

---

Detailed Description

IRdIkLock define Inverse kinematics nail.

---

Property Documentation

RtUlong * IRdIkLock::Type [get]

Get nail type.

Returns:

pdwType [out,retval] Returns nail type.

RtUlong IRdIkLock::Type [set]

Set nail type.

Parameters:

dwType

[in] Type of nail to set.

RtBool * IRdIkLock::LockX [get]

Get axis X lock for nail.

Returns:

pbLocked [out,retval] Returns if axis is locked or not.

RtBool IRdIkLock::LockX [set]

Set axis X lock for nail.

Parameters:

bLocked

[in] Set axis lock.

RtBool * IRdIkLock::LockY [get]

Get axis Y lock for nail.

Returns:

pbLocked [out,retval] Returns if axis is locked or not.

RtBool IRdIkLock::LockY [set]

Set axis Y lock for nail.

Parameters:

bLocked

[in] Set axis lock.

RtBool * IRdIkLock::LockZ [get]

Get axis Z lock for nail.

Returns:

pbLocked [out,retval] Returns if axis is locked or not.

RtBool IRdIkLock::LockZ [set]

Set axis Z lock for nail.

Parameters:

bLocked

[in] Set axis lock.

RtMatrixf * IRdIkLock::LocalTransform [get, set]

Get local transform within bone space.

Returns:

pTransform [out,retval] Returns transform info.

Set lock transform within bone space.

Parameters:

pTransform

[in] Transform info to be set.

IRsNode ** IRdIkLock::BoneNode [get]

Get bone node.

Returns:

ppNode [out,retval] Bone node.

IRsNode * IRdIkLock::BoneNode [set]

Set bone node.

Parameters:

pNode

[in] Bone node to set.

RtFloat * IRdIkLock::Strength [get]

Get lock strength.

Returns:

pfStr [out,retval] Returns value of lock strength.

RtFloat IRdIkLock::Strength [set]

Set lock strength.

Parameters:

fStr

[in] Set lock strength.

RtBool * IRdIkLock::UseWithPhysics [get]

Get physics flag.

Returns:

pbPhys [out,retval] Returns if physics flag set or not.

RtBool IRdIkLock::UseWithPhysics [set]

Set physics flag.

Parameters:

bPhys

[in] Set physics flag.

RtIkLockSymmetry * IRdIkLock::Symmetry [get]

Get lock symmetry identifier.

Returns:

pdwSymmetry [out,retval] Returns identifier of lock symmetry.

RtIkLockSymmetry IRdIkLock::Symmetry [set]

Set lock symmetry identifier.

Parameters:

dwSymmetry

[in] Set identifier of lock symmetry.

BSTR * IRdIkLock::Tag [get]

Get lock tag identifier.

Returns:

pbszTag [out,retval] Returns lock tag identifier.

BSTR IRdIkLock::Tag [set]

Set lock tag identifier.

Parameters:

bszTag

[in] Set lock tag identifier.

RtBool * IRdIkLock::Fixed [get]

Get fixed flag

Returns:

bFixed [out,retval] Returns if lock is fixed or floating.

RtBool IRdIkLock::Fixed [set]

Set fixed flag.

Parameters:

bFixed

[in] Set fixed flag.