CFx SDK Documentation 2024 SP0
Loading...
Searching...
No Matches
Public Member Functions | Static Public Member Functions | Protected Attributes | Friends | List of all members
OdIfc::OdIfcCompound Class Reference

#include <IfcCompound.h>

Inheritance diagram for OdIfc::OdIfcCompound:
OdGiDrawable OdRxObject OdIfc::OdIfcCachedCompound OdIfc::OdIfcProfileDef OdIfc::OdIfcProductRepresentation OdIfc::OdIfcRepresentation OdIfc::OdIfcRepresentationItem OdIfc::OdIfcRoot OdIfc::OdIfcProductDefinitionShape OdIfc::OdIfcShapeRepresentation OdIfc::OdIfcGeometricRepresentationItem OdIfc::OdIfcObjectDefinition OdIfc::OdIfcCurve OdIfc::OdIfcSegment OdIfc::OdIfcProduct OdIfc::OdIfcProject OdIfc::OdIfcCurveSegment OdIfc::OdIfcElement OdIfc::OdIfcSpatialStructureElement OdIfc::OdIfcBuilding OdIfc::OdIfcBuildingStorey OdIfc::OdIfcSite

Public Member Functions

virtual void compose ()
 
OdIfcEntityType type ()
 
OdRxValue getAttr (const OdIfcAttribute attrDef) const
 
virtual OdRxValue getAttr (const OdAnsiString &attrName) const
 
OdIfcModel * owningModel () const
 
bool isKindOf (OdIfcEntityType type) const
 
bool isInstanceOf (OdIfcEntityType entityType) const
 
const OdAnsiString & typeName ()
 
OdIfcFile * owningIfcFile () const
 
virtual bool isPersistent () const
 
virtual OdDbStub * id () const
 
virtual void setGsNode (OdGsCache *pGsNode)
 
virtual OdGsCache * gsNode () const
 
virtual OdUInt32 subSetAttributes (OdGiDrawableTraits *traits) const
 
virtual bool subWorldDraw (OdGiWorldDraw *wd) const
 
virtual void subViewportDraw (OdGiViewportDraw *vd) const
 
- Public Member Functions inherited from OdGiDrawable
 ODRX_DECLARE_MEMBERS (OdGiDrawable)
 
virtual DrawableType drawableType () const
 
ODRX_SEALED_VIRTUAL OdUInt32 setAttributes (OdGiDrawableTraits *pTraits) const ODRX_SEALED
 
ODRX_SEALED_VIRTUAL bool worldDraw (OdGiWorldDraw *pWd) const ODRX_SEALED
 
ODRX_SEALED_VIRTUAL void viewportDraw (OdGiViewportDraw *pVd) const ODRX_SEALED
 
virtual bool isPersistent () const =0
 
virtual OdDbStub * id () const =0
 
virtual void setGsNode (OdGsCache *pGsNode)=0
 
virtual OdGsCache * gsNode () const =0
 
ODRX_SEALED_VIRTUAL OdUInt32 viewportDrawLogicalFlags (OdGiViewportDraw *pVd) const ODRX_SEALED
 
virtual OdResult getGeomExtents (OdGeExtents3d &extents) const
 
ODRX_SEALED_VIRTUAL OdUInt32 regenSupportFlags () const ODRX_SEALED
 
- Public Member Functions inherited from OdRxObject
 ODRX_HEAP_OPERATORS ()
 
 OdRxObject ()
 
virtual ~OdRxObject ()
 
virtual OdRxObject * queryX (const OdRxClass *pClass) const
 
virtual OdRxObject * x (const OdRxClass *pClass) const
 
virtual OdRxClass * isA () const
 
virtual void addRef ()=0
 
virtual void release ()=0
 
virtual long numRefs () const
 
bool isKindOf (const OdRxClass *pClass) const
 
virtual OdRxObjectPtr clone () const
 
virtual void copyFrom (const OdRxObject *pSource)
 
virtual OdRx::Ordering comparedTo (const OdRxObject *pOther) const
 
virtual bool isEqualTo (const OdRxObject *pOther) const
 

Static Public Member Functions

static OdIfcEntityPtr earlyAccess (OdIfcCompound *pInst)
 
- Static Public Member Functions inherited from OdRxObject
static OdRxObjectPtr cast (const OdRxObject *pointer)
 
static OdRxClass * desc ()
 

Protected Attributes

OdIfcEntity * m_pEntInst
 

Friends

class ::OdIfcEntResolver
 

Additional Inherited Members

- Public Types inherited from OdGiDrawable
enum  SetAttributesFlags {
  kDrawableNone = 0 , kDrawableIsAnEntity = 1 , kDrawableUsesNesting = 2 , kDrawableIsCompoundObject = 4 ,
  kDrawableViewIndependentViewportDraw = 8 , kDrawableIsInvisible = 16 , kDrawableHasAttributes = 32 , kDrawableRegenTypeDependantGeometry = 64 ,
  kDrawableIsDimension = (kDrawableIsAnEntity + kDrawableIsCompoundObject + 128) , kDrawableRegenDraw = 256 , kDrawableStandardDisplaySingleLOD = 512 , kDrawableShadedDisplaySingleLOD = 1024 ,
  kDrawableViewDependentViewportDraw = 2048 , kDrawableBlockDependentViewportDraw = 4096 , kDrawableIsExternalReference = 8192 , kDrawableNotPlottable = 16384 ,
  kDrawableNotAllowLCS = 32768 , kDrawableMergeControlOff = 65536 , kLastFlag = kDrawableMergeControlOff
}
 
enum  DrawableType {
  kGeometry = 0 , kDistantLight = 1 , kPointLight = 2 , kSpotLight = 3 ,
  kAmbientLight , kSolidBackground , kGradientBackground , kImageBackground ,
  kGroundPlaneBackground , kViewport , kWebLight , kSkyBackground ,
  kImageBasedLightingBackground
}
 
- Protected Member Functions inherited from OdGiDrawable
 OdGiDrawable ()
 
virtual OdUInt32 subSetAttributes (OdGiDrawableTraits *traits) const =0
 
virtual bool subWorldDraw (OdGiWorldDraw *wd) const =0
 
virtual void subViewportDraw (OdGiViewportDraw *vd) const =0
 
virtual OdUInt32 subViewportDrawLogicalFlags (OdGiViewportDraw *vd) const
 
virtual OdUInt32 subRegenSupportFlags () const
 

Detailed Description

A class that implements working with an IFC compound object.

Definition at line 40 of file IfcCompound.h.

Member Function Documentation

◆ compose()

virtual void OdIfc::OdIfcCompound::compose ( )
virtual

Composes the compound object into a specified model.

Remarks
The pointer to a model is deprecated and can be removed from the method signature in future releases.

Reimplemented in OdIfc::OdIfcBuilding, OdIfc::OdIfcBuildingStorey, OdIfc::OdIfcElement, OdIfc::OdIfcObjectDefinition, OdIfc::OdIfcProduct, OdIfc::OdIfcProductRepresentation, OdIfc::OdIfcProject, OdIfc::OdIfcRepresentation, OdIfc::OdIfcRepresentationItem, OdIfc::OdIfcShapeRepresentation, OdIfc::OdIfcSite, OdIfc::OdIfcSpatialStructureElement, OdIfc::OdIfcCurveSegment, and OdIfc::OdIfcSegment.

◆ earlyAccess()

static OdIfcEntityPtr OdIfc::OdIfcCompound::earlyAccess ( OdIfcCompound *  pInst)
inlinestatic

Retrieves the compound object's underlying IFC entity instance.

Parameters
pInst[in] A raw pointer to the compound object.
Returns
Returns a smart pointer to the compound object.

Definition at line 116 of file IfcCompound.h.

◆ getAttr() [1/2]

virtual OdRxValue OdIfc::OdIfcCompound::getAttr ( const OdAnsiString &  attrName) const
inlinevirtual

Retrieves the current value of an attribute specified by its name.

Parameters
attrName[in] An ANSI string that contains the attribute name.
Returns
Returns the current value of the attribute.
Remarks
The method provides late binding access to the attribute value by its name. Attributes of select and aggregate data types are also supported.

Definition at line 83 of file IfcCompound.h.

◆ getAttr() [2/2]

OdRxValue OdIfc::OdIfcCompound::getAttr ( const OdIfcAttribute  attrDef) const
inline

Retrieves the current value of an attribute specified by its definition.

Parameters
attrDef[in] A value of the <link OdIfc::OdIfcAttribute, OdIfcAttribute> enumeration that represents the attribute definition.
Returns
Returns the current value of the attribute.
Remarks
The method provides late binding access to the attribute value by its definition. Attributes of select and aggregate data types are also supported.

Definition at line 73 of file IfcCompound.h.

◆ gsNode()

virtual OdGsCache * OdIfc::OdIfcCompound::gsNode ( ) const
virtual

Retrieves the current Gs node object of the compound object.

Returns
Returns a raw pointer to the <exref target="https://docs.opendesign.com/tv/OdGsCache.html">OdGsCache</exref> object associated with the compound object.

Implements OdGiDrawable.

Reimplemented in OdIfc::OdIfcCachedCompound.

◆ id()

virtual OdDbStub * OdIfc::OdIfcCompound::id ( ) const
inlinevirtual

Retrieves the identifier of the compound object's database.

Returns
Returns a raw pointer to a stub object that provides access to the database.
Remarks
The method returns a NULL pointer if the compound object is not a persistent one.

Implements OdGiDrawable.

Definition at line 138 of file IfcCompound.h.

◆ isInstanceOf()

bool OdIfc::OdIfcCompound::isInstanceOf ( OdIfcEntityType  entityType) const
inline

Retrieves whether the compound object is an instance of a specified type.

Parameters
entityType[in] An instance of the <link OdIfc::OdIfcEntityType, OdIfcEntityType> enumeration that represents the entity type.
Returns
Returns true if the compound object is an instance of the specified type; otherwise, the method returns false.

Definition at line 103 of file IfcCompound.h.

◆ isKindOf()

bool OdIfc::OdIfcCompound::isKindOf ( OdIfcEntityType  type) const
inline

Retrieves whether the compound object belongs to a specified entity type.

Parameters
entityName[in] An entity type name.
Returns
Returns true if the compound object belongs to the specified type; otherwise, the method returns false.

Definition at line 96 of file IfcCompound.h.

◆ isPersistent()

virtual bool OdIfc::OdIfcCompound::isPersistent ( ) const
inlinevirtual

Retrieves whether the compound object is a persistent one.

Returns
Returns true if the compound object is a persistent one; otherwise, the method returns false.
Remarks
Persistent objects are database-resident objects (i.e., they are stored in a database).

Implements OdGiDrawable.

Definition at line 130 of file IfcCompound.h.

◆ owningIfcFile()

OdIfcFile * OdIfc::OdIfcCompound::owningIfcFile ( ) const

◆ owningModel()

OdIfcModel * OdIfc::OdIfcCompound::owningModel ( ) const

Retrieves the model that currently owns the compound object.

Returns
Returns a raw pointer to the <link OdIfc::OdIfcModel, OdIfcModel> object representing the model that owns the entity.

◆ setGsNode()

virtual void OdIfc::OdIfcCompound::setGsNode ( OdGsCache *  pGsNode)
virtual

Sets a new Gs node cache for the compound object.

Parameters
pGsNode[in] A raw pointer to an <exref target="https://docs.opendesign.com/tv/OdGsCache.html">OdGsCache</exref> object.

Implements OdGiDrawable.

Reimplemented in OdIfc::OdIfcCachedCompound.

◆ subSetAttributes()

virtual OdUInt32 OdIfc::OdIfcCompound::subSetAttributes ( OdGiDrawableTraits *  traits) const
virtual

Sets the values of the compound object's sub-entity traits.

Parameters
traits[out] A raw pointer to the traits to be filled and returned to a calling subroutine.
Returns
Returns the result of setting the values.

Implements OdGiDrawable.

Reimplemented in OdIfc::OdIfcProject, OdIfc::OdIfcRepresentationItem, OdIfc::OdIfcProduct, and OdIfc::OdIfcShapeRepresentation.

◆ subViewportDraw()

virtual void OdIfc::OdIfcCompound::subViewportDraw ( OdGiViewportDraw *  vd) const
virtual

Draws a graphical compound object that is dependent on the viewport context.

Parameters
vd[in] A raw pointer to the object that encapsulates parameters of viewport-dependent vectorization.

Implements OdGiDrawable.

◆ subWorldDraw()

virtual bool OdIfc::OdIfcCompound::subWorldDraw ( OdGiWorldDraw *  wd) const
virtual

Draws a graphical compound object representation that is independent of any viewport contexts.

Parameters
wd[in] A raw pointer to the object that encapsulates parameters of viewport-independent vectorization.
Returns
Returns true if drawing was successful; otherwise, the method returns false.

Implements OdGiDrawable.

Reimplemented in OdIfc::OdIfcShapeRepresentation, OdIfc::OdIfcProject, OdIfc::OdIfcProduct, and OdIfc::OdIfcRepresentationItem.

◆ type()

OdIfcEntityType OdIfc::OdIfcCompound::type ( )

Retrieves the current type of the compound object.

Returns
Returns an <link OdIfc::OdIfcEntityType, OdIfcEntityType> enumeration value that represents the current compound object type.

◆ typeName()

const OdAnsiString & OdIfc::OdIfcCompound::typeName ( )
inline

Retrieves the name of the current compound object's type.

Returns
Returns an ANSI string value that contains the current compound object's type name.

Definition at line 109 of file IfcCompound.h.

Friends And Related Function Documentation

◆ ::OdIfcEntResolver

friend class ::OdIfcEntResolver
friend

Definition at line 177 of file IfcCompound.h.

Member Data Documentation

◆ m_pEntInst

OdIfcEntity* OdIfc::OdIfcCompound::m_pEntInst
protected

Definition at line 47 of file IfcCompound.h.

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