Class SBMVisualModelLineArray#

ClassList > SBMVisualModelLineArray

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

#include <SBMVisualModelLineArray.hpp>

Inherits the following classes: SBMVisualModelGeometryArray

Public Types inherited from SBMVisualModelGeometryArray#

Type	Name
enum	Type The available geometry array types.

Public Functions#

Type	Name
	SBMVisualModelLineArray (unsigned int numberOfLines, unsigned int numberOfPositions, unsigned int * indexData, float * positionData, float * colorData, SBDDataGraphNodeMaterial materialData, SBDDataGraphNode nodeData, unsigned int * flagData, unsigned int * nodeIndexData, SBSpatialTransform * transform) Builds a line array.
virtual SBMVisualModelGeometryArray::Type	getType () override const Returns SBMVisualModelGeometryArray::Type::Line .
virtual	~SBMVisualModelLineArray () Deletes the line 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: SBLineArray

Public Functions Documentation#

function SBMVisualModelLineArray#

Builds a line array.

SBMVisualModelLineArray::SBMVisualModelLineArray (
    unsigned int numberOfLines,
    unsigned int numberOfPositions,
    unsigned int * indexData,
    float * positionData,
    float * colorData,
    SBDDataGraphNodeMaterial ** materialData,
    SBDDataGraphNode ** nodeData,
    unsigned int * flagData,
    unsigned int * nodeIndexData,
    SBSpatialTransform * transform
)

Constructs a line array geometry object.

Creates an instance of SBMVisualModelLineArray with the specified number of lines, positions, and associated data arrays. The provided data pointers are used to initialize the underlying geometry data.

Parameters:

numberOfLines The total number of lines in the array.
numberOfPositions The total number of vertex positions.
indexData Pointer to an array of indices defining line connectivity.
positionData Pointer to an array of vertex positions (x, y, z).
colorData Pointer to an array of vertex colors (r, g, b, a).
materialData Pointer to an array of material node pointers for each line.
nodeData Pointer to an array of graph node pointers associated with each line.
flagData Pointer to an array of flags for each line.
nodeIndexData Pointer to an array of node indices for each line.
transform Pointer to a spatial transform applied to the geometry.

function getType#

Returns SBMVisualModelGeometryArray::Type::Line .

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

Returns the geometry array type of this object.

The method indicates that this geometry array represents line data.

Returns:

The geometry array type, specifically SBMVisualModelGeometryArray::Type::Line.

Implements SBMVisualModelGeometryArray::getType

function ~SBMVisualModelLineArray#

Deletes the line array.

virtual SBMVisualModelLineArray::~SBMVisualModelLineArray ()

Destroys the line array geometry object.