r3pflare

Class

real/raytr/r3pflare.h

Library

r3raytr

Description:

Lens flare rendering class. Draws the flare to the position defined by

See Also

real/raytr/r3popaef.h

Super Class

r3Postparticleeffect

R3CLID_POSTPARTICLEEFFECT

JavaScript

r3Pflare

Class Identifier

R3CLID_PFLARE - 405

Attributes

Color, EdgeColor, Size, SubFlares, SubBrg, SubStart, SubSize, StarSize, StarThick, StarCnt, StarAngle, StarColor, StarEndColor, RndSize, RndThick, RndCnt, RndSpeed, RndColor, RndEndColor, RingSize, RingThick, RingColor, Brightness, RndAngle,

Registration

int R3RegisterPFlareClass(R3APP *app);

Color

Attribute

Color

Identifier

R3PFLAREA_Color

Type

r3Vect

Description

central glow color in the middle

Syntax

jsobj.SetColor(value);

R3FLOATCOLOR3 value = ...;
R3SetAttrs(r3obj, R3PFLAREA_Color, value, R3TAG_END);

EdgeColor

Attribute

EdgeColor

Identifier

R3PFLAREA_EdgeColor

Type

r3Vect

Description

central glow color at the edge

Syntax

jsobj.SetEdgeColor(value);

R3FLOATCOLOR3 value = ...;
R3SetAttrs(r3obj, R3PFLAREA_EdgeColor, value, R3TAG_END);

Size

Attribute

Size

Identifier

R3PFLAREA_Size

JavaScript type

Number

C type

R3FLOAT

Description

size of the central glow

Syntax

jsobj.SetSize(value);

R3FLOAT value = ...;
R3SetAttrs(r3obj, R3PFLAREA_Size, value, R3TAG_END);

SubFlares

Attribute

SubFlares

Identifier

R3PFLAREA_SubFlares

JavaScript type

Integer

C type

R3INT

Description

Syntax

jsobj.SetSubFlares(value);

R3INT value = ...;
R3SetAttrs(r3obj, R3PFLAREA_SubFlares, value, R3TAG_END);

SubBrg

Attribute

SubBrg

Identifier

R3PFLAREA_SubBrg

JavaScript type

Number

C type

R3FLOAT

Description

brightness of sub flare rings

Syntax

jsobj.SetSubBrg(value);

R3FLOAT value = ...;
R3SetAttrs(r3obj, R3PFLAREA_SubBrg, value, R3TAG_END);

SubStart

Attribute

SubStart

Identifier

R3PFLAREA_SubStart

JavaScript type

Integer

C type

R3INT

Description

selects the sub flare set

Syntax

jsobj.SetSubStart(value);

R3INT value = ...;
R3SetAttrs(r3obj, R3PFLAREA_SubStart, value, R3TAG_END);

SubSize

Attribute

SubSize

Identifier

R3PFLAREA_SubSize

JavaScript type

Number

C type

R3FLOAT

Description

max sub flare ring diameter

Syntax

jsobj.SetSubSize(value);

R3FLOAT value = ...;
R3SetAttrs(r3obj, R3PFLAREA_SubSize, value, R3TAG_END);

StarSize

Attribute

StarSize

Identifier

R3PFLAREA_StarSize

JavaScript type

Number

C type

R3FLOAT

Description

star streak length

Syntax

jsobj.SetStarSize(value);

R3FLOAT value = ...;
R3SetAttrs(r3obj, R3PFLAREA_StarSize, value, R3TAG_END);

StarThick

Attribute

StarThick

Identifier

R3PFLAREA_StarThick

JavaScript type

Number

C type

R3FLOAT

Description

star streak thickness

Syntax

jsobj.SetStarThick(value);

R3FLOAT value = ...;
R3SetAttrs(r3obj, R3PFLAREA_StarThick, value, R3TAG_END);

StarCnt

Attribute

StarCnt

Identifier

R3PFLAREA_StarCnt

JavaScript type

Integer

C type

R3INT

Description

nunber of streaks in the star

Syntax

jsobj.SetStarCnt(value);

R3INT value = ...;
R3SetAttrs(r3obj, R3PFLAREA_StarCnt, value, R3TAG_END);

StarAngle

Attribute

StarAngle

Identifier

R3PFLAREA_StarAngle

JavaScript type

Number

C type

R3FLOAT

Description

direction angle for the first streak of the star (0 - 2PI)

Syntax

jsobj.SetStarAngle(value);

R3FLOAT value = ...;
R3SetAttrs(r3obj, R3PFLAREA_StarAngle, value, R3TAG_END);

StarColor

Attribute

StarColor

Identifier

R3PFLAREA_StarColor

Type

r3Vect

Description

color of the star in the middle

Syntax

jsobj.SetStarColor(value);

R3FLOATCOLOR3 value = ...;
R3SetAttrs(r3obj, R3PFLAREA_StarColor, value, R3TAG_END);

StarEndColor

Attribute

StarEndColor

Identifier

R3PFLAREA_StarEndColor

Type

r3Vect

Description

color of the star ends

Syntax

jsobj.SetStarEndColor(value);

R3FLOATCOLOR3 value = ...;
R3SetAttrs(r3obj, R3PFLAREA_StarEndColor, value, R3TAG_END);

RndSize

Attribute

RndSize

Identifier

R3PFLAREA_RndSize

JavaScript type

Number

C type

R3FLOAT

Description

max random streak length

Syntax

jsobj.SetRndSize(value);

R3FLOAT value = ...;
R3SetAttrs(r3obj, R3PFLAREA_RndSize, value, R3TAG_END);

RndThick

Attribute

RndThick

Identifier

R3PFLAREA_RndThick

JavaScript type

Number

C type

R3FLOAT

Description

random streak thickness

Syntax

jsobj.SetRndThick(value);

R3FLOAT value = ...;
R3SetAttrs(r3obj, R3PFLAREA_RndThick, value, R3TAG_END);

RndCnt

Attribute

RndCnt

Identifier

R3PFLAREA_RndCnt

JavaScript type

Integer

C type

R3INT

Description

count of random streaks

Syntax

jsobj.SetRndCnt(value);

R3INT value = ...;
R3SetAttrs(r3obj, R3PFLAREA_RndCnt, value, R3TAG_END);

RndSpeed

Attribute

RndSpeed

Identifier

R3PFLAREA_RndSpeed

JavaScript type

Number

C type

R3FLOAT

Description

the 'streaking' speed of random streaks

Syntax

jsobj.SetRndSpeed(value);

R3FLOAT value = ...;
R3SetAttrs(r3obj, R3PFLAREA_RndSpeed, value, R3TAG_END);

RndColor

Attribute

RndColor

Identifier

R3PFLAREA_RndColor

Type

r3Vect

Description

color of streaks in the middle

Syntax

jsobj.SetRndColor(value);

R3FLOATCOLOR3 value = ...;
R3SetAttrs(r3obj, R3PFLAREA_RndColor, value, R3TAG_END);

RndEndColor

Attribute

RndEndColor

Identifier

R3PFLAREA_RndEndColor

Type

r3Vect

Description

color at the ends

Syntax

jsobj.SetRndEndColor(value);

R3FLOATCOLOR3 value = ...;
R3SetAttrs(r3obj, R3PFLAREA_RndEndColor, value, R3TAG_END);

RingSize

Attribute

RingSize

Identifier

R3PFLAREA_RingSize

JavaScript type

Number

C type

R3FLOAT

Description

radius of the primary ring

Syntax

jsobj.SetRingSize(value);

R3FLOAT value = ...;
R3SetAttrs(r3obj, R3PFLAREA_RingSize, value, R3TAG_END);

RingThick

Attribute

RingThick

Identifier

R3PFLAREA_RingThick

JavaScript type

Number

C type

R3FLOAT

Description

thickness of the ring

Syntax

jsobj.SetRingThick(value);

R3FLOAT value = ...;
R3SetAttrs(r3obj, R3PFLAREA_RingThick, value, R3TAG_END);

RingColor

Attribute

RingColor

Identifier

R3PFLAREA_RingColor

Type

r3Vect

Description

ring color

Syntax

jsobj.SetRingColor(value);

R3FLOATCOLOR3 value = ...;
R3SetAttrs(r3obj, R3PFLAREA_RingColor, value, R3TAG_END);

Brightness

Attribute

Brightness

Identifier

R3PFLAREA_Brightness

JavaScript type

Number

C type

R3FLOAT

Description

overall brightness defining total scale & visibility. Default 1.0

Syntax

jsobj.SetBrightness(value);

R3FLOAT value = ...;
R3SetAttrs(r3obj, R3PFLAREA_Brightness, value, R3TAG_END);

RndAngle

Attribute

RndAngle

Identifier

R3PFLAREA_RndAngle

JavaScript type

Number

C type

R3FLOAT

Description

rotation angle for random streaks (0 - 2PI)

Syntax

jsobj.SetRndAngle(value);

R3FLOAT value = ...;
R3SetAttrs(r3obj, R3PFLAREA_RndAngle, value, R3TAG_END);