Class SBMVisualModelSphereArray

ClassList > SBMVisualModelSphereArray

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

• #include <SBMVisualModelSphereArray.hpp>

Inherits the following classes: SBMVisualModelGeometryArray

Public Types inherited from SBMVisualModelGeometryArray

See SBMVisualModelGeometryArray

Type	Name
enum	Type The available geometry array types.

Public Functions

Type	Name
	SBMVisualModelSphereArray (unsigned int numberOfSpheres, float * positionData, float * radiusData, float * colorData, SBDDataGraphNodeMaterial ** materialData, SBDDataGraphNode ** nodeData, unsigned int * flagData, unsigned int * nodeIndexData, SBSpatialTransform * transform) Builds a sphere array.
float *	getRadiusData () const Returns the radius data.
virtual SBMVisualModelGeometryArray::Type	getType () override const Returns SBMVisualModelGeometryArray::Type::Sphere .
void	setRadiusData (float * normalData) Sets the radius data.
virtual	~SBMVisualModelSphereArray () Deletes the sphere 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: SBSphereArray

Public Functions Documentation

function SBMVisualModelSphereArray

Builds a sphere array.

SBMVisualModelSphereArray::SBMVisualModelSphereArray (
    unsigned int numberOfSpheres,
    float * positionData,
    float * radiusData,
    float * colorData,
    SBDDataGraphNodeMaterial ** materialData,
    SBDDataGraphNode ** nodeData,
    unsigned int * flagData,
    unsigned int * nodeIndexData,
    SBSpatialTransform * transform
) 

Constructs a visual model representing an array of spheres.

Creates a new SBMVisualModelSphereArray with the specified parameters. The model stores the positions, radii, colors, material references, node references, flags, node indices, and an optional spatial transform for the spheres.

Parameters:

• numberOfSpheres Number of spheres in the array.
• positionData Pointer to an array of position vectors (3 floats per sphere).
• radiusData Pointer to an array of sphere radii (one float per sphere).
• colorData Pointer to an array of color values.
• materialData Pointer to an array of material node pointers.
• nodeData Pointer to an array of node pointers.
• flagData Pointer to an array of flag values.
• nodeIndexData Pointer to an array of node indices.
• transform Optional spatial transform applied to the entire array.

---

function getRadiusData

Returns the radius data.

float * SBMVisualModelSphereArray::getRadiusData () const

Retrieves the array of sphere radii.

Provides direct access to the radius data stored in the model.

Returns:

Pointer to the radius data array.

---

function getType

Returns SBMVisualModelGeometryArray::Type::Sphere .

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

Retrieves the geometry type of this visual model.

Returns the enumeration value that identifies this geometry as a sphere array.

Returns:

The geometry type, SBMVisualModelGeometryArray::Type::Sphere.

Implements SBMVisualModelGeometryArray::getType

---

function setRadiusData

Sets the radius data.

void SBMVisualModelSphereArray::setRadiusData (
    float * normalData
) 

Sets the array of sphere radii.

Assigns a new pointer for the radius data of the sphere array.

Parameters:

• radiusData Pointer to the new radius data array.

---

function ~SBMVisualModelSphereArray

Deletes the sphere array.

virtual SBMVisualModelSphereArray::~SBMVisualModelSphereArray () 

Destroys the sphere array visual model.

---