Realsoft
r3partic
Prev  r3level  Next
r3partic

r3partic

Class

real/objects/r3partic.h

Library

r3obj

Description:

Particle Base Class.

See Also

real/objects/r3level.h

Super Class

r3Level

R3CLID_LEVEL

JavaScript

r3Particle

Class Identifier

R3CLID_PARTICLE - 308

Methods

ADDRENDERER, ENUMCONSTRUCTORS, ADDPROPERTY, ENUMPROPERTIES, ISPOINTWISE, REGISTERCONSTRUCTOR, MAKEPOINTWISE, UPDATEEVALUATOR, INITPARTICLE, DOUPDATE, RECALCULATE, SETORIENTATION, SETPOINTPROPERTY, SETONSELECTED, REPARAMVARATTR, EVALUATEPROPERTYFROMCH, GETPOINTATTRIBUTE, RECREATE, COPYSELECTEDPOINTS, REMOVEPROPERTY, ISDYNAMIC, BEGINRECREATE, ENDRECREATE, SETVECTPROP, GETVECTPROP, SETFLOATPROP, GETFLOATPROP,

Attributes

Count, LifeTime, Speed, BirthTime, RendererFlags, MaxCount, VSL, Constructor, CreationRate, LifeTimeClid, SpeedClid, PointwiseVelocity, PointwiseSpeed, PointwiseLifeTime, PointwiseColor, PointwiseTransparency, PointwiseReflection, PointwiseAlpha, PointwiseFade, PointwiseIllumination, PointwiseOpticalThickn, PointwiseScope, PointwiseUVCoords,

Registration

int R3RegisterParticleClass(R3APP *app);

R3PACM_ADDRENDERER

Method

ADDRENDERER

Identifier

R3PACM_ADDRENDERER

Return

R3BOOL, TRUE if succeeded

Param 3:

R3CLID, class id of the rendering engine

JavaScript

rc = obj.ADDRENDERER(p3);

Description

Class method for adding new rendering engines for particles

R3PACM_ENUMCONSTRUCTORS

Method

ENUMCONSTRUCTORS

Identifier

R3PACM_ENUMCONSTRUCTORS

Param 1:

R3OBJ*, object to be called

Param 2:

void*, whatever user data

Param 3:

R3INT, method id for the object to be called.

JavaScript

obj.ENUMCONSTRUCTORS(p1, p2, p3);

Description

Enumerate registered particle constructors. Constructors are used for controlling the position of particles. Callback object is called as: R3SendMsgA3(p1, p3, (char *)constr_name, (char *)constr_idstr, p2);

R3PAM_ADDPROPERTY

Method

ADDPROPERTY

Identifier

R3PAM_ADDPROPERTY

Return

R3BOOL, TRUE if succeeded

Param 3:

R3TAG*, R3PAA_PropXxx tags

JavaScript

rc = obj.ADDPROPERTY(p3);

Description

private: Allocate new property, such as color, velocity, life time, size etc.

R3PACM_ENUMPROPERTIES

Method

ENUMPROPERTIES

Identifier

R3PACM_ENUMPROPERTIES

Param 1:

R3OBJ*, callback object to be called

Param 2:

R3INT, callback method id

Param 3:

void*, whatever user data.

JavaScript

obj.ENUMPROPERTIES(p1, p2, p3);

Description

Enumerate particle properties. The callback object is called as: R3SendMsgA2(cbobj, cbmth, mydata, tags), where 'tags' contains R3PAA_PropXxx tags describing the property.

R3PAM_ISPOINTWISE

Method

ISPOINTWISE

Identifier

R3PAM_ISPOINTWISE

Return

R3BOOL, true if pointwise

Param 3:

R3INT, attribute id

JavaScript

rc = obj.ISPOINTWISE(p3);

Description

Find out whether the given attribute is defined as 'pointwise' particle property

R3PACM_REGISTERCONSTRUCTOR

Method

REGISTERCONSTRUCTOR

Identifier

R3PACM_REGISTERCONSTRUCTOR

Return

R3BOOL, true if succeeded

Param 3:

R3TAG*, R3PACA_ConstrEvalHook, R3PACA_ConstrIdStr

JavaScript

rc = obj.REGISTERCONSTRUCTOR(p3);

Description

Register new particle constructor callback. int (*)(R3OBJ *obj, R3FLOAT prevtime, R3FLOAT newtime);

R3PAM_MAKEPOINTWISE

Method

MAKEPOINTWISE

Identifier

R3PAM_MAKEPOINTWISE

Return

R3BOOL, TRUE if succeeded

Param 1:

R3INT, attribute to be 'pointwised'

Param 3:

R3BOOL, TRUE/FALSE

JavaScript

rc = obj.MAKEPOINTWISE(p1, p3);

Description

Make the given object attribute 'pointwise'/'objectwise'

R3PAM_UPDATEEVALUATOR

Method

UPDATEEVALUATOR

Identifier

R3PAM_UPDATEEVALUATOR

JavaScript

obj.UPDATEEVALUATOR();

Description

private

R3PAM_INITPARTICLE

Method

INITPARTICLE

Identifier

R3PAM_INITPARTICLE

Param 1:

R3INT, index of the particle to be initialized * P2:

Param 3:

R3COORDSYS, new position and orientation for the particle.

JavaScript

obj.INITPARTICLE(p1, p3);

Description

Update particle geometry: the new position for the particle is passed as 'coordinate system'.

R3PAM_DOUPDATE

Method

DOUPDATE

Identifier

R3PAM_DOUPDATE

JavaScript

obj.DOUPDATE();

Description

Actual update work horse.

R3PAM_RECALCULATE

Method

RECALCULATE

Identifier

R3PAM_RECALCULATE

JavaScript

obj.RECALCULATE();

Description

Non-optimized update. Called internally from R3RM_UPDATE, R3RM_TIME, R3RM_CHILDCHANGED.

R3PAM_SETORIENTATION

Method

SETORIENTATION

Identifier

R3PAM_SETORIENTATION

Param 1:

R3INT, index of the particle

Param 2:

R3VECTOR, uvw coordinates

Param 3:

R3COORDSYS, new orientation

JavaScript

obj.SETORIENTATION(p1, p2, p3);

Description

set particle orientation

R3PAM_SETPOINTPROPERTY

Method

SETPOINTPROPERTY

Identifier

R3PAM_SETPOINTPROPERTY

Return

R3BOOL, true if set

Param 1:

R3INT, attribute to be set (such as R3PAA_Speed)

Param 3:

void*, address of the new value

JavaScript

rc = obj.SETPOINTPROPERTY(p1, p3);

Description

Set properties of the selected points

R3PAM_SETONSELECTED

Method

SETONSELECTED

Identifier

R3PAM_SETONSELECTED

JavaScript

obj.SETONSELECTED();

Description

unused

R3PAM_REPARAMVARATTR

Method

REPARAMVARATTR

Identifier

R3PAM_REPARAMVARATTR

JavaScript

obj.REPARAMVARATTR();

Description

Callback method for r3primm_enumvarattr.

R3PAM_EVALUATEPROPERTYFROMCH

Method

EVALUATEPROPERTYFROMCH

Identifier

R3PAM_EVALUATEPROPERTYFROMCH

JavaScript

obj.EVALUATEPROPERTYFROMCH();

Description

Evaluate given property from a channel

R3PAM_GETPOINTATTRIBUTE

Method

GETPOINTATTRIBUTE

Identifier

R3PAM_GETPOINTATTRIBUTE

Return

R3BOOL, true if found

Param 1:

R3INT, tag to be fetched

Param 2:

R3INT, index of the attribute

Param 3:

void*, buffer for the value to be fetched.

JavaScript

rc = obj.GETPOINTATTRIBUTE(p1, p2, p3);

Description

Get value of the given channel and particle.

R3PAM_RECREATE

Method

RECREATE

Identifier

R3PAM_RECREATE

Param 1:

R3INT, index of the particle

JavaScript

obj.RECREATE(p1, 0);

Description

Recreate the particle specified by index. This method can be called only in BEGINRECREATE and ENDRECREATE section.

R3PAM_COPYSELECTEDPOINTS

Method

COPYSELECTEDPOINTS

Identifier

R3PAM_COPYSELECTEDPOINTS

Return

R3BOOL, TRUE if succeeded

JavaScript

rc = obj.COPYSELECTEDPOINTS();

Description

Duplicate the selected particles

R3PAM_REMOVEPROPERTY

Method

REMOVEPROPERTY

Identifier

R3PAM_REMOVEPROPERTY

Return

R3BOOL, TRUE if succeeded

Param 3:

R3INT, property tag

JavaScript

rc = obj.REMOVEPROPERTY(p3);

Description

private: Remove pointwise property, such as color, velocity, life time, size etc.

R3PAM_ISDYNAMIC

Method

ISDYNAMIC

Identifier

R3PAM_ISDYNAMIC

Return

R3BOOL, TRUE if succeeded

Param 3:

R3INT, property tag

JavaScript

rc = obj.ISDYNAMIC(p3);

Description

R3PAM_BEGINRECREATE

Method

BEGINRECREATE

Identifier

R3PAM_BEGINRECREATE

Return

R3BOOL, true if succeeded, false if particle cannot recreate.

JavaScript

rc = obj.BEGINRECREATE();

Description

Prepare particle for recreation.

R3PAM_ENDRECREATE

Method

ENDRECREATE

Identifier

R3PAM_ENDRECREATE

JavaScript

obj.ENDRECREATE();

Description

End recreation process.

R3PAM_SETVECTPROP

Method

SETVECTPROP

Identifier

R3PAM_SETVECTPROP

Return

R3BOOL, true if succeeded

Param 1:

R3INT, index of the point

Param 2:

R3INT, property to be set

Param 3:

R3VECTOR, property

JavaScript

rc = obj.SETVECTPROP(p1, p2, p3);

Description

Set vector property

R3PAM_GETVECTPROP

Method

GETVECTPROP

Identifier

R3PAM_GETVECTPROP

Return

R3BOOL, true if succeeded

Param 1:

R3INT, index of the point

Param 2:

R3INT, property to be fetch

Param 3:

R3VECTOR, property

JavaScript

rc = obj.GETVECTPROP(p1, p2, p3);

Description

Get vector property

R3PAM_SETFLOATPROP

Method

SETFLOATPROP

Identifier

R3PAM_SETFLOATPROP

Return

R3BOOL, true if succeeded

Param 1:

R3INT, index of the point

Param 2:

R3INT, property to be set

Param 3:

R3FLOAT, property

JavaScript

rc = obj.SETFLOATPROP(p1, p2, p3);

Description

Set float property

R3PAM_GETFLOATPROP

Method

GETFLOATPROP

Identifier

R3PAM_GETFLOATPROP

Return

R3BOOL, true if succeeded

Param 1:

R3INT, index of the point

Param 2:

R3INT, property to be fetch

Param 3:

R3FLOAT, property

JavaScript

rc = obj.GETFLOATPROP(p1, p2, p3);

Description

Get float property

Count

Attribute

Count

Identifier

R3PAA_Count

JavaScript type

Integer

C type

R3INT

Description

number of particles

Syntax


jsobj.SetCount(value);
value = jsobj.GetCount();


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

LifeTime

Attribute

LifeTime

Identifier

R3PAA_LifeTime

JavaScript type

Number

C type

R3FLOAT

Description

life time

Syntax


jsobj.SetLifeTime(value);
value = jsobj.GetLifeTime();


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

Speed

Attribute

Speed

Identifier

R3PAA_Speed

JavaScript type

Number

C type

R3FLOAT

Description

initial speed

Syntax


jsobj.SetSpeed(value);
value = jsobj.GetSpeed();


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

BirthTime

Attribute

BirthTime

Identifier

R3PAA_BirthTime

JavaScript type

Number

C type

R3FLOAT

Description

Syntax


jsobj.SetBirthTime(value);
value = jsobj.GetBirthTime();


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

RendererFlags

Attribute

RendererFlags

Identifier

R3PAA_RendererFlags

JavaScript type

Integer

C type

R3INT

Description

flags corresponding installed renderers, if set, the corresponding renderer is used

Syntax


jsobj.SetRendererFlags(value);
value = jsobj.GetRendererFlags();


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

MaxCount

Attribute

MaxCount

Identifier

R3PAA_MaxCount

JavaScript type

Integer

C type

R3INT

Description

maximum number of particles

Syntax


jsobj.SetMaxCount(value);
value = jsobj.GetMaxCount();


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

VSL

Attribute

VSL

Identifier

R3PAA_VSL

JavaScript type

Object

C type

R3OBJ*

Description

vsl material

Syntax


jsobj.SetVSL(value);
value = jsobj.GetVSL();


R3OBJ* value = ...;
R3SetAttrs(r3obj, R3PAA_VSL, value, R3TAG_END);
R3OBJ* value;
R3GetAttrs(r3obj, R3PAA_VSL, &value, R3TAG_END);

Constructor

Attribute

Constructor

Identifier

R3PAA_Constructor

JavaScript type

String

C type

char*

Description

see enum r3paconstr below

Syntax


jsobj.SetConstructor(value);
value = jsobj.GetConstructor();


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

CreationRate

Attribute

CreationRate

Identifier

R3PAA_CreationRate

JavaScript type

Integer

C type

R3INT

Description

particles per second

Syntax


jsobj.SetCreationRate(value);
value = jsobj.GetCreationRate();


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

LifeTimeClid

Attribute

LifeTimeClid

Identifier

R3PAA_LifeTimeClid

JavaScript type

Integer

C type

R3CLID

Description

evaluate field

Syntax


jsobj.SetLifeTimeClid(value);


R3CLID value = ...;
R3SetAttrs(r3obj, R3PAA_LifeTimeClid, value, R3TAG_END);

SpeedClid

Attribute

SpeedClid

Identifier

R3PAA_SpeedClid

JavaScript type

Integer

C type

R3CLID

Description

initial speed (velocity)

Syntax


jsobj.SetSpeedClid(value);


R3CLID value = ...;
R3SetAttrs(r3obj, R3PAA_SpeedClid, value, R3TAG_END);

PointwiseVelocity

Attribute

PointwiseVelocity

Identifier

R3PAA_PointwiseVelocity

Type

r3Vect

Description

'R3PAA_PointwiseVelocity' not documented

Syntax


jsobj.SetPointwiseVelocity(value);
value = jsobj.GetPointwiseVelocity();


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

PointwiseSpeed

Attribute

PointwiseSpeed

Identifier

R3PAA_PointwiseSpeed

JavaScript type

Number

C type

R3FLOAT*

Description

'R3PAA_PointwiseSpeed' not documented

Syntax


jsobj.SetPointwiseSpeed(value);
value = jsobj.GetPointwiseSpeed();


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

PointwiseLifeTime

Attribute

PointwiseLifeTime

Identifier

R3PAA_PointwiseLifeTime

JavaScript type

Number

C type

R3FLOAT*

Description

'R3PAA_PointwiseLifeTime' not documented

Syntax


jsobj.SetPointwiseLifeTime(value);
value = jsobj.GetPointwiseLifeTime();


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

PointwiseColor

Attribute

PointwiseColor

Identifier

R3PAA_PointwiseColor

Type

r3Vect

Description

'R3PAA_PointwiseColor' not documented

Syntax


jsobj.SetPointwiseColor(value);
value = jsobj.GetPointwiseColor();


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

PointwiseTransparency

Attribute

PointwiseTransparency

Identifier

R3PAA_PointwiseTransparency

Type

r3Vect

Description

'R3PAA_PointwiseTransparency' not documented

Syntax


jsobj.SetPointwiseTransparency(value);
value = jsobj.GetPointwiseTransparency();


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

PointwiseReflection

Attribute

PointwiseReflection

Identifier

R3PAA_PointwiseReflection

Type

r3Vect

Description

'R3PAA_PointwiseReflection' not documented

Syntax


jsobj.SetPointwiseReflection(value);
value = jsobj.GetPointwiseReflection();


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

PointwiseAlpha

Attribute

PointwiseAlpha

Identifier

R3PAA_PointwiseAlpha

JavaScript type

Number

C type

R3FLOAT*

Description

'R3PAA_PointwiseAlpha' not documented

Syntax


jsobj.SetPointwiseAlpha(value);
value = jsobj.GetPointwiseAlpha();


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

PointwiseFade

Attribute

PointwiseFade

Identifier

R3PAA_PointwiseFade

JavaScript type

Number

C type

R3FLOAT*

Description

'R3PAA_PointwiseFade' not documented

Syntax


jsobj.SetPointwiseFade(value);
value = jsobj.GetPointwiseFade();


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

PointwiseIllumination

Attribute

PointwiseIllumination

Identifier

R3PAA_PointwiseIllumination

Type

r3Vect

Description

'R3PAA_PointwiseIllumination' not documented

Syntax


jsobj.SetPointwiseIllumination(value);
value = jsobj.GetPointwiseIllumination();


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

PointwiseOpticalThickn

Attribute

PointwiseOpticalThickn

Identifier

R3PAA_PointwiseOpticalThickn

JavaScript type

Number

C type

R3FLOAT*

Description

'R3PAA_PointwiseOpticalThickness' not documented

Syntax


jsobj.SetPointwiseOpticalThickn(value);
value = jsobj.GetPointwiseOpticalThickn();


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

PointwiseScope

Attribute

PointwiseScope

Identifier

R3PAA_PointwiseScope

JavaScript type

Number

C type

R3FLOAT*

Description

'R3PAA_PointwiseScope' not documented

Syntax


jsobj.SetPointwiseScope(value);
value = jsobj.GetPointwiseScope();


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

PointwiseUVCoords

Attribute

PointwiseUVCoords

Identifier

R3PAA_PointwiseUVCoords

Type

r3Vect

Description

'R3PAA_PointwiseUVCoords' not documented

Syntax


jsobj.SetPointwiseUVCoords(value);
value = jsobj.GetPointwiseUVCoords();


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

maximum number of renderes for particle rendering (scan line, post processing etc.)

R3PAMAX_RENDERCLASSES

what to do with the sub objects

R3PAC_NONE
R3PAC_SURFACE
R3PAC_VOLUME

flags specifying the nature of the property

R3PAPF_NOPOINTWISE
R3PAPF_NOOBJECTWISE
R3PAPF_PROCEDURAL
R3PAPF_POINTWISE
R3PAPF_FIXEDATTR
R3PAPF_SURFACEPROP

Tags

Tags

R3PAA_ParamSpace
R3PACA_ConstrIdStr
R3PAA_PropTagId
R3PAA_RenderPropLabel
R3PAA_PropTypeId
R3PAA_PropChannelClid
R3PAA_PropLabel
R3PAA_PropFlags
R3PAA_Channels
R3PAA_Origin
R3PAA_DU
R3PAA_DV
R3PAA_DN
R3PAA_PointwisePropTagId
<sect6> <title>r3part1d</title>

r3part1d

Class

real/objects/r3part1d.h

Library

r3obj

Description:

1D particles

See Also

real/objects/r3partic.h

Super Class

r3Particle

R3CLID_PARTICLE

JavaScript

r3Particle1d

Class Identifier

R3CLID_PARTICLE1D - 309

Methods

Attributes

Points, Size, PointwiseSize, RayTraceAsQuads,

Registration

int R3RegisterParticle1DClass(R3APP *app);

Points

Attribute

Points

Identifier

R3PA1DA_Points

Type

r3Vect

Description

array of positions for particles

Syntax


jsobj.SetPoints(value);
value = jsobj.GetPoints();


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

Size

Attribute

Size

Identifier

R3PA1DA_Size

JavaScript type

Number

C type

R3FLOAT

Description

size for particles

Syntax


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


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

PointwiseSize

Attribute

PointwiseSize

Identifier

R3PA1DA_PointwiseSize

JavaScript type

Integer

C type

int

Description

Pointwise size for particles

Syntax


jsobj.SetPointwiseSize(value);
value = jsobj.GetPointwiseSize();


int value = ...;
R3SetAttrs(r3obj, R3PA1DA_PointwiseSize, value, R3TAG_END);
int value;
R3GetAttrs(r3obj, R3PA1DA_PointwiseSize, &value, R3TAG_END);

RayTraceAsQuads

Attribute

RayTraceAsQuads

Identifier

R3PA1DA_RayTraceAsQuads

JavaScript type

Boolean

C type

R3BOOL

Description

Syntax


jsobj.SetRayTraceAsQuads(value);
value = jsobj.GetRayTraceAsQuads();


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

Handles

R3P1HT_VERTEX


r3appobj *

</sect6><sect6> <title>r3part2d</title>

r3part2d

Class

real/objects/r3part2d.h

Library

r3obj

Description:

2D particle. This object consists of one or more 2d particles Each particle is represented by its 'position' and 'direction'.

See Also

real/objects/r3partic.h

Super Class

r3Particle

R3CLID_PARTICLE

JavaScript

r3Particle2d

Class Identifier

R3CLID_PARTICLE2D - 310

Methods

ADDPARTICLE, GETAXISPROP, SETAXISPROP,

Attributes

Axes, Diameter1, Diameter2, Length, Angle, PointwiseDiameter1, PointwiseDiameter2, PointwiseLength, PointwiseAngle,

Registration

int R3RegisterParticle2DClass(R3APP *app);

R3PA2DM_ADDPARTICLE

Method

ADDPARTICLE

Identifier

R3PA2DM_ADDPARTICLE

Return

R3BOOL, TRUE if succeeded

Param 1:

R3VECTOR, position

Param 3:

R3VECTOR, normal

JavaScript

rc = obj.ADDPARTICLE(p1, p3);

Description

Adds new particle

R3PA2DM_GETAXISPROP

Method

GETAXISPROP

Identifier

R3PA2DM_GETAXISPROP

Return

R3BOOL, true if succeeded

Param 1:

R3INT, index of the point

Param 2:

R3INT, property to be fetch

Param 3:

R3AXIS, property

JavaScript

rc = obj.GETAXISPROP(p1, p2, p3);

Description

Get axis property

R3PA2DM_SETAXISPROP

Method

SETAXISPROP

Identifier

R3PA2DM_SETAXISPROP

Return

R3BOOL, true if succeeded

Param 1:

R3INT, index of the point

Param 2:

R3INT, property to be fetch

Param 3:

R3AXIS, property

JavaScript

rc = obj.SETAXISPROP(p1, p2, p3);

Description

Set axis property

Axes

Attribute

Axes

Identifier

R3PA2DA_Axes

Type

r3Axis

Description

R3AXIS [], array of 2d particles

Syntax


jsobj.SetAxes(value);
value = jsobj.GetAxes();


R3AXIS* value = ...;
R3SetAttrs(r3obj, R3PA2DA_Axes, value, R3TAG_END);
R3AXIS* value;
R3GetAttrs(r3obj, R3PA2DA_Axes, &value, R3TAG_END);

Diameter1

Attribute

Diameter1

Identifier

R3PA2DA_Diameter1

JavaScript type

Number

C type

R3FLOAT

Description

diameter of the head

Syntax


jsobj.SetDiameter1(value);
value = jsobj.GetDiameter1();


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

Diameter2

Attribute

Diameter2

Identifier

R3PA2DA_Diameter2

JavaScript type

Number

C type

R3FLOAT

Description

diameter of the tail

Syntax


jsobj.SetDiameter2(value);
value = jsobj.GetDiameter2();


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

Length

Attribute

Length

Identifier

R3PA2DA_Length

JavaScript type

Number

C type

R3FLOAT

Description

length of particles

Syntax


jsobj.SetLength(value);
value = jsobj.GetLength();


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

Angle

Attribute

Angle

Identifier

R3PA2DA_Angle

Type

r3Vect

Description

angle, 0,0 cooresponds to surface normal

Syntax


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


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

PointwiseDiameter1

Attribute

PointwiseDiameter1

Identifier

R3PA2DA_PointwiseDiameter1

Type

r3Vect

Description

pointwise diameter of the head

Syntax


jsobj.SetPointwiseDiameter1(value);
value = jsobj.GetPointwiseDiameter1();


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

PointwiseDiameter2

Attribute

PointwiseDiameter2

Identifier

R3PA2DA_PointwiseDiameter2

Type

r3Vect

Description

pointwise diameter of the tail

Syntax


jsobj.SetPointwiseDiameter2(value);
value = jsobj.GetPointwiseDiameter2();


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

PointwiseLength

Attribute

PointwiseLength

Identifier

R3PA2DA_PointwiseLength

Type

r3Vect

Description

pointwise length of particles

Syntax


jsobj.SetPointwiseLength(value);
value = jsobj.GetPointwiseLength();


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

PointwiseAngle

Attribute

PointwiseAngle

Identifier

R3PA2DA_PointwiseAngle

Type

r3Vect

Description

pointwise angle, 0,0 cooresponds to surface normal

Syntax


jsobj.SetPointwiseAngle(value);
value = jsobj.GetPointwiseAngle();


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

Handle types for point enumeration.

R3P2HT_VERTEX
R3P2HT_NORMAL


r3appobj *

</sect6><sect6> <title>r3part3d</title>

r3part3d

Class

real/objects/r3part3d.h

Library

r3obj

Description:

3D particles

See Also

real/objects/r3partic.h

Super Class

r3Particle

R3CLID_PARTICLE

JavaScript

r3Particle3d

Class Identifier

R3CLID_PARTICLE3D - 311

Methods

GETCSPROP, SETCSPROP, SETAXIS,

Attributes

Particles, Radius1, Radius2, Radius3, PointwiseRadius1, PointwiseRadius2, PointwiseRadius3, RayTraceAsRectangle,

Registration

int R3RegisterParticle3DClass(R3APP *app);

R3PA3DM_GETCSPROP

Method

GETCSPROP

Identifier

R3PA3DM_GETCSPROP

Return

R3BOOL, true / false

Param 1:

R3INT, index

Param 2:

R3INT, property

Param 3:

R3COORDSYS, coord system

JavaScript

rc = obj.GETCSPROP(p1, p2, p3);

Description

Get r3coords property

R3PA3DM_SETCSPROP

Method

SETCSPROP

Identifier

R3PA3DM_SETCSPROP

Return

R3BOOL, true / false

Param 1:

R3INT, index

Param 2:

R3INT, property

Param 3:

R3COORDSYS, coord system

JavaScript

rc = obj.SETCSPROP(p1, p2, p3);

Description

Set r3coords property

R3PA3DM_SETAXIS

Method

SETAXIS

Identifier

R3PA3DM_SETAXIS

Param 1:

R3INT, csys index

Param 2:

R3INT, axis index (1=hor .. 3=norm)

Param 3:

R3VECTOR, new direction in abs space

JavaScript

obj.SETAXIS(p1, p2, p3);

Description

Set one csys axis

Particles

Attribute

Particles

Identifier

R3PA3DA_Particles

Type

r3Coordsys

Description

R3COORDSYS [], arra of coordys structures defining 3d particles

Syntax


jsobj.SetParticles(value);
value = jsobj.GetParticles();


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

Radius1

Attribute

Radius1

Identifier

R3PA3DA_Radius1

JavaScript type

Integer

C type

int

Description

'R3PA3DA_Radius1' not documented

Syntax


jsobj.SetRadius1(value);
value = jsobj.GetRadius1();


int value = ...;
R3SetAttrs(r3obj, R3PA3DA_Radius1, value, R3TAG_END);
int value;
R3GetAttrs(r3obj, R3PA3DA_Radius1, &value, R3TAG_END);

Radius2

Attribute

Radius2

Identifier

R3PA3DA_Radius2

JavaScript type

Integer

C type

int

Description

'R3PA3DA_Radius2' not documented

Syntax


jsobj.SetRadius2(value);
value = jsobj.GetRadius2();


int value = ...;
R3SetAttrs(r3obj, R3PA3DA_Radius2, value, R3TAG_END);
int value;
R3GetAttrs(r3obj, R3PA3DA_Radius2, &value, R3TAG_END);

Radius3

Attribute

Radius3

Identifier

R3PA3DA_Radius3

JavaScript type

Integer

C type

int

Description

'R3PA3DA_Radius3' not documented

Syntax


jsobj.SetRadius3(value);
value = jsobj.GetRadius3();


int value = ...;
R3SetAttrs(r3obj, R3PA3DA_Radius3, value, R3TAG_END);
int value;
R3GetAttrs(r3obj, R3PA3DA_Radius3, &value, R3TAG_END);

PointwiseRadius1

Attribute

PointwiseRadius1

Identifier

R3PA3DA_PointwiseRadius1

JavaScript type

Integer

C type

int

Description

'R3PA3DA_PointwiseRadius1' not documented

Syntax


jsobj.SetPointwiseRadius1(value);
value = jsobj.GetPointwiseRadius1();


int value = ...;
R3SetAttrs(r3obj, R3PA3DA_PointwiseRadius1, value, R3TAG_END);
int value;
R3GetAttrs(r3obj, R3PA3DA_PointwiseRadius1, &value, R3TAG_END);

PointwiseRadius2

Attribute

PointwiseRadius2

Identifier

R3PA3DA_PointwiseRadius2

JavaScript type

Integer

C type

int

Description

'R3PA3DA_PointwiseRadius2' not documented

Syntax


jsobj.SetPointwiseRadius2(value);
value = jsobj.GetPointwiseRadius2();


int value = ...;
R3SetAttrs(r3obj, R3PA3DA_PointwiseRadius2, value, R3TAG_END);
int value;
R3GetAttrs(r3obj, R3PA3DA_PointwiseRadius2, &value, R3TAG_END);

PointwiseRadius3

Attribute

PointwiseRadius3

Identifier

R3PA3DA_PointwiseRadius3

JavaScript type

Integer

C type

int

Description

'R3PA3DA_PointwiseRadius3' not documented

Syntax


jsobj.SetPointwiseRadius3(value);
value = jsobj.GetPointwiseRadius3();


int value = ...;
R3SetAttrs(r3obj, R3PA3DA_PointwiseRadius3, value, R3TAG_END);
int value;
R3GetAttrs(r3obj, R3PA3DA_PointwiseRadius3, &value, R3TAG_END);

RayTraceAsRectangle

Attribute

RayTraceAsRectangle

Identifier

R3PA3DA_RayTraceAsRectangle

JavaScript type

Boolean

C type

R3BOOL

Description

if TRUE rendered as rectangular planes

Syntax


jsobj.SetRayTraceAsRectangle(value);
value = jsobj.GetRayTraceAsRectangle();


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

Handle types for point enumeration.

R3P3HT_ORIGIN
R3P3HT_AXIS


r3appobj *

</sect6>
Prev  Up  Next
r3numesh  Home  r3plant