r3vcianavig

Class

plugins/tools/viewctrl/r3vcianavig.h

Library

r3viewctrl

Description:

View navigation interactor

See Also

real/intact/r3intact.h

Super Class

r3Intact

R3CLID_INTACT

JavaScript

r3Ianavig

Class Identifier

R3CLID_IANAVIG - 2772

Methods

DRIVE, CAMERA, SETTARGETPOS, SETTARGETHPB, APPLY, SETTARGETFDIST, SETTARGETANGLE, UPDATEINPUTPLANE, ENABLECOLLDET, GETOBJBYID, ADDANIMATED, DETECTANIMATED, RESETANIM,

Attributes

TranslationSpeed, RotationSpeed, ObserverHeight, Play, Record, NumKeys, Gravity, Collision, Stabilizer, RecordThreshold, Action, ManageIP, AutoFocus, CollisionEnabled, DisableApply, Animations, Seconds,

R3IANAVIGM_DRIVE

Method

DRIVE

Identifier

R3IANAVIGM_DRIVE

JavaScript

obj.DRIVE();

Description

Private, don't call outside

R3IANAVIGM_CAMERA

Method

CAMERA

Identifier

R3IANAVIGM_CAMERA

JavaScript

obj.CAMERA();

Description

Create camera from the current tracking data.

R3IANAVIGM_SETTARGETPOS

Method

SETTARGETPOS

Identifier

R3IANAVIGM_SETTARGETPOS

Param 3:

R3VECTOR, new target position to move to

JavaScript

obj.SETTARGETPOS(p3);

Description

Set new target position for the camera.

R3IANAVIGM_SETTARGETHPB

Method

SETTARGETHPB

Identifier

R3IANAVIGM_SETTARGETHPB

Param 3:

R3VECTOR, new hpb angles in the native space

JavaScript

obj.SETTARGETHPB(p3);

Description

Set new target orientation to rotate to.

R3IANAVIGM_APPLY

Method

APPLY

Identifier

R3IANAVIGM_APPLY

JavaScript

obj.APPLY();

Description

Apply the tool, but do not end the session.

R3IANAVIGM_SETTARGETFDIST

Method

SETTARGETFDIST

Identifier

R3IANAVIGM_SETTARGETFDIST

Param 3:

R3FLOAT, new focusing distance

JavaScript

obj.SETTARGETFDIST(p3);

Description

Set focusing distance

R3IANAVIGM_SETTARGETANGLE

Method

SETTARGETANGLE

Identifier

R3IANAVIGM_SETTARGETANGLE

Param 3:

R3FLOAT, new viewing angle

JavaScript

obj.SETTARGETANGLE(p3);

Description

Set new viewing angle for the camera.

R3IANAVIGM_UPDATEINPUTPLANE

Method

UPDATEINPUTPLANE

Identifier

R3IANAVIGM_UPDATEINPUTPLANE

JavaScript

obj.UPDATEINPUTPLANE();

Description

Set input plane based on the hit detection.

R3IANAVIGM_ENABLECOLLDET

Method

ENABLECOLLDET

Identifier

R3IANAVIGM_ENABLECOLLDET

Param 3:

R3BOOL, true to enable, false to disable

JavaScript

obj.ENABLECOLLDET(p3);

Description

Enable collision detection

R3IANAVIGM_GETOBJBYID

Method

GETOBJBYID

Identifier

R3IANAVIGM_GETOBJBYID

Return

R3OBJ*, object

Param 3:

R3INT, id

JavaScript

rc = obj.GETOBJBYID(p3);

Description

Fetch the object correspondign the renderer id

R3IANAVIGM_ADDANIMATED

Method

ADDANIMATED

Identifier

R3IANAVIGM_ADDANIMATED

Param 3:

R3OBJ*, object

JavaScript

obj.ADDANIMATED(p3);

Description

Add the object to the list of active animated objects

R3IANAVIGM_DETECTANIMATED

Method

DETECTANIMATED

Identifier

R3IANAVIGM_DETECTANIMATED

Return

R3BOOL, true if the object was animated

JavaScript

rc = obj.DETECTANIMATED();

Description

Try to enable the animation of the target object.

R3IANAVIGM_RESETANIM

Method

RESETANIM

Identifier

R3IANAVIGM_RESETANIM

JavaScript

obj.RESETANIM();

Description

reset the currently animated sequence.

TranslationSpeed

Attribute

TranslationSpeed

Identifier

R3IANAVIGA_TranslationSpeed

JavaScript type

Number

C type

R3FLOAT

Description

translation speed (m/s)

Syntax

jsobj.SetTranslationSpeed(value);
value = jsobj.GetTranslationSpeed();

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

RotationSpeed

Attribute

RotationSpeed

Identifier

R3IANAVIGA_RotationSpeed

JavaScript type

Number

C type

R3FLOAT

Description

rotation speed in radians per second

Syntax

jsobj.SetRotationSpeed(value);
value = jsobj.GetRotationSpeed();

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

ObserverHeight

Attribute

ObserverHeight

Identifier

R3IANAVIGA_ObserverHeight

JavaScript type

Number

C type

R3FLOAT

Description

observer height m

Syntax

jsobj.SetObserverHeight(value);
value = jsobj.GetObserverHeight();

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

Play

Attribute

Play

Identifier

R3IANAVIGA_Play

JavaScript type

Boolean

C type

R3BOOL

Description

playback mode on/off

Syntax

jsobj.SetPlay(value);
value = jsobj.GetPlay();

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

Record

Attribute

Record

Identifier

R3IANAVIGA_Record

JavaScript type

Boolean

C type

R3BOOL

Description

record mode on/off

Syntax

jsobj.SetRecord(value);
value = jsobj.GetRecord();

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

NumKeys

Attribute

NumKeys

Identifier

R3IANAVIGA_NumKeys

JavaScript type

Integer

C type

R3INT

Description

number of recorded keys (R3RM_GET only)

Syntax

value = jsobj.GetNumKeys();

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

Gravity

Attribute

Gravity

Identifier

R3IANAVIGA_Gravity

JavaScript type

Boolean

C type

R3BOOL

Description

BOOL, gravity on/off

Syntax

jsobj.SetGravity(value);
value = jsobj.GetGravity();

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

Collision

Attribute

Collision

Identifier

R3IANAVIGA_Collision

JavaScript type

Boolean

C type

R3BOOL

Description

BOOL, collision detection on/off

Syntax

jsobj.SetCollision(value);
value = jsobj.GetCollision();

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

Stabilizer

Attribute

Stabilizer

Identifier

R3IANAVIGA_Stabilizer

JavaScript type

Boolean

C type

R3BOOL

Description

BOOL, image stabilizer

Syntax

jsobj.SetStabilizer(value);
value = jsobj.GetStabilizer();

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

RecordThreshold

Attribute

RecordThreshold

Identifier

R3IANAVIGA_RecordThreshold

JavaScript type

Number

C type

R3FLOAT

Description

recording treshold

Syntax

jsobj.SetRecordThreshold(value);
value = jsobj.GetRecordThreshold();

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

Action

Attribute

Action

Identifier

R3IANAVIGA_Action

JavaScript type

Integer

C type

R3INT

Description

action to be applied when accepted

Syntax

jsobj.SetAction(value);
value = jsobj.GetAction();

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

ManageIP

Attribute

ManageIP

Identifier

R3IANAVIGA_ManageIP

JavaScript type

Boolean

C type

R3BOOL

Description

manage input plane

Syntax

jsobj.SetManageIP(value);
value = jsobj.GetManageIP();

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

AutoFocus

Attribute

AutoFocus

Identifier

R3IANAVIGA_AutoFocus

JavaScript type

Boolean

C type

R3BOOL

Description

autofocus

Syntax

jsobj.SetAutoFocus(value);
value = jsobj.GetAutoFocus();

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

CollisionEnabled

Attribute

CollisionEnabled

Identifier

R3IANAVIGA_CollisionEnabled

JavaScript type

Boolean

C type

R3BOOL

Description

coll. detetct prepared for use, R3RM_GET only

Syntax

value = jsobj.GetCollisionEnabled();

R3BOOL value;
R3GetAttrs(r3obj, R3IANAVIGA_CollisionEnabled, &value, R3TAG_END);

DisableApply

Attribute

DisableApply

Identifier

R3IANAVIGA_DisableApply

JavaScript type

Boolean

C type

R3BOOL

Description

just for browsing, with no camera creation etc. functionality

Syntax

jsobj.SetDisableApply(value);
value = jsobj.GetDisableApply();

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

Animations

Attribute

Animations

Identifier

R3IANAVIGA_Animations

JavaScript type

Boolean

C type

R3BOOL

Description

enable animations

Syntax

jsobj.SetAnimations(value);
value = jsobj.GetAnimations();

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

Seconds

Attribute

Seconds

Identifier

R3IANAVIGA_Seconds

JavaScript type

Number

C type

R3FLOAT

Description

lenght of the animation in seconds

Syntax

value = jsobj.GetSeconds();

R3FLOAT value;
R3GetAttrs(r3obj, R3IANAVIGA_Seconds, &value, R3TAG_END);

Tags

R3IANAVIGA_FPS

R3IANAVIGA_StabilizerSamples

R3IANAVIGCA_DefaultAnimations