Volume

Defines a volume object that mostly parallels Cubit's RefVolume class.

Inheritance

Class Member Functions

float	volume	Get the volume of the Volume.
	color	Set the color of the Volume.
int	color	Get the color of the Volume.
[ float ]	principal_axes	Get the principal axes of the Volume.
[ float ]	principal_moments	Get the principal moments of the Volume.
[ float ]	centroid	Get the centroid of the Volume.

Member Function Documentation

float volume()

Get the volume of the Volume.

Example

 vol = volume.volume()

Return

The volume of the Volume

color(value)

Set the color of the Volume.

Example

 volume.color(0)

Parameters

value

The color value that the volume will have

int color()

Get the color of the Volume.

Example

 col = volume.color()

Return

The color value associated with the volume's current color

[ float ] principal_axes()

Get the principal axes of the Volume.

Example

 axes = volume.principal_axes()

Return

A vector (or list) of the principal axes of the volume with the indices of the vector corresponding to the values as follows: 0 - axis 1 x value 1 - axis 1 y value 2 - axis 1 z value 3 - axis 2 x value 4 - axis 2 y value 5 - axis 2 z value 6 - axis 3 x value 7 - axis 3 y value 8 - axis 3 z value

[ float ] principal_moments()

Get the principal moments of the Volume.

Example

 moments = volume.principal_moments()

Return

A vector (or list) of the principal moments of the volume with the indices of the vector corresponding to the values as follows: 0 - x moment 1 - y moment 2 - z moment

[ float ] centroid()

Get the centroid of the Volume.

Example

 centroid = volume.centroid()

Return

A vector (or list) of the coordinates of the centroid of the volume with the indices of the vector corresponding to the values as follows: 0 - x coordinate 1 - y coordinate 2 - z coordinate