Class SBMVisualModelCylinderArray#

ClassList > SBMVisualModelCylinderArray

This class describes an array of cylinders. More...

#include <SBMVisualModelCylinderArray.hpp>

Inherits the following classes: SBMVisualModelGeometryArray

Public Types inherited from SBMVisualModelGeometryArray#

Type	Name
enum	Type The available geometry array types.

Public Functions#

Type	Name
	SBMVisualModelCylinderArray (unsigned int numberOfCylinders, unsigned int numberOfPositions, unsigned int * indexData, float * positionData, float * radiusData, unsigned int * capData, float * colorData, SBDDataGraphNodeMaterial materialData, SBDDataGraphNode nodeData, unsigned int * flagData, unsigned int * nodeIndexData, SBSpatialTransform * transform) Builds a cylinder array.
unsigned int *	getCapData () const Returns the cap data.
float *	getRadiusData () const Returns the radius data.
virtual SBMVisualModelGeometryArray::Type	getType () override const Returns SBMVisualModelGeometryArray::Type::Cylinder .
void	setCapData (unsigned int * flagData) Sets the cap data.
void	setRadiusData (float * normalData) Sets the radius data.
virtual	~SBMVisualModelCylinderArray () Deletes the cylinder array.

Public Functions inherited from SBMVisualModelGeometryArray#

See SBMVisualModelGeometryArray

Type	Name
	SBMVisualModelGeometryArray (SBMVisualModelGeometryArrayData * dataPointer) Builds a geometry array.
float *	getColorData () const Returns the color data.
unsigned int *	getFlagData () const Returns the flag data.
unsigned int *	getIndexData () const Returns the index data.
SBDDataGraphNodeMaterial **	getMaterialData () const Returns the material data.
SBDDataGraphNode **	getNodeData () const Returns the node data.
unsigned int *	getNodeIndexData () const Returns the node index data.
unsigned int	getNumberOfGeometries () const Returns the number of geometries.
unsigned int	getNumberOfPositions () const Returns the number of positions.
float *	getPositionData () const Returns the position data.
SBSpatialTransform *	getTransform () const Returns the transform.
virtual Type	getType () const = 0 Returns the type of geometry array.
void	setColorData (float * colorData) Sets the color data.
void	setFlagData (unsigned int * flagData) Sets the flag data.
void	setIndexData (unsigned int * indexData) Sets the index data.
void	setMaterialData (SBDDataGraphNodeMaterial ** materialData) Sets the material data.
void	setNodeData (SBDDataGraphNode ** nodeData) Sets the node data.
void	setNodeIndexData (unsigned int * nodeIndexData) Sets the node index data.
void	setNumberOfGeometries (unsigned int numberOfGeometries) Sets the number of geometries.
void	setNumberOfPositions (unsigned int numberOfPositions) Sets the number of positions.
void	setPositionData (float * positionData) Sets the position data.
void	setTransform (SBSpatialTransform * transform) Sets the transform.
virtual	~SBMVisualModelGeometryArray () Deletes the geometry array.

Public Functions inherited from SBCReferenceTarget#

See SBCReferenceTarget

Type	Name
	SBCReferenceTarget () Builds the reference target.
unsigned int	getMemoryFootprint () const Returns the memory footprint.
void	printReferencesToOwners () const Prints the references to the owners of this reference target.
virtual	~SBCReferenceTarget () Destructor.

Protected Attributes inherited from SBCReferenceTarget#

See SBCReferenceTarget

Type	Name
SBCReferenceTargetData *	dataPointer A pointer to the private data.

Protected Functions inherited from SBCReferenceTarget#

See SBCReferenceTarget

Type	Name
	SBCReferenceTarget (SBCReferenceTargetData * dataPointer) Protected constructor.
void	removeAllReferenceOwners () Stops all the reference owners from referencing this reference target.

Detailed Description#

Short name: SBCylinderArray

Public Functions Documentation#

function SBMVisualModelCylinderArray#

Builds a cylinder array.

SBMVisualModelCylinderArray::SBMVisualModelCylinderArray (
    unsigned int numberOfCylinders,
    unsigned int numberOfPositions,
    unsigned int * indexData,
    float * positionData,
    float * radiusData,
    unsigned int * capData,
    float * colorData,
    SBDDataGraphNodeMaterial ** materialData,
    SBDDataGraphNode ** nodeData,
    unsigned int * flagData,
    unsigned int * nodeIndexData,
    SBSpatialTransform * transform
)

Constructs a cylinder array visual model with the specified data.

Parameters:

numberOfCylinders Number of cylinders in the array.
numberOfPositions Number of position entries.
indexData Pointer to the index data array.
positionData Pointer to the position data array.
radiusData Pointer to the radius data array.
capData Pointer to the cap data array.
colorData Pointer to the color data array.
materialData Pointer to an array of material node pointers.
nodeData Pointer to an array of node pointers.
flagData Pointer to the flag data array.
nodeIndexData Pointer to the node index data array.
transform Pointer to a spatial transform applied to the array.

function getCapData#

Returns the cap data.

unsigned int * SBMVisualModelCylinderArray::getCapData () const

Retrieves the cap data array.

Returns:

Pointer to the cap data.

function getRadiusData#

Returns the radius data.

float * SBMVisualModelCylinderArray::getRadiusData () const

Retrieves the radius data array.

Returns:

Pointer to the radius data.

function getType#

Returns SBMVisualModelGeometryArray::Type::Cylinder .

virtual SBMVisualModelGeometryArray::Type SBMVisualModelCylinderArray::getType () override const

Returns the geometry type of this visual model.

Returns:

The type identifier for a cylinder array.

Implements SBMVisualModelGeometryArray::getType

function setCapData#

Sets the cap data.

void SBMVisualModelCylinderArray::setCapData (
    unsigned int * flagData
)

Sets the cap data array.

Parameters:

capData Pointer to the new cap data array.

function setRadiusData#

Sets the radius data.

void SBMVisualModelCylinderArray::setRadiusData (
    float * normalData
)

Sets the radius data array.

Parameters:

radiusData Pointer to the new radius data array.

function ~SBMVisualModelCylinderArray#

Deletes the cylinder array.

virtual SBMVisualModelCylinderArray::~SBMVisualModelCylinderArray ()

Destroys the cylinder array visual model.