CFx SDK Documentation  2023 SP0
Public Member Functions | List of all members
OdGiFaceData Class Reference

#include <GiGeometry.h>

Inheritance diagram for OdGiFaceData:
OdGiFaceDataStorage

Public Member Functions

 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
 

Detailed Description

This class contains arrays of face attributes for meshes and shells.

See also
TD_Gi

<group OdGi_Classes>

Definition at line 244 of file GiGeometry.h.

Constructor & Destructor Documentation

◆ OdGiFaceData()

OdGiFaceData::OdGiFaceData ( )
inline

Definition at line 258 of file GiGeometry.h.

Member Function Documentation

◆ colors()

const OdUInt16* OdGiFaceData::colors ( ) const
inline

Returns the array of face colors used by this object.

Remarks
This function does not make a copy of the array, which should have the same number of elements as the mesh or shell with which it is used. Writing beyond the array bounds will have unpredictable or fatal consequences.

Definition at line 423 of file GiGeometry.h.

◆ fillDirections()

const OdGeVector2d* OdGiFaceData::fillDirections ( ) const
inline

Returns the array of fill direction vectors used by this object. BIM-specific

Remarks
This function does not make a copy of the array, which should have the same number of elements as the mesh or shell with which it is used. Writing beyond the array bounds will have unpredictable or fatal consequences.

Definition at line 522 of file GiGeometry.h.

◆ fillOrigins()

const OdGePoint2d* OdGiFaceData::fillOrigins ( ) const
inline

Returns the array of fill origin points used by this object. BIM-specific

Remarks
This function does not make a copy of the array, which should have the same number of elements as the mesh or shell with which it is used. Writing beyond the array bounds will have unpredictable or fatal consequences.

Definition at line 513 of file GiGeometry.h.

◆ layerIds()

OdDbStub** OdGiFaceData::layerIds ( ) const
inline

Returns the array of face LayerTableRecord Object IDs used by this object.

Remarks
This function does not make a copy of the array, which should have the same number of elements as the mesh or shell with which it is used. Writing beyond the array bounds will have unpredictable or fatal consequences.

Definition at line 441 of file GiGeometry.h.

◆ mappers()

const OdGiMapper* OdGiFaceData::mappers ( ) const
inline

Returns the array of face material mappers used by this object.

Remarks
This function does not make a copy of the array, which should have the same number of elements as the mesh or shell with which it is used. Writing beyond the array bounds will have unpredictable or fatal consequences.

Definition at line 495 of file GiGeometry.h.

◆ materials()

OdDbStub** OdGiFaceData::materials ( ) const
inline

Returns the array of face material object IDs used by this object.

Remarks
This function does not make a copy of the array, which should have the same number of elements as the mesh or shell with which it is used. Writing beyond the array bounds will have unpredictable or fatal consequences.

Definition at line 486 of file GiGeometry.h.

◆ normals()

const OdGeVector3d* OdGiFaceData::normals ( ) const
inline

Returns the array of face normal vectors used by this object.

Remarks
This function does not make a copy of the array, which should have the same number of elements as the mesh or shell with which it is used. Writing beyond the array bounds will have unpredictable or fatal consequences.

Definition at line 459 of file GiGeometry.h.

◆ selectionMarkers()

const OdGsMarker* OdGiFaceData::selectionMarkers ( ) const
inline

Returns the array of face graphics system selection markers used by this object.

Remarks
This function does not make a copy of the array, which should have the same number of elements as the mesh or shell with which it is used. Writing beyond the array bounds will have unpredictable or fatal consequences.

Definition at line 450 of file GiGeometry.h.

◆ setColors()

void OdGiFaceData::setColors ( const OdUInt16 colors)
inline

Sets the face colors to be used by this object.

Parameters
colors[in] Array of color indices.
Remarks
You cannot call both setColors() and setTrueColors().

This function does not make a copy of the array, which should have the same number of elements as the mesh or shell with which it is used. An incorrect number of elements will have unpredictable or fatal consequences.

Definition at line 283 of file GiGeometry.h.

◆ setFillDirections()

void OdGiFaceData::setFillDirections ( const OdGeVector2d fillDirections)
inline

Sets the face fill direction vectors to be used by this object. BIM-specific

Parameters
fillDirections[in] Array of fill direction vectors.
Remarks
This function does not make a copy of the array, which should have the same number of elements as the mesh or shell with which it is used. An incorrect number of elements will have unpredictable or fatal consequences.

Definition at line 413 of file GiGeometry.h.

◆ setFillOrigins()

void OdGiFaceData::setFillOrigins ( const OdGePoint2d fillOrigins)
inline

Sets the face fill origin points to be used by this object. BIM-specific

Parameters
fillOrigins[in] Array of fill origin points.
Remarks
This function does not make a copy of the array, which should have the same number of elements as the mesh or shell with which it is used. An incorrect number of elements will have unpredictable or fatal consequences.

Definition at line 401 of file GiGeometry.h.

◆ setLayers()

void OdGiFaceData::setLayers ( OdDbStub **  layerIds)
inline

Sets the face Layer Table Records to be used by this object.

Parameters
layerIds[in] Array of LayerTableRecord Object IDs.
Remarks
This function does not make a copy of the array, which should have the same number of elements as the mesh or shell with which it is used. An incorrect number of elements will have unpredictable or fatal consequences.

Definition at line 309 of file GiGeometry.h.

◆ setMappers()

void OdGiFaceData::setMappers ( const OdGiMapper mappers)
inline

Sets the face material mappers to be used by this object.

Parameters
mappers[in] Array of material mappers.
Remarks
This function does not make a copy of the array, which should have the same number of elements as the mesh or shell with which it is used. An incorrect number of elements will have unpredictable or fatal consequences.

Definition at line 378 of file GiGeometry.h.

◆ setMaterials()

void OdGiFaceData::setMaterials ( OdDbStub **  materialIds)
inline

Sets the face material object IDs to be used by this object.

Parameters
materialIds[in] Array of material object IDs.
Remarks
This function does not make a copy of the array, which should have the same number of elements as the mesh or shell with which it is used. An incorrect number of elements will have unpredictable or fatal consequences.

Definition at line 366 of file GiGeometry.h.

◆ setNormals()

void OdGiFaceData::setNormals ( const OdGeVector3d normals)
inline

Sets the face normal vectors to be used by this object.

Parameters
normals[in] Array of normal vectors.
Remarks
This function does not make a copy of the array, which should have the same number of elements as the mesh or shell with which it is used. An incorrect number of elements will have unpredictable or fatal consequences.

Definition at line 333 of file GiGeometry.h.

◆ setSelectionMarkers()

void OdGiFaceData::setSelectionMarkers ( const OdGsMarker selectionMarkers)
inline

Sets the face graphics system selection markers to be used by this object.

Parameters
selectionMarkers[in] Array of graphics system selection markers.
Remarks
This function does not make a copy of the array, which should have the same number of elements as the mesh or shell with which it is used. An incorrect number of elements will have unpredictable or fatal consequences.

Definition at line 321 of file GiGeometry.h.

◆ setTransparency()

void OdGiFaceData::setTransparency ( const OdCmTransparency transparencies)
inline

Sets the face transparency to be used by this object.

Parameters
transparencies[in] Array of OdCmTransparency objects.

This function does not make a copy of the array, which should have the same number of elements as the mesh or shell with which it is used. An incorrect number of elements will have unpredictable or fatal consequences.

Definition at line 389 of file GiGeometry.h.

◆ setTrueColors()

void OdGiFaceData::setTrueColors ( const OdCmEntityColor colors)
inline

Sets the face colors to be used by this object.

Parameters
colors[in] Array of OdCmEntityColor objects.
Remarks
You cannot call both setColors() and setTrueColors().

This function does not make a copy of the array, which should have the same number of elements as the mesh or shell with which it is used. An incorrect number of elements will have unpredictable or fatal consequences.

Definition at line 297 of file GiGeometry.h.

◆ setVisibility()

void OdGiFaceData::setVisibility ( const OdUInt8 visibilities)
inline

Sets the face visibilities to be used by this object.

Parameters
visibilities[in] Array of visibility values.
Remarks
Each visibility must be one of the following:

Value Description kOdGiInvisible 0 Invisible kOdGiVisible 1 Visible

Remarks
This function does not make a copy of the array, which should have the same number of elements as the mesh or shell with which it is used. An incorrect number of elements will have unpredictable or fatal consequences.

Definition at line 354 of file GiGeometry.h.

◆ transparency()

const OdCmTransparency* OdGiFaceData::transparency ( ) const
inline

Returns the array of face transparency used by this object.

Remarks
This function does not make a copy of the array, which should have the same number of elements as the mesh or shell with which it is used. Writing beyond the array bounds will have unpredictable or fatal consequences.

Definition at line 504 of file GiGeometry.h.

◆ trueColors()

const OdCmEntityColor* OdGiFaceData::trueColors ( ) const
inline

Returns the array of face colors used by this object.

Remarks
This function does not make a copy of the array, which should have the same number of elements as the mesh or shell with which it is used. Writing beyond the array bounds will have unpredictable or fatal consequences.

Definition at line 432 of file GiGeometry.h.

◆ visibility()

const OdUInt8* OdGiFaceData::visibility ( ) const
inline

Returns the array of edge visibilities used by this object.

Remarks
Each visibility must be one of the following:

Value Description kOdGiInvisible 0 Invisible kOdGiVisible 1 Visible

Remarks
This function does not make a copy of the array, which should have the same number of elements as the mesh or shell with which it is used. Writing beyond the array bounds will have unpredictable or fatal consequences.

Definition at line 477 of file GiGeometry.h.


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