r3camera

Class

real/objects/r3camera.h

Library

r3obj

Description:

Camera object.

See Also

real/objects/r3level.h

Super Class

r3Level

R3CLID_LEVEL

JavaScript

r3Camera

Class Identifier

R3CLID_CAMERA - 332

Methods

RENDERLENSFLARE, FINDCURRENT, TRANSLATESELECTEDPOIN, SETPOINTLOCAL, GETPOINTLOCAL,

Attributes

Position, Direction, Up, AspectRatio, CoordSys, FilmWidth, FilmHeight, Angle, Projection, FilmSensitivity, AutoExposure, DepthOfField, FocalLength, Fstop, FocusingDistance, LensFlare, Flash, IsCurrent, Scale, SafeWidth, SafeHeight, NoVertPersp, Side, From, To,

Registration

int R3RegisterCameraClass(R3APP *app);

R3CAMM_RENDERLENSFLARE

Method

RENDERLENSFLARE

Identifier

R3CAMM_RENDERLENSFLARE

JavaScript

obj.RENDERLENSFLARE();

Description

R3CAMM_FINDCURRENT

Method

FINDCURRENT

Identifier

R3CAMM_FINDCURRENT

JavaScript

obj.FINDCURRENT();

Description

R3CAMM_TRANSLATESELECTEDPOIN

Method

TRANSLATESELECTEDPOIN

Identifier

R3CAMM_TRANSLATESELECTEDPOIN

Param 3:

R3VECTOR, translate delta is absolute space

JavaScript

obj.TRANSLATESELECTEDPOIN(p3);

Description

changes the object space

R3CAMM_SETPOINTLOCAL

Method

SETPOINTLOCAL

Identifier

R3CAMM_SETPOINTLOCAL

Return

R3BOOL, true if succeeded

Param 1:

R3INT, index of the point to be set (see CAMP_ codes below)

Param 3:

R3VECTOR, point in object space

JavaScript

rc = obj.SETPOINTLOCAL(p1, p3);

Description

Low level set point.

R3CAMM_GETPOINTLOCAL

Method

GETPOINTLOCAL

Identifier

R3CAMM_GETPOINTLOCAL

Return

R3BOOL, true if succeeded

Param 1:

R3INT, index of the point to be set (see CAMP_ codes below)

Param 3:

R3VECTOR, point in object space

JavaScript

rc = obj.GETPOINTLOCAL(p1, p3);

Description

Low level get point.

Position

Attribute

Position

Identifier

R3CAMA_Position

Type

r3Vect

Description

position of the camera

Syntax

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

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

Direction

Attribute

Direction

Identifier

R3CAMA_Direction

Type

r3Vect

Description

point in abs. space, camera points to this point

Syntax

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

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

Up

Attribute

Up

Identifier

R3CAMA_Up

Type

r3Vect

Description

3d point pointing up and defining aspect ratio

Syntax

jsobj.SetUp(value);
value = jsobj.GetUp();

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

AspectRatio

Attribute

AspectRatio

Identifier

R3CAMA_AspectRatio

JavaScript type

Number

C type

R3FLOAT

Description

image height/width

Syntax

jsobj.SetAspectRatio(value);
value = jsobj.GetAspectRatio();

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

CoordSys

Attribute

CoordSys

Identifier

R3CAMA_CoordSys

Type

r3Coordsys

Description

axes are unit vectors, defines complete camera orientation

Syntax

jsobj.SetCoordSys(value);
value = jsobj.GetCoordSys();

R3COORDSYS* value = ...;
R3SetAttrs(r3obj, R3CAMA_CoordSys, value, R3TAG_END);
R3COORDSYS* value;
R3GetAttrs(r3obj, R3CAMA_CoordSys, &value, R3TAG_END);

FilmWidth

Attribute

FilmWidth

Identifier

R3CAMA_FilmWidth

JavaScript type

Number

C type

R3FLOAT

Description

film dimensions define image aspect & camera opening angle

Syntax

jsobj.SetFilmWidth(value);
value = jsobj.GetFilmWidth();

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

FilmHeight

Attribute

FilmHeight

Identifier

R3CAMA_FilmHeight

JavaScript type

Number

C type

R3FLOAT

Description

Syntax

jsobj.SetFilmHeight(value);
value = jsobj.GetFilmHeight();

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

Angle

Attribute

Angle

Identifier

R3CAMA_Angle

JavaScript type

Number

C type

R3FLOAT

Description

view opening angle

Syntax

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

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

Projection

Attribute

Projection

Identifier

R3CAMA_Projection

JavaScript type

Integer

C type

R3INT

Description

see R3CAMP_ codes below

Syntax

jsobj.SetProjection(value);
value = jsobj.GetProjection();

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

FilmSensitivity

Attribute

FilmSensitivity

Identifier

R3CAMA_FilmSensitivity

JavaScript type

Number

C type

R3FLOAT

Description

acts like brightness

Syntax

jsobj.SetFilmSensitivity(value);
value = jsobj.GetFilmSensitivity();

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

AutoExposure

Attribute

AutoExposure

Identifier

R3CAMA_AutoExposure

JavaScript type

Boolean

C type

R3BOOL

Description

not used

Syntax

jsobj.SetAutoExposure(value);
value = jsobj.GetAutoExposure();

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

DepthOfField

Attribute

DepthOfField

Identifier

R3CAMA_DepthOfField

JavaScript type

Boolean

C type

R3BOOL

Description

Syntax

jsobj.SetDepthOfField(value);
value = jsobj.GetDepthOfField();

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

FocalLength

Attribute

FocalLength

Identifier

R3CAMA_FocalLength

JavaScript type

Number

C type

R3FLOAT

Description

Syntax

jsobj.SetFocalLength(value);
value = jsobj.GetFocalLength();

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

Fstop

Attribute

Fstop

Identifier

R3CAMA_Fstop

JavaScript type

Number

C type

R3FLOAT

Description

Syntax

jsobj.SetFstop(value);
value = jsobj.GetFstop();

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

FocusingDistance

Attribute

FocusingDistance

Identifier

R3CAMA_FocusingDistance

JavaScript type

Number

C type

R3FLOAT

Description

Syntax

jsobj.SetFocusingDistance(value);
value = jsobj.GetFocusingDistance();

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

LensFlare

Attribute

LensFlare

Identifier

R3CAMA_LensFlare

JavaScript type

String

C type

char*

Description

if not NULL flares are rendered using effect defined by this name

Syntax

jsobj.SetLensFlare(value);
value = jsobj.GetLensFlare();

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

Flash

Attribute

Flash

Identifier

R3CAMA_Flash

Type

r3Vect

Description

color of automatic flash associated with camera

Syntax

jsobj.SetFlash(value);
value = jsobj.GetFlash();

R3FLOATCOLOR3 value = ...;
R3SetAttrs(r3obj, R3CAMA_Flash, value, R3TAG_END);
R3FLOATCOLOR3 value;
R3GetAttrs(r3obj, R3CAMA_Flash, &value, R3TAG_END);

IsCurrent

Attribute

IsCurrent

Identifier

R3CAMA_IsCurrent

JavaScript type

Boolean

C type

R3BOOL

Description

current camera

Syntax

jsobj.SetIsCurrent(value);
value = jsobj.GetIsCurrent();

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

Scale

Attribute

Scale

Identifier

R3CAMA_Scale

JavaScript type

Number

C type

R3FLOAT

Description

1.0/width of visible area at 1.0 distance

Syntax

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

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

SafeWidth

Attribute

SafeWidth

Identifier

R3CAMA_SafeWidth

JavaScript type

Number

C type

R3FLOAT

Description

0..1, part of cam view width that is safely visible (default 1.0)

Syntax

jsobj.SetSafeWidth(value);
value = jsobj.GetSafeWidth();

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

SafeHeight

Attribute

SafeHeight

Identifier

R3CAMA_SafeHeight

JavaScript type

Number

C type

R3FLOAT

Description

0..1, part of cam view height that is safely visible (default 1.0)

Syntax

jsobj.SetSafeHeight(value);
value = jsobj.GetSafeHeight();

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

NoVertPersp

Attribute

NoVertPersp

Identifier

R3CAMA_NoVertPersp

JavaScript type

Boolean

C type

R3BOOL

Description

eliminate vertical perspective

Syntax

jsobj.SetNoVertPersp(value);
value = jsobj.GetNoVertPersp();

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

Side

Attribute

Side

Identifier

R3CAMA_Side

Type

r3Vect

Description

3d point pointing sideways and defining viewing angle

Syntax

jsobj.SetSide(value);
value = jsobj.GetSide();

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

From

Attribute

From

Identifier

R3CAMA_From

Type

r3Vect

Description

from point, setting this rotates geometry about 'to' point

Syntax

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

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

To

Attribute

To

Identifier

R3CAMA_To

Type

r3Vect

Description

to point, setting this rotates everything about 'from' point

Syntax

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

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

R3CAMP_PERSPECTIVE

R3CAMP_ORTHOGRAPHIC

Tags

R3CAMA_FlareLightInfoList

R3CAMA_RenderNoGeometry