r3lights

r3lights

Class

real/objects/r3lights.h

Library

r3obj

Description:

Basic class for all light source objects

See Also

real/objects/r3level.h

Super Class

r3Level

R3CLID_LEVEL

JavaScript

r3Lightsource

Class Identifier

R3CLID_LIGHTSOURCE - 301

Methods

RENDERSHADOWMAPS,

Attributes

Intensity, MaterialSensitive, Falloff, CastShadow, HotPoint, FalloffRadius, Material, VolumeLighting, MapResolution, ShadowMapSupported, DiffuseOnly,

Registration

int R3RegisterLightSourceClass(R3APP *app);

R3LSM_RENDERSHADOWMAPS

Method

RENDERSHADOWMAPS

Identifier

R3LSM_RENDERSHADOWMAPS

JavaScript

obj.RENDERSHADOWMAPS();

Description

Intensity

Attribute

Intensity

Identifier

R3LSA_Intensity

JavaScript type

Number

C type

R3FLOAT

Description

intensity, 0 ...

Syntax


jsobj.SetIntensity(value);
value = jsobj.GetIntensity();


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

MaterialSensitive

Attribute

MaterialSensitive

Identifier

R3LSA_MaterialSensitive

JavaScript type

Boolean

C type

R3BOOL

Description

if TRUE, mapping objects affect light source

Syntax


jsobj.SetMaterialSensitive(value);
value = jsobj.GetMaterialSensitive();


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

Falloff

Attribute

Falloff

Identifier

R3LSA_Falloff

JavaScript type

Integer

C type

R3INT

Description

see falloffs below

Syntax


jsobj.SetFalloff(value);
value = jsobj.GetFalloff();


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

CastShadow

Attribute

CastShadow

Identifier

R3LSA_CastShadow

JavaScript type

Integer

C type

R3INT

Description

see shadow types below

Syntax


jsobj.SetCastShadow(value);
value = jsobj.GetCastShadow();


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

HotPoint

Attribute

HotPoint

Identifier

R3LSA_HotPoint

JavaScript type

Number

C type

R3FLOAT

Description

R3VECTOR or undefined, the max intensity point

Syntax


value = jsobj.GetHotPoint();


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

FalloffRadius

Attribute

FalloffRadius

Identifier

R3LSA_FalloffRadius

JavaScript type

Number

C type

R3FLOAT

Description

>0

Syntax


jsobj.SetFalloffRadius(value);
value = jsobj.GetFalloffRadius();


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

Material

Attribute

Material

Identifier

R3LSA_Material

JavaScript type

String

C type

char*

Description

material

Syntax


jsobj.SetMaterial(value);
value = jsobj.GetMaterial();


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

VolumeLighting

Attribute

VolumeLighting

Identifier

R3LSA_VolumeLighting

JavaScript type

Boolean

C type

R3BOOL

Description

illuminates volume if true

Syntax


jsobj.SetVolumeLighting(value);
value = jsobj.GetVolumeLighting();


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

MapResolution

Attribute

MapResolution

Identifier

R3LSA_MapResolution

JavaScript type

Integer

C type

R3INT

Description

accuracy of shadow maps (e.g 100 pixels)

Syntax


jsobj.SetMapResolution(value);
value = jsobj.GetMapResolution();


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

ShadowMapSupported

Attribute

ShadowMapSupported

Identifier

R3LSA_ShadowMapSupported

JavaScript type

Boolean

C type

R3BOOL

Description

read only, return TRUE to display base class shadowmap controls

Syntax


value = jsobj.GetShadowMapSupported();


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

DiffuseOnly

Attribute

DiffuseOnly

Identifier

R3LSA_DiffuseOnly

JavaScript type

Boolean

C type

R3BOOL

Description

if TRUE this light causes only default diffuse shading

Syntax


jsobj.SetDiffuseOnly(value);
value = jsobj.GetDiffuseOnly();


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

Falloffs

R3LFO_NONE
R3LFO_LOCAL
R3FLO_DISTANCE
R3FLO_DISTANCESQUARED

Shadows

R3LSS_NONE
R3LSS_RAYTRACED
R3LSS_MAPPED

<sect6> <title>r3lsd</title>

r3lsd

Class

real/objects/r3lsd.h

Library

r3obj

Description:

Distant Light Class

See Also

real/objects/r3lights.h

Super Class

r3Lightsource

R3CLID_LIGHTSOURCE

JavaScript

r3Distantlight

Class Identifier

R3CLID_DISTANTLIGHT - 505

Methods

Attributes

Center, Ray, CoordSys,

Registration

int R3RegisterDistantLightClass(R3APP *app);

Center

Attribute

Center

Identifier

R3LSDA_Center

Type

r3Vect

Description

position

Syntax


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


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

Ray

Attribute

Ray

Identifier

R3LSDA_Ray

Type

r3Vect

Description

direction

Syntax


jsobj.SetRay(value);
value = jsobj.GetRay();


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

CoordSys

Attribute

CoordSys

Identifier

R3LSDA_CoordSys

Type

r3Coordsys

Description

orientation

Syntax


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


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

attribute indexes for R3PRIMA_Points

R3LSDIND_CENTER
R3LSDIND_RAY


r3appobj *

</sect6>
<sect6> <title>r3lsp</title>

r3lsp

Class

real/objects/r3lsp.h

Library

r3obj

Description:

Point light source.

See Also

real/objects/r3lights.h

Super Class

r3Lightsource

R3CLID_LIGHTSOURCE

JavaScript

r3Lightpoint

Class Identifier

R3CLID_LIGHTPOINT - 501

Methods

Attributes

Center, Ray, Type, Size, Quality,

Registration

int R3RegisterLightPointClass(R3APP *app);

Center

Attribute

Center

Identifier

R3LSPA_Center

Type

r3Vect

Description

position

Syntax


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


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

Ray

Attribute

Ray

Identifier

R3LSPA_Ray

Type

r3Vect

Description

point which defines radius for fall off

Syntax


jsobj.SetRay(value);
value = jsobj.GetRay();


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

Type

Attribute

Type

Identifier

R3LSPA_Type

JavaScript type

Integer

C type

R3INT

Description

see types below

Syntax


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


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

Size

Attribute

Size

Identifier

R3LSPA_Size

JavaScript type

Number

C type

R3FLOAT

Description

radius for smooth shadows

Syntax


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


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

Quality

Attribute

Quality

Identifier

R3LSPA_Quality

JavaScript type

Integer

C type

R3INT

Description

smooth shadow quality 0..20(..)

Syntax


jsobj.SetQuality(value);
value = jsobj.GetQuality();


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

Point ligh types

R3LSPTYPE_RADIAL
R3LSPTYPE_AMBIENT
R3LSPTYPE_DIFFUSEAMBIENT

</sect6>
<sect6> <title>r3lse</title>

r3lse

Class

real/objects/r3lse.h

Library

r3obj

Description:

Special Light Class. Sub-objects emit light. This light source can be used for creating area light sources which generate soft shadows.

See Also

real/objects/r3lights.h

Super Class

r3Lightsource

R3CLID_LIGHTSOURCE

JavaScript

r3Speciallight

Class Identifier

R3CLID_SPECIALLIGHT - 512

Methods

Attributes

Quality,

Registration

int R3RegisterSpecialLightClass(R3APP *app);

Quality

Attribute

Quality

Identifier

R3LSSPEA_Quality

JavaScript type

Integer

C type

R3INT

Description

light sampling. Determines duality of soft shadows range 0 ... infinity, 10 results reasonable quality

Syntax


jsobj.SetQuality(value);
value = jsobj.GetQuality();


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

Tags

Tags

R3LSSPEA_RenderTags
</sect6>
<sect6> <title>r3lss</title>

r3lss

Class

real/objects/r3lss.h

Library

r3obj

Description:

Spot Light Class

See Also

real/objects/r3lights.h

Super Class

r3Lightsource

R3CLID_LIGHTSOURCE

JavaScript

r3Spotlight

Class Identifier

R3CLID_SPOTLIGHT - 509

Methods

Attributes

Center, Ray, A1, A2, Angle1, Angle2, Size, Quality,

Registration

int R3RegisterSpotLightClass(R3APP *app);

Center

Attribute

Center

Identifier

R3LSSA_Center

Type

r3Vect

Description

position ie. "from"

Syntax


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


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

Ray

Attribute

Ray

Identifier

R3LSSA_Ray

Type

r3Vect

Description

"to" point defining direction

Syntax


jsobj.SetRay(value);
value = jsobj.GetRay();


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

A1

Attribute

A1

Identifier

R3LSSA_A1

Type

r3Vect

Description

point defining inner cone angle

Syntax


jsobj.SetA1(value);
value = jsobj.GetA1();


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

A2

Attribute

A2

Identifier

R3LSSA_A2

Type

r3Vect

Description

point defining outer cone angle

Syntax


jsobj.SetA2(value);
value = jsobj.GetA2();


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

Angle1

Attribute

Angle1

Identifier

R3LSSA_Angle1

JavaScript type

Number

C type

R3FLOAT

Description

1st cone angle (corresponding _A1)

Syntax


jsobj.SetAngle1(value);
value = jsobj.GetAngle1();


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

Angle2

Attribute

Angle2

Identifier

R3LSSA_Angle2

JavaScript type

Number

C type

R3FLOAT

Description

2nd cone angle (corresponding _A2)

Syntax


jsobj.SetAngle2(value);
value = jsobj.GetAngle2();


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

Size

Attribute

Size

Identifier

R3LSSA_Size

JavaScript type

Number

C type

R3FLOAT

Description

size for soft shadows

Syntax


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


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

Quality

Attribute

Quality

Identifier

R3LSSA_Quality

JavaScript type

Integer

C type

R3INT

Description

quality for soft shadow sampling

Syntax


jsobj.SetQuality(value);
value = jsobj.GetQuality();


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

attribute indexes to R3PRIMA_Points

R3LSSIND_CENTER
R3LSSIND_RAY
R3LSSIND_A1
R3LSSIND_A2


r3appobj *

</sect6>