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

#include <GiShmDataStorage.h>

Inheritance diagram for OdGiFaceDataStorage:
OdGiFaceData

Public Types

typedef OdArray< OdGiMapper, OdMemoryAllocator< OdGiMapper > > OdGiMapperArray
 

Public Member Functions

 OdGiFaceDataStorage ()
 
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 OdGsMarkerArrayselectionMarkersArray () const
 
OdGsMarkerArrayselectionMarkersArray ()
 
void setSelectionMarkersArray ()
 
OdGsMarkerresizeSelectionMarkersArray (OdUInt32 nSize, bool bSetPtr=true)
 
const OdGeVector3dArraynormalsArray () const
 
OdGeVector3dArraynormalsArray ()
 
void setNormalsArray ()
 
OdGeVector3dresizeNormalsArray (OdUInt32 nSize, bool bSetPtr=true)
 
const OdUInt8ArrayvisibilityArray () const
 
OdUInt8ArrayvisibilityArray ()
 
void setVisibilityArray ()
 
OdUInt8resizeVisibilityArray (OdUInt32 nSize, bool bSetPtr=true)
 
const OdDbStubPtrArraymaterialsArray () const
 
OdDbStubPtrArraymaterialsArray ()
 
void setMaterialsArray ()
 
OdDbStub ** resizeMaterialsArray (OdUInt32 nSize, bool bSetPtr=true)
 
const OdGiMapperArraymappersArray () const
 
OdGiMapperArraymappersArray ()
 
void setMappersArray ()
 
OdGiMapperresizeMappersArray (OdUInt32 nSize, bool bSetPtr=true)
 
const OdCmTransparencyArraytransparencyArray () const
 
OdCmTransparencyArraytransparencyArray ()
 
void setTransparencyArray ()
 
OdCmTransparencyresizeTransparencyArray (OdUInt32 nSize, bool bSetPtr=true)
 
void cloneData (const OdGiFaceData *pData)
 
void resetPointers ()
 
void setPointersArray (const OdGiFaceData *pFaceData=NULL)
 
void clearArrays (const OdGiFaceData *pFaceData=NULL)
 
void deleteArrays (const OdGiFaceData *pFaceData=NULL)
 
void reserveArrays (const OdGiFaceData *pFaceData, OdUInt32 nReserve)
 
void copyFrom (const OdGiFaceData *pFaceData, OdUInt32 nFace)
 
- Public Member Functions inherited from OdGiFaceData
 OdGiFaceData ()
 
void setColors (const OdUInt16 *colors)
 
void setTrueColors (const OdCmEntityColor *colors)
 
void setLayers (OdDbStub **layerIds)
 
void setSelectionMarkers (const OdGsMarker *selectionMarkers)
 
void setNormals (const OdGeVector3d *normals)
 
void setVisibility (const OdUInt8 *visibilities)
 
void setMaterials (OdDbStub **materialIds)
 
void setMappers (const OdGiMapper *mappers)
 
void setTransparency (const OdCmTransparency *transparencies)
 
void setFillOrigins (const OdGePoint2d *fillOrigins)
 
void setFillDirections (const OdGeVector2d *fillDirections)
 
const OdUInt16colors () const
 
const OdCmEntityColortrueColors () const
 
OdDbStub ** layerIds () const
 
const OdGsMarkerselectionMarkers () const
 
const OdGeVector3dnormals () const
 
const OdUInt8visibility () const
 
OdDbStub ** materials () const
 
const OdGiMappermappers () const
 
const OdCmTransparencytransparency () const
 
const OdGePoint2dfillOrigins () const
 
const OdGeVector2dfillDirections () const
 

Protected Attributes

OdUInt16Array m_colors
 
OdCmEntityColorArray m_trueColors
 
OdDbStubPtrArray m_layers
 
OdGsMarkerArray m_markers
 
OdGeVector3dArray m_normals
 
OdUInt8Array m_visibilities
 
OdDbStubPtrArray m_materials
 
OdGiMapperArray m_mappers
 
OdCmTransparencyArray m_transparencies
 

Detailed Description

Face data storage class.

<group OdGi_Classes>

Definition at line 389 of file GiShmDataStorage.h.

Member Typedef Documentation

◆ OdGiMapperArray

Material mapper object array data type definition.

Definition at line 395 of file GiShmDataStorage.h.

Constructor & Destructor Documentation

◆ OdGiFaceDataStorage()

OdGiFaceDataStorage::OdGiFaceDataStorage ( )
inline

Default constructor for objects of the OdGiFaceDataStorage class.

Definition at line 413 of file GiShmDataStorage.h.

Member Function Documentation

◆ clearArrays()

void OdGiFaceDataStorage::clearArrays ( const OdGiFaceData pFaceData = NULL)
inline

Clears all arrays of the specified OdGiFaceData object.

Parameters
pFaceData[in] Object to clear arrays of.
Remarks
Clears the following arrays: colors, true colors, layer IDs, selection markers, normals, visibilities, materials, material mappers, transparencies.

Definition at line 775 of file GiShmDataStorage.h.

◆ cloneData()

void OdGiFaceDataStorage::cloneData ( const OdGiFaceData pData)
inline

Clones data of the specified OdGiFaceData object.

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

Definition at line 718 of file GiShmDataStorage.h.

◆ colorsArray() [1/2]

OdUInt16Array & OdGiFaceDataStorage::colorsArray ( )
inline

Retrieves the colors array of this OdGiFaceDataStorage object.

Returns
Array of colors.

Definition at line 430 of file GiShmDataStorage.h.

◆ colorsArray() [2/2]

const OdUInt16Array & OdGiFaceDataStorage::colorsArray ( ) const
inline

Retrieves the colors array of this OdGiFaceDataStorage object.

Returns
Array of colors.

Definition at line 422 of file GiShmDataStorage.h.

◆ copyFrom()

void OdGiFaceDataStorage::copyFrom ( const OdGiFaceData pFaceData,
OdUInt32  nFace 
)
inline

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

Parameters
pFaceData[in] Object to copy array elements from.
nFace[in] Index of the elements in arrays.
Remarks
Copies elements from the following arrays: colors, true colors, layer IDs, selection markers, normals, visibilities, materials, material mappers, transparencies.

Definition at line 848 of file GiShmDataStorage.h.

◆ deleteArrays()

void OdGiFaceDataStorage::deleteArrays ( const OdGiFaceData pFaceData = NULL)
inline

Deletes all arrays of the specified OdGiFaceData object.

Parameters
pFaceData[in] Object to delete arrays of.
Remarks
Deletes the following arrays: colors, true colors, layer IDs, selection markers, normals, visibilities, materials, material mappers, transparencies.

Definition at line 798 of file GiShmDataStorage.h.

◆ layerIdsArray() [1/2]

OdDbStubPtrArray & OdGiFaceDataStorage::layerIdsArray ( )
inline

Retrieves the layer IDs array of this OdGiFaceDataStorage object.

Returns
Array of layer IDs.

Definition at line 496 of file GiShmDataStorage.h.

◆ layerIdsArray() [2/2]

const OdDbStubPtrArray & OdGiFaceDataStorage::layerIdsArray ( ) const
inline

Retrieves the layer IDs array of this OdGiFaceDataStorage object.

Returns
Array of layer IDs.

Definition at line 488 of file GiShmDataStorage.h.

◆ mappersArray() [1/2]

OdGiMapperArray & OdGiFaceDataStorage::mappersArray ( )
inline

Retrieves the material mappers array of this OdGiFaceDataStorage object.

Returns
Array of material mappers.

Definition at line 661 of file GiShmDataStorage.h.

◆ mappersArray() [2/2]

const OdGiMapperArray & OdGiFaceDataStorage::mappersArray ( ) const
inline

Retrieves the material mappers array of this OdGiFaceDataStorage object.

Returns
Array of material mappers.

Definition at line 653 of file GiShmDataStorage.h.

◆ materialsArray() [1/2]

OdDbStubPtrArray & OdGiFaceDataStorage::materialsArray ( )
inline

Retrieves the materials array of this OdGiFaceDataStorage object.

Returns
Array of materials.

Definition at line 628 of file GiShmDataStorage.h.

◆ materialsArray() [2/2]

const OdDbStubPtrArray & OdGiFaceDataStorage::materialsArray ( ) const
inline

Retrieves the materials array of this OdGiFaceDataStorage object.

Returns
Array of materials.

Definition at line 620 of file GiShmDataStorage.h.

◆ normalsArray() [1/2]

OdGeVector3dArray & OdGiFaceDataStorage::normalsArray ( )
inline

Retrieves the normals array of this OdGiFaceDataStorage object.

Returns
Array of normals.

Definition at line 562 of file GiShmDataStorage.h.

◆ normalsArray() [2/2]

const OdGeVector3dArray & OdGiFaceDataStorage::normalsArray ( ) const
inline

Retrieves the normals array of this OdGiFaceDataStorage object.

Returns
Array of normals.

Definition at line 554 of file GiShmDataStorage.h.

◆ reserveArrays()

void OdGiFaceDataStorage::reserveArrays ( const OdGiFaceData pFaceData,
OdUInt32  nReserve 
)
inline

Reserves cells in all arrays of the specified OdGiFaceData object.

Parameters
pFaceData[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, selection markers, normals, visibilities, materials, material mappers, transparencies.

Definition at line 822 of file GiShmDataStorage.h.

◆ resetPointers()

void OdGiFaceDataStorage::resetPointers ( )
inline

Resets all array pointers of this OdGiFaceDataStorage object to NULL.

Remarks
Resets the following array pointers: colors, true colors, layer IDs, selection markers, normals, visibilities, materials, material mappers, transparencies.

Definition at line 728 of file GiShmDataStorage.h.

◆ resizeColorsArray()

OdUInt16 * OdGiFaceDataStorage::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 446 of file GiShmDataStorage.h.

◆ resizeLayerIdsArray()

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

Resizes the layer IDs array.

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

Definition at line 512 of file GiShmDataStorage.h.

◆ resizeMappersArray()

OdGiMapper * OdGiFaceDataStorage::resizeMappersArray ( OdUInt32  nSize,
bool  bSetPtr = true 
)
inline

Resizes the material mappers array.

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

Definition at line 677 of file GiShmDataStorage.h.

◆ resizeMaterialsArray()

OdDbStub ** OdGiFaceDataStorage::resizeMaterialsArray ( OdUInt32  nSize,
bool  bSetPtr = true 
)
inline

Resizes the materials array.

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

Definition at line 644 of file GiShmDataStorage.h.

◆ resizeNormalsArray()

OdGeVector3d * OdGiFaceDataStorage::resizeNormalsArray ( OdUInt32  nSize,
bool  bSetPtr = true 
)
inline

Resizes the normals array.

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

Definition at line 578 of file GiShmDataStorage.h.

◆ resizeSelectionMarkersArray()

OdGsMarker * OdGiFaceDataStorage::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 545 of file GiShmDataStorage.h.

◆ resizeTransparencyArray()

OdCmTransparency * OdGiFaceDataStorage::resizeTransparencyArray ( OdUInt32  nSize,
bool  bSetPtr = true 
)
inline

Resizes the transparencies array.

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

Definition at line 710 of file GiShmDataStorage.h.

◆ resizeTrueColorsArray()

OdCmEntityColor * OdGiFaceDataStorage::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 479 of file GiShmDataStorage.h.

◆ resizeVisibilityArray()

OdUInt8 * OdGiFaceDataStorage::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 611 of file GiShmDataStorage.h.

◆ selectionMarkersArray() [1/2]

OdGsMarkerArray & OdGiFaceDataStorage::selectionMarkersArray ( )
inline

Retrieves the selection markers array of this OdGiFaceDataStorage object.

Returns
Array of selection markers.

Definition at line 529 of file GiShmDataStorage.h.

◆ selectionMarkersArray() [2/2]

const OdGsMarkerArray & OdGiFaceDataStorage::selectionMarkersArray ( ) const
inline

Retrieves the selection markers array of this OdGiFaceDataStorage object.

Returns
Array of selection markers.

Definition at line 521 of file GiShmDataStorage.h.

◆ setColorsArray()

void OdGiFaceDataStorage::setColorsArray ( )
inline

Sets the colors array.

Definition at line 435 of file GiShmDataStorage.h.

◆ setLayersArray()

void OdGiFaceDataStorage::setLayersArray ( )
inline

Sets the layer IDs array.

Definition at line 501 of file GiShmDataStorage.h.

◆ setMappersArray()

void OdGiFaceDataStorage::setMappersArray ( )
inline

Sets the material mappers array.

Definition at line 666 of file GiShmDataStorage.h.

◆ setMaterialsArray()

void OdGiFaceDataStorage::setMaterialsArray ( )
inline

Sets the materials array.

Definition at line 633 of file GiShmDataStorage.h.

◆ setNormalsArray()

void OdGiFaceDataStorage::setNormalsArray ( )
inline

Sets the normals array.

Definition at line 567 of file GiShmDataStorage.h.

◆ setPointersArray()

void OdGiFaceDataStorage::setPointersArray ( const OdGiFaceData pFaceData = NULL)
inline

Sets all arrays of this OdGiFaceDataStorage object using data from the specified OdGiFaceData object.

Parameters
pFaceData[in] Object to use data for setting arrays.
Remarks
Sets the following arrays: colors, true colors, layer IDs, selection markers, normals, visibilities, materials, material mappers, transparencies.

Definition at line 752 of file GiShmDataStorage.h.

◆ setSelectionMarkersArray()

void OdGiFaceDataStorage::setSelectionMarkersArray ( )
inline

Sets the selection markers array.

Definition at line 534 of file GiShmDataStorage.h.

◆ setTransparencyArray()

void OdGiFaceDataStorage::setTransparencyArray ( )
inline

Sets the transparencies array.

Definition at line 699 of file GiShmDataStorage.h.

◆ setTrueColorsArray()

void OdGiFaceDataStorage::setTrueColorsArray ( )
inline

Sets the true colors array.

Definition at line 468 of file GiShmDataStorage.h.

◆ setVisibilityArray()

void OdGiFaceDataStorage::setVisibilityArray ( )
inline

Sets the visibilities array.

Definition at line 600 of file GiShmDataStorage.h.

◆ transparencyArray() [1/2]

OdCmTransparencyArray & OdGiFaceDataStorage::transparencyArray ( )
inline

Retrieves the transparencies array of this OdGiFaceDataStorage object.

Returns
Array of transparencies.

Definition at line 694 of file GiShmDataStorage.h.

◆ transparencyArray() [2/2]

const OdCmTransparencyArray & OdGiFaceDataStorage::transparencyArray ( ) const
inline

Retrieves the transparencies array of this OdGiFaceDataStorage object.

Returns
Array of transparencies.

Definition at line 686 of file GiShmDataStorage.h.

◆ trueColorsArray() [1/2]

OdCmEntityColorArray & OdGiFaceDataStorage::trueColorsArray ( )
inline

Retrieves the true colors array of this OdGiFaceDataStorage object.

Returns
Array of true colors.

Definition at line 463 of file GiShmDataStorage.h.

◆ trueColorsArray() [2/2]

const OdCmEntityColorArray & OdGiFaceDataStorage::trueColorsArray ( ) const
inline

Retrieves the true colors array of this OdGiFaceDataStorage object.

Returns
Array of true colors.

Definition at line 455 of file GiShmDataStorage.h.

◆ visibilityArray() [1/2]

OdUInt8Array & OdGiFaceDataStorage::visibilityArray ( )
inline

Retrieves the visibilities array of this OdGiFaceDataStorage object.

Returns
Array of visibilities.

Definition at line 595 of file GiShmDataStorage.h.

◆ visibilityArray() [2/2]

const OdUInt8Array & OdGiFaceDataStorage::visibilityArray ( ) const
inline

Retrieves the visibilities array of this OdGiFaceDataStorage object.

Returns
Array of visibilities.

Definition at line 587 of file GiShmDataStorage.h.

Member Data Documentation

◆ m_colors

OdUInt16Array OdGiFaceDataStorage::m_colors
protected

Definition at line 398 of file GiShmDataStorage.h.

◆ m_layers

OdDbStubPtrArray OdGiFaceDataStorage::m_layers
protected

Definition at line 400 of file GiShmDataStorage.h.

◆ m_mappers

OdGiMapperArray OdGiFaceDataStorage::m_mappers
protected

Definition at line 405 of file GiShmDataStorage.h.

◆ m_markers

OdGsMarkerArray OdGiFaceDataStorage::m_markers
protected

Definition at line 401 of file GiShmDataStorage.h.

◆ m_materials

OdDbStubPtrArray OdGiFaceDataStorage::m_materials
protected

Definition at line 404 of file GiShmDataStorage.h.

◆ m_normals

OdGeVector3dArray OdGiFaceDataStorage::m_normals
protected

Definition at line 402 of file GiShmDataStorage.h.

◆ m_transparencies

OdCmTransparencyArray OdGiFaceDataStorage::m_transparencies
protected

Definition at line 406 of file GiShmDataStorage.h.

◆ m_trueColors

OdCmEntityColorArray OdGiFaceDataStorage::m_trueColors
protected

Definition at line 399 of file GiShmDataStorage.h.

◆ m_visibilities

OdUInt8Array OdGiFaceDataStorage::m_visibilities
protected

Definition at line 403 of file GiShmDataStorage.h.


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