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

#include <GiGeometry.h>

Inheritance diagram for OdGiEdgeData:
OdGiEdgeDataStorage

Public Member Functions

 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 OdUInt16 * colors () const
 
const OdCmEntityColor * trueColors () const
 
OdDbStub ** layerIds () const
 
OdDbStub ** linetypeIds () const
 
const OdGsMarker * selectionMarkers () const
 
const OdUInt8 * visibility () const
 

Detailed Description

This class represents arrays of edge attributes for meshes and shells.

Remarks
EdgeData objects are optional; they can be optionally passed to OdGiWorldGeometry and OdGiViewportGeometry when using their mesh and shell methods.
Setting an 'improper' size of any array will cause unpredictable or fatal results.
See also
TD_Gi

<group OdGi_Classes>

Definition at line 67 of file GiGeometry.h.

Constructor & Destructor Documentation

◆ OdGiEdgeData()

OdGiEdgeData::OdGiEdgeData ( )
inline

Default constructor for the OdGiEdgeData class. Sets current color index, true color, layer and linetype identifiers, selection markers, visibility objects to NULL.

Definition at line 80 of file GiGeometry.h.

Member Function Documentation

◆ colors()

const OdUInt16 * OdGiEdgeData::colors ( ) const
inline

Returns the array of edge colors used by this object.

Returns
pointer to the array of color indices.
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.
See also
<exref target="https://docs.opendesign.com/td/cm.html">Working with Colors</exref>

Definition at line 186 of file GiGeometry.h.

◆ layerIds()

OdDbStub ** OdGiEdgeData::layerIds ( ) const
inline

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

Returns
pointer to the array of layer identifiers.
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.
See also
<link tv_working_with_attributes_layers, Work with Layers>

Definition at line 212 of file GiGeometry.h.

◆ linetypeIds()

OdDbStub ** OdGiEdgeData::linetypeIds ( ) const
inline

Returns the array of edge LinetypeTableRecord Object IDs used by this object.

Returns
pointer to the array of linetype identifiers.
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.
See also
<exref target="https://docs.opendesign.com/td/db_linetype.html">Working with Linetypes</exref>

Definition at line 226 of file GiGeometry.h.

◆ selectionMarkers()

const OdGsMarker * OdGiEdgeData::selectionMarkers ( ) const
inline

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

Returns
pointer to the array of 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. Writing beyond the array bounds will have unpredictable or fatal consequences.

Definition at line 238 of file GiGeometry.h.

◆ setColors()

void OdGiEdgeData::setColors ( const OdUInt16 *  colors)
inline

Sets the edge 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.
See also
<exref target="https://docs.opendesign.com/td/cm.html">Working with Colors</exref>

Definition at line 100 of file GiGeometry.h.

◆ setLayers()

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

Sets the edge 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.
See also
<link tv_working_with_attributes_layers, Work with Layers>

Definition at line 127 of file GiGeometry.h.

◆ setLinetypes()

void OdGiEdgeData::setLinetypes ( OdDbStub **  linetypeIds)
inline

Sets the edge Linetype Table Records to be used by this object.

Parameters
linetypeIds[in] Array of LinetypeTableRecord 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.
See also
<exref target="https://docs.opendesign.com/td/db_linetype.html">Working with Linetypes</exref>

Definition at line 140 of file GiGeometry.h.

◆ setSelectionMarkers()

void OdGiEdgeData::setSelectionMarkers ( const OdGsMarker *  selectionMarkers)
inline

Sets the edge 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 151 of file GiGeometry.h.

◆ setTrueColors()

void OdGiEdgeData::setTrueColors ( const OdCmEntityColor *  colors)
inline

Sets the edge 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.
See also
<exref target="https://docs.opendesign.com/td/cm.html">Working with Colors</exref>

Definition at line 114 of file GiGeometry.h.

◆ setVisibility()

void OdGiEdgeData::setVisibility ( const OdUInt8 *  visibilities)
inline

Sets the edge 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 kOdGiSilhouette 2 Silhouette edge

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 172 of file GiGeometry.h.

◆ trueColors()

const OdCmEntityColor * OdGiEdgeData::trueColors ( ) const
inline

Returns the array of edge colors used by this object.

Returns
pointer to the array of colors.
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.
See also
<exref target="https://docs.opendesign.com/td/cm.html">Working with Colors</exref>

Definition at line 199 of file GiGeometry.h.

◆ visibility()

const OdUInt8 * OdGiEdgeData::visibility ( ) const
inline

Returns the array of edge visibilities used by this object.

Returns
pointer to the array of visibility values.
Remarks
Each visibility must be one of the following:

Value Description kOdGiInvisible 0 Invisible kOdGiVisible 1 Visible kOdGiSilhouette 2 Silhouette edge

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 260 of file GiGeometry.h.

The documentation for this class was generated from the following file:
Generated on Wed Apr 5 2023 17:31:16