CFx SDK Documentation 2024 SP0
Loading...
Searching...
No Matches
Public Member Functions | Protected Attributes | List of all members
OdGiEdgeDataStorage Class Reference

#include <GiShmDataStorage.h>

Inheritance diagram for OdGiEdgeDataStorage:
OdGiEdgeData

Public Member Functions

 OdGiEdgeDataStorage ()
 
const OdUInt16ArraycolorsArray () const
 
OdUInt16ArraycolorsArray ()
 
void setColorsArray ()
 
OdUInt16resizeColorsArray (OdUInt32 nSize, bool bSetPtr=true)
 
const OdCmEntityColorArraytrueColorsArray () const
 
OdCmEntityColorArraytrueColorsArray ()
 
void setTrueColorsArray ()
 
OdCmEntityColorresizeTrueColorsArray (OdUInt32 nSize, bool bSetPtr=true)
 
const OdDbStubPtrArraylayerIdsArray () const
 
OdDbStubPtrArraylayerIdsArray ()
 
void setLayersArray ()
 
OdDbStub ** resizeLayerIdsArray (OdUInt32 nSize, bool bSetPtr=true)
 
const OdDbStubPtrArraylinetypeIdsArray () const
 
OdDbStubPtrArraylinetypeIdsArray ()
 
void setLinetypesArray ()
 
OdDbStub ** resizeLinetypeIdsArray (OdUInt32 nSize, bool bSetPtr=true)
 
const OdGsMarkerArrayselectionMarkersArray () const
 
OdGsMarkerArrayselectionMarkersArray ()
 
void setSelectionMarkersArray ()
 
OdGsMarkerresizeSelectionMarkersArray (OdUInt32 nSize, bool bSetPtr=true)
 
const OdUInt8ArrayvisibilityArray () const
 
OdUInt8ArrayvisibilityArray ()
 
void setVisibilityArray ()
 
OdUInt8resizeVisibilityArray (OdUInt32 nSize, bool bSetPtr=true)
 
void cloneData (const OdGiEdgeData *pData)
 
void resetPointers ()
 
void setPointersArray (const OdGiEdgeData *pEdgeData=NULL)
 
void clearArrays (const OdGiEdgeData *pEdgeData=NULL)
 
void deleteArrays (const OdGiEdgeData *pEdgeData=NULL)
 
void reserveArrays (const OdGiEdgeData *pEdgeData, OdUInt32 nReserve)
 
void copyFrom (const OdGiEdgeData *pEdgeData, OdUInt32 nEdge)
 
- Public Member Functions inherited from OdGiEdgeData
 OdGiEdgeData ()
 
void setColors (const OdUInt16 *colors)
 
void setTrueColors (const OdCmEntityColor *colors)
 
void setLayers (OdDbStub **layerIds)
 
void setLinetypes (OdDbStub **linetypeIds)
 
void setSelectionMarkers (const OdGsMarker *selectionMarkers)
 
void setVisibility (const OdUInt8 *visibilities)
 
const OdUInt16colors () const
 
const OdCmEntityColortrueColors () const
 
OdDbStub ** layerIds () const
 
OdDbStub ** linetypeIds () const
 
const OdGsMarkerselectionMarkers () const
 
const OdUInt8visibility () const
 

Protected Attributes

OdUInt16Array m_colors
 
OdCmEntityColorArray m_trueColors
 
OdDbStubPtrArray m_layers
 
OdDbStubPtrArray m_linetypes
 
OdGsMarkerArray m_selMarkers
 
OdUInt8Array m_visibilities
 

Detailed Description

Edge data storage class.

<group OdGi_Classes>

Definition at line 43 of file GiShmDataStorage.h.

Constructor & Destructor Documentation

◆ OdGiEdgeDataStorage()

OdGiEdgeDataStorage::OdGiEdgeDataStorage ( )
inline

Default constructor for objects of the OdGiEdgeDataStorage class.

Definition at line 58 of file GiShmDataStorage.h.

Member Function Documentation

◆ clearArrays()

void OdGiEdgeDataStorage::clearArrays ( const OdGiEdgeData pEdgeData = NULL)
inline

Clears all arrays of the specified OdGiEdgeData object.

Parameters
pEdgeData[in] Object to clear arrays of.
Remarks
Clears the following arrays: colors, true colors, layer IDs, linetypes, selection markers, visibilities.

Definition at line 312 of file GiShmDataStorage.h.

◆ cloneData()

void OdGiEdgeDataStorage::cloneData ( const OdGiEdgeData pData)
inline

Clones data of the specified OdGiEdgeData object.

Parameters
pData[in] OdGiEdgeData object, data of which to be cloned by this OdGiEdgeDataStorage object.

Definition at line 264 of file GiShmDataStorage.h.

◆ colorsArray() [1/2]

OdUInt16Array & OdGiEdgeDataStorage::colorsArray ( )
inline

Retrieves the colors array of this OdGiEdgeDataStorage object.

Returns
Array of colors.

Definition at line 75 of file GiShmDataStorage.h.

◆ colorsArray() [2/2]

const OdUInt16Array & OdGiEdgeDataStorage::colorsArray ( ) const
inline

Retrieves the colors array of this OdGiEdgeDataStorage object.

Returns
Array of colors.

Definition at line 67 of file GiShmDataStorage.h.

◆ copyFrom()

void OdGiEdgeDataStorage::copyFrom ( const OdGiEdgeData pEdgeData,
OdUInt32  nEdge 
)
inline

Copies elements with the specified index from all arrays of the specified OdGiEdgeData object and appends them to arrays of this OdGiEdgeDataStorage object.

Parameters
pEdgeData[in] Object to copy array elements from.
nEdge[in] Index of the elements in arrays.
Remarks
Copies elements from the following arrays: colors, true colors, layer IDs, linetypes, selection markers, visibilities.

Definition at line 373 of file GiShmDataStorage.h.

◆ deleteArrays()

void OdGiEdgeDataStorage::deleteArrays ( const OdGiEdgeData pEdgeData = NULL)
inline

Deletes all arrays of the specified OdGiEdgeData object.

Parameters
pEdgeData[in] Object to delete arrays of.
Remarks
Deletes the following arrays: colors, true colors, layer IDs, linetypes, selection markers, visibilities.

Definition at line 331 of file GiShmDataStorage.h.

◆ layerIdsArray() [1/2]

OdDbStubPtrArray & OdGiEdgeDataStorage::layerIdsArray ( )
inline

Retrieves the layers array of this OdGiEdgeDataStorage object.

Returns
Array of layers.

Definition at line 141 of file GiShmDataStorage.h.

◆ layerIdsArray() [2/2]

const OdDbStubPtrArray & OdGiEdgeDataStorage::layerIdsArray ( ) const
inline

Retrieves the layers array of this OdGiEdgeDataStorage object.

Returns
Array of layers.

Definition at line 133 of file GiShmDataStorage.h.

◆ linetypeIdsArray() [1/2]

OdDbStubPtrArray & OdGiEdgeDataStorage::linetypeIdsArray ( )
inline

Retrieves the linetype IDs array of this OdGiEdgeDataStorage object.

Returns
Array of linetype IDs.

Definition at line 174 of file GiShmDataStorage.h.

◆ linetypeIdsArray() [2/2]

const OdDbStubPtrArray & OdGiEdgeDataStorage::linetypeIdsArray ( ) const
inline

Retrieves the linetype IDs array of this OdGiEdgeDataStorage object.

Returns
Array of linetype IDs.

Definition at line 166 of file GiShmDataStorage.h.

◆ reserveArrays()

void OdGiEdgeDataStorage::reserveArrays ( const OdGiEdgeData pEdgeData,
OdUInt32  nReserve 
)
inline

Reserves cells in all arrays of the specified OdGiEdgeData object.

Parameters
pEdgeData[in] Object which arrays to reserve cells in.
nReserve[in] Number of cells to reserve.
Remarks
Reserves cells in the following arrays: colors, true colors, layer IDs, linetypes, selection markers, visibilities.

Definition at line 351 of file GiShmDataStorage.h.

◆ resetPointers()

void OdGiEdgeDataStorage::resetPointers ( )
inline

Resets all array pointers of this OdGiEdgeDataStorage object to NULL.

Remarks
Resets the following array pointers: colors, true colors, layer IDs, linetypes, selection markers, visibilities.

Definition at line 273 of file GiShmDataStorage.h.

◆ resizeColorsArray()

OdUInt16 * OdGiEdgeDataStorage::resizeColorsArray ( OdUInt32  nSize,
bool  bSetPtr = true 
)
inline

Resizes the colors array.

Parameters
nSize[in] New colors array size.
bSetPtr[in] True to set the colors array after resizing.
Returns
Pointer to the array of colors.

Definition at line 91 of file GiShmDataStorage.h.

◆ resizeLayerIdsArray()

OdDbStub ** OdGiEdgeDataStorage::resizeLayerIdsArray ( OdUInt32  nSize,
bool  bSetPtr = true 
)
inline

Resizes the layers array.

Parameters
nSize[in] New layers array size.
bSetPtr[in] True to set the layers array after resizing.
Returns
Pointer to the array of layers.

Definition at line 157 of file GiShmDataStorage.h.

◆ resizeLinetypeIdsArray()

OdDbStub ** OdGiEdgeDataStorage::resizeLinetypeIdsArray ( OdUInt32  nSize,
bool  bSetPtr = true 
)
inline

Resizes the linetype IDs array.

Parameters
nSize[in] New linetype IDs array size.
bSetPtr[in] True to set the linetype IDs array after resizing.
Returns
Pointer to the array of linetype IDs.

Definition at line 190 of file GiShmDataStorage.h.

◆ resizeSelectionMarkersArray()

OdGsMarker * OdGiEdgeDataStorage::resizeSelectionMarkersArray ( OdUInt32  nSize,
bool  bSetPtr = true 
)
inline

Resizes the selection markers array.

Parameters
nSize[in] New selection markers array size.
bSetPtr[in] True to set the selection markers array after resizing.
Returns
Pointer to the array of selection markers.

Definition at line 223 of file GiShmDataStorage.h.

◆ resizeTrueColorsArray()

OdCmEntityColor * OdGiEdgeDataStorage::resizeTrueColorsArray ( OdUInt32  nSize,
bool  bSetPtr = true 
)
inline

Resizes the true colors array.

Parameters
nSize[in] New true colors array size.
bSetPtr[in] True to set the true colors array after resizing.
Returns
Pointer to the array of true colors.

Definition at line 124 of file GiShmDataStorage.h.

◆ resizeVisibilityArray()

OdUInt8 * OdGiEdgeDataStorage::resizeVisibilityArray ( OdUInt32  nSize,
bool  bSetPtr = true 
)
inline

Resizes the visibilities array.

Parameters
nSize[in] New visibilities array size.
bSetPtr[in] True to set the visibilities array after resizing.
Returns
Pointer to the array of visibilities.

Definition at line 256 of file GiShmDataStorage.h.

◆ selectionMarkersArray() [1/2]

OdGsMarkerArray & OdGiEdgeDataStorage::selectionMarkersArray ( )
inline

Retrieves the selection markers array of this OdGiEdgeDataStorage object.

Returns
Array of selection markers.

Definition at line 207 of file GiShmDataStorage.h.

◆ selectionMarkersArray() [2/2]

const OdGsMarkerArray & OdGiEdgeDataStorage::selectionMarkersArray ( ) const
inline

Retrieves the selection markers array of this OdGiEdgeDataStorage object.

Returns
Array of selection markers.

Definition at line 199 of file GiShmDataStorage.h.

◆ setColorsArray()

void OdGiEdgeDataStorage::setColorsArray ( )
inline

Sets the colors array.

Definition at line 80 of file GiShmDataStorage.h.

◆ setLayersArray()

void OdGiEdgeDataStorage::setLayersArray ( )
inline

Sets the layers array.

Definition at line 146 of file GiShmDataStorage.h.

◆ setLinetypesArray()

void OdGiEdgeDataStorage::setLinetypesArray ( )
inline

Sets the linetype IDs array.

Definition at line 179 of file GiShmDataStorage.h.

◆ setPointersArray()

void OdGiEdgeDataStorage::setPointersArray ( const OdGiEdgeData pEdgeData = NULL)
inline

Sets all arrays of this OdGiEdgeDataStorage object using data from the specified OdGiEdgeData object.

Parameters
pEdgeData[in] Object to use data for setting arrays.
Remarks
Sets the following arrays: colors, true colors, layer IDs, linetypes, selection markers, visibilities.

Definition at line 293 of file GiShmDataStorage.h.

◆ setSelectionMarkersArray()

void OdGiEdgeDataStorage::setSelectionMarkersArray ( )
inline

Sets the selection markers array.

Definition at line 212 of file GiShmDataStorage.h.

◆ setTrueColorsArray()

void OdGiEdgeDataStorage::setTrueColorsArray ( )
inline

Sets the true colors array.

Definition at line 113 of file GiShmDataStorage.h.

◆ setVisibilityArray()

void OdGiEdgeDataStorage::setVisibilityArray ( )
inline

Sets the visibilities array.

Definition at line 245 of file GiShmDataStorage.h.

◆ trueColorsArray() [1/2]

OdCmEntityColorArray & OdGiEdgeDataStorage::trueColorsArray ( )
inline

Retrieves the true colors array of this OdGiEdgeDataStorage object.

Returns
Array of true colors.

Definition at line 108 of file GiShmDataStorage.h.

◆ trueColorsArray() [2/2]

const OdCmEntityColorArray & OdGiEdgeDataStorage::trueColorsArray ( ) const
inline

Retrieves the true colors array of this OdGiEdgeDataStorage object.

Returns
Array of true colors.

Definition at line 100 of file GiShmDataStorage.h.

◆ visibilityArray() [1/2]

OdUInt8Array & OdGiEdgeDataStorage::visibilityArray ( )
inline

Retrieves the visibilities array of this OdGiEdgeDataStorage object.

Returns
Array of visibilities.

Definition at line 240 of file GiShmDataStorage.h.

◆ visibilityArray() [2/2]

const OdUInt8Array & OdGiEdgeDataStorage::visibilityArray ( ) const
inline

Retrieves the visibilities array of this OdGiEdgeDataStorage object.

Returns
Array of visibilities.

Definition at line 232 of file GiShmDataStorage.h.

Member Data Documentation

◆ m_colors

OdUInt16Array OdGiEdgeDataStorage::m_colors
protected

Definition at line 47 of file GiShmDataStorage.h.

◆ m_layers

OdDbStubPtrArray OdGiEdgeDataStorage::m_layers
protected

Definition at line 49 of file GiShmDataStorage.h.

◆ m_linetypes

OdDbStubPtrArray OdGiEdgeDataStorage::m_linetypes
protected

Definition at line 50 of file GiShmDataStorage.h.

◆ m_selMarkers

OdGsMarkerArray OdGiEdgeDataStorage::m_selMarkers
protected

Definition at line 51 of file GiShmDataStorage.h.

◆ m_trueColors

OdCmEntityColorArray OdGiEdgeDataStorage::m_trueColors
protected

Definition at line 48 of file GiShmDataStorage.h.

◆ m_visibilities

OdUInt8Array OdGiEdgeDataStorage::m_visibilities
protected

Definition at line 52 of file GiShmDataStorage.h.


The documentation for this class was generated from the following file: