Main Page | Compound List | Compound Members

VUEEcosystem Class Reference


Your Ad Here


List of all members.

Public Member Functions

int AddInstance (int nObjectIndex=0)
 Add an instance.
None ClearInstances ()
 Clear the ecosystem, by deleting all instances but one.
None DeleteInstance (int nIndex)
 Delete an instance.
int GetClosestInstance (float x=0, float y=0, float z=0)
 Get the closest instance from the given point.
int GetInstanceCount ()
 Get the number of instances.
str GetInstanceFilename (int nIndex)
 Get the filename of a given instance of the ecosystem.
tuple_of_floats_x_y_z GetInstancePosition (int nIndex)
 Get the position of a given instance.
tuple_of_floats_x_y_z GetInstanceRotation (int nIndex)
 Get the given instance rotation angles.
tuple_of_floats_x_y_z GetInstanceScale (int nIndex)
 Get the given instance scale.
array_of_floats GetInstanceTransformation (int nIndex)
 Get the transformation matrix of a given instance.
None MoveInstance (int nIndex, float x=10, float y=10, float z=10)
 Move a specified instance.
None MoveInstanceV (int nIndex, tuple_of_floats_x_y_z vTranslate)
 Move a specified instance.
None SetInstancePosition (int nIndex, float x=0, float y=0, float z=0)
 Set the position of a given instance.
None SetInstancePositionV (int nIndex, tuple_of_floats_x_y_z vPosition)
 Set the position of a given instance, using a vector.
None SetInstanceRotation (int nIndex, float x, float y, float z)
 Set the given instance rotation angles.
None SetInstanceRotationV (int nIndex, tuple_of_floats_x_y_z vAngles)
 Set the given instance rotation angles, using a vector.
None SetInstanceScale (int nIndex, float x, float y, float z)
 Set the given instance scale.
None SetInstanceScaleV (int nIndex, tuple_of_floats_x_y_z vScale)
 Set the given instance scale, using a vector.
None SetInstanceTransformation (int nIndex, array_of_floats transformation)
 Set the given instance transformation matrix.

Member Function Documentation

int AddInstance (  int  nObjectIndex = 0  ) 
 

Add an instance.

Parameters:
nObjectIndex If the ecosystem is an object ecosystem, nObjectIndex will represent the index of the object to Add. Else it will be useless.
Returns:
The index of the newly created instance.
Remarks:
The ecosystem needs to have at least 1 instance in order to be able to Add a new instance.
See also:
ClearInstances, DeleteInstance, GetInstanceCount

None ClearInstances (   ) 
 

Clear the ecosystem, by deleting all instances but one.

None DeleteInstance (  int  nIndex  ) 
 

Delete an instance.

Parameters:
nIndex the index of the instance to delete
See also:
ClearInstances, AddInstance, GetInstanceCount

int GetClosestInstance (  float  x = 0,
float  y = 0,
float  z = 0
) 
 

Get the closest instance from the given point.

Parameters:
x the x coordinate of the point
y the x coordinate of the point
z the x coordinate of the point
Returns:
the index of the closest instance
See also:
MoveInstance, SetInstancePosition, GetInstancePosition, GetInstanceTransformation, SetInstanceTransformation

int GetInstanceCount (   ) 
 

Get the number of instances.

Returns:
Number of instances in the ecosystem.
See also:
ClearInstances, AddInstance, DeleteInstance, GetInstanceCount, GetClosestInstance, MoveInstance, SetInstancePosition, GetInstancePosition, GetInstanceTransformation, SetInstanceTransformation

str GetInstanceFilename (  int  nIndex  ) 
 

Get the filename of a given instance of the ecosystem.

Returns:
Filename of the object which the specified instance is based on.
See also:
GetInstanceCount, GetClosestInstance

tuple_of_floats_x_y_z GetInstancePosition (  int  nIndex  ) 
 

Get the position of a given instance.

Parameters:
nIndex the index of the instance
Returns:
an Array of 3 double reprensting the position of the instance
See also:
GetClosestInstance, MoveInstance, SetInstancePosition, GetInstanceTransformation, SetInstanceTransformation

tuple_of_floats_x_y_z GetInstanceRotation (  int  nIndex  ) 
 

Get the given instance rotation angles.

Parameters:
nIndex index of the instance
Returns:
a float vector representing the rotation angles of the instance along the X, Y and Z axis.
See also:
SetInstanceRotation.

tuple_of_floats_x_y_z GetInstanceScale (  int  nIndex  ) 
 

Get the given instance scale.

Parameters:
nIndex index of the instance
Returns:
a float vector representing the scale of the instance along the X, Y and Z axis.
See also:
SetInstanceScale.

array_of_floats GetInstanceTransformation (  int  nIndex  ) 
 

Get the transformation matrix of a given instance.

Parameters:
nIndex the index of the instance
Returns:
a 3x3 Array representing the current transformation matrix
See also:
GetClosestInstance, MoveInstance, SetInstancePosition, GetInstancePosition, SetInstanceTransformation

None MoveInstance (  int  nIndex,
float  x = 10,
float  y = 10,
float  z = 10
) 
 

Move a specified instance.

Parameters:
nIndex the index of the instance
x the x displacement
y the y displacement
z the z displacement
Remarks:
By default, x, y and z have the default 10 value.
See also:
MoveInstanceV, GetClosestInstance, SetInstancePosition, GetInstancePosition, GetInstanceTransformation, SetInstanceTransformation

None MoveInstanceV (  int  nIndex,
tuple_of_floats_x_y_z  vTranslate
) 
 

Move a specified instance.

Parameters:
nIndex the index of the instance
vTranslate the (x,y,z) displacement.
See also:
MoveInstance, GetClosestInstance, SetInstancePosition, GetInstancePosition, GetInstanceTransformation, SetInstanceTransformation

None SetInstancePosition (  int  nIndex,
float  x = 0,
float  y = 0,
float  z = 0
) 
 

Set the position of a given instance.

Parameters:
nIndex the index of the instance
x the new x coordinate
y the new y coordinate
z the new z coordinate
Remarks:
By default, x, y and z have the default 0 value.
See also:
SetInstancePositionV, GetClosestInstance, MoveInstance, GetInstancePosition, GetInstanceTransformation, SetInstanceTransformation

None SetInstancePositionV (  int  nIndex,
tuple_of_floats_x_y_z  vPosition
) 
 

Set the position of a given instance, using a vector.

Parameters:
nIndex the index of the instance
vPosition the new (x,y,z) coordinates.
See also:
SetInstancePosition, GetClosestInstance, MoveInstance, GetInstancePosition, GetInstanceTransformation, SetInstanceTransformation

None SetInstanceRotation (  int  nIndex,
float  x,
float  y,
float  z
) 
 

Set the given instance rotation angles.

Parameters:
nIndex the index of the instance
x the rotation angle along the X axis.
y the rotation angle along the Y axis.
z the rotation angle along the Z axis.
See also:
SetInstanceRotationV, GetInstanceRotation.

None SetInstanceRotationV (  int  nIndex,
tuple_of_floats_x_y_z  vAngles
) 
 

Set the given instance rotation angles, using a vector.

Parameters:
nIndex the index of the instance
vAngles a float vector corresponding to the rotation angles along the X, Y and Z axis.
See also:
SetInstanceRotation, GetInstanceRotation.

None SetInstanceScale (  int  nIndex,
float  x,
float  y,
float  z
) 
 

Set the given instance scale.

Parameters:
nIndex the index of the instance
x the scale values to Apply along the X axis.
y the scale values to Apply along the Y axis.
z the scale values to Apply along the Z axis.
See also:
GetInstanceScale.

None SetInstanceScaleV (  int  nIndex,
tuple_of_floats_x_y_z  vScale
) 
 

Set the given instance scale, using a vector.

Parameters:
nIndex the index of the instance
vScale a float vector corresponding to the scale values to Apply along the X, Y and Z axis.
See also:
GetInstanceScale.

None SetInstanceTransformation (  int  nIndex,
array_of_floats  transformation
) 
 

Set the given instance transformation matrix.

Parameters:
nIndex index of the instance
transformation a 3x3 Array of floats representing the new transformation matrix
See also:
GetClosestInstance, MoveInstance, SetInstancePosition, GetInstancePosition, GetInstanceTransformation

Generated using doxygen on Wed Nov 29 17:50:19 2006.
©2003 e-on software, inc. All rights reserved.

Return to Vue Index


Your Ad Here