CFx SDK Documentation  2022 SP0
Public Member Functions | List of all members
OdDbSubentId Class Reference

#include <DbBaseSubentId.h>

Public Member Functions

 OdDbSubentId ()
 
 OdDbSubentId (OdDb::SubentType type, OdGsMarker index)
 
bool operator== (const OdDbSubentId &subentId) const
 
bool operator!= (const OdDbSubentId &subentId) const
 
OdDb::SubentType type () const
 
void setType (OdDb::SubentType type)
 
OdGsMarker index () const
 
void setIndex (OdGsMarker index)
 

Detailed Description

This class implements Subentity Id objects for OdDbEntity objects in an OdDbDatabase instance.

Remarks
A given OdDbEntity object may consist of any number of graphical subentities.

Subentity type must be one of the following:

Value OdDb::kNullSubentType 0 OdDb::kFaceSubentType 1 OdDb::kEdgeSubentType 2 OdDb::kVertexSubentType 3
OdDb::kMlineSubentCache 4

Each SubentityId object is created from a Subentity type and an index.

Corresponding C++ library: TD_DbRoot

<group OdDbRoot_Classes>

Definition at line 71 of file DbBaseSubentId.h.

Constructor & Destructor Documentation

◆ OdDbSubentId() [1/2]

OdDbSubentId::OdDbSubentId ( )
inline

Definition at line 74 of file DbBaseSubentId.h.

◆ OdDbSubentId() [2/2]

OdDbSubentId::OdDbSubentId ( OdDb::SubentType  type,
OdGsMarker  index 
)
inline

Definition at line 79 of file DbBaseSubentId.h.

Member Function Documentation

◆ index()

OdGsMarker OdDbSubentId::index ( ) const
inline

Returns the index of this SubentId object.

Definition at line 139 of file DbBaseSubentId.h.

◆ operator!=()

bool OdDbSubentId::operator!= ( const OdDbSubentId subentId) const
inline

Definition at line 89 of file DbBaseSubentId.h.

◆ operator==()

bool OdDbSubentId::operator== ( const OdDbSubentId subentId) const
inline

Definition at line 84 of file DbBaseSubentId.h.

◆ setIndex()

void OdDbSubentId::setIndex ( OdGsMarker  index)
inline

Sets the index of this SubentId object.

Parameters
index[in] Index.

Definition at line 148 of file DbBaseSubentId.h.

◆ setType()

void OdDbSubentId::setType ( OdDb::SubentType  type)
inline

Sets the type of this SubentId object.

Parameters
type[in] Type.
Remarks
type must be one of the following:

Value OdDb::kNullSubentType 0 OdDb::kFaceSubentType 1 OdDb::kEdgeSubentType 2 OdDb::kVertexSubentType 3
OdDb::kMlineSubentCache 4

Definition at line 132 of file DbBaseSubentId.h.

◆ type()

OdDb::SubentType OdDbSubentId::type ( ) const
inline

Returns the type of this SubentId object.

Remarks

type returns one of the following:

Value OdDb::kNullSubentType 0 OdDb::kFaceSubentType 1 OdDb::kEdgeSubentType 2 OdDb::kVertexSubentType 3
OdDb::kMlineSubentCache 4

Definition at line 110 of file DbBaseSubentId.h.


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