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

#include <IfcProject.h>

Inheritance diagram for OdIfc::OdIfcProject:
OdIfc::OdIfcObjectDefinition OdIfc::OdIfcRoot OdIfc::OdIfcCachedCompound OdIfc::OdIfcCompound OdGiDrawable OdRxObject

Public Member Functions

virtual void compose ()
 
OdDAIObjectId getUnitsInContextId ()
 
OdString getPhase ()
 
OdString getLongName ()
 
OdDAIObjectIds getRepresentationContexts ()
 
virtual bool subWorldDraw (OdGiWorldDraw *pWd) const ODRX_OVERRIDE
 
OdUInt32 subSetAttributes (OdGiDrawableTraits *pTraits) const
 
- Public Member Functions inherited from OdIfc::OdIfcObjectDefinition
virtual void compose ()
 
const OdDAIObjectIds & getIsNestedBy () const
 
OdDAIObjectIds extractIsNestedBy () const
 
- Public Member Functions inherited from OdIfc::OdIfcCachedCompound
 OdIfcCachedCompound ()
 
virtual void setGsNode (OdGsCache *pGsNode)
 
virtual OdGsCache * gsNode () const
 
- Public Member Functions inherited from OdIfc::OdIfcCompound
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
 

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
}
 
- Static Public Member Functions inherited from OdIfc::OdIfcCompound
static OdIfcEntityPtr earlyAccess (OdIfcCompound *pInst)
 
- Static Public Member Functions inherited from OdRxObject
static OdRxObjectPtr cast (const OdRxObject *pointer)
 
static OdRxClass * desc ()
 
- 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
 
- Protected Attributes inherited from OdIfc::OdIfcCachedCompound
OdGsCache * m_pGsNode
 
- Protected Attributes inherited from OdIfc::OdIfcCompound
OdIfcEntity * m_pEntInst
 

Detailed Description

A class that implements storing and handling data about an IFC project. The project determines the design, construction, and maintenance context of a product.

Definition at line 42 of file IfcProject.h.

Member Function Documentation

◆ compose()

virtual void OdIfc::OdIfcProject::compose ( )
virtual

Composes the project object.

Reimplemented from OdIfc::OdIfcObjectDefinition.

◆ getLongName()

OdString OdIfc::OdIfcProject::getLongName ( )

Retrieves the project's long name.

Returns
A string that contains the project's long name.

◆ getPhase()

OdString OdIfc::OdIfcProject::getPhase ( )

Retrieves the project phase.

Returns
A string that contains the phase name.

◆ getRepresentationContexts()

OdDAIObjectIds OdIfc::OdIfcProject::getRepresentationContexts ( )

Retrieves the project's representation context.

Returns
An array of DAI object identifiers, which refer to the representation context objects.

◆ getUnitsInContextId()

OdDAIObjectId OdIfc::OdIfcProject::getUnitsInContextId ( )

Retrieves the unit context identifier of the project.

Returns
An DAI object identifier of the unit's context.

◆ subSetAttributes()

OdUInt32 OdIfc::OdIfcProject::subSetAttributes ( OdGiDrawableTraits *  pTraits) const
virtual

Sets the values of the object's subentity traits, and returns the object's subentity traits to the calling subroutine.

Parameters
pTraits[in] A raw pointer to the <exref target="https://docs.opendesign.com/tv/OdGiDrawableTraits.html">OdGiDrawableTraits</exref> object to be set.
Returns
A set of flags represented with an unsigned 32-bit integer value.
Remarks
When re-implementing this method, use the "or" bit operation (|) for the return value of the parent class' subSetAttributes() method and any flags you have added.
See also
<exref target="https://docs.opendesign.com/tv/OdGiDrawableTraits.html">OdGiDrawableTraits</exref> class documentation.

Reimplemented from OdIfc::OdIfcCompound.

◆ subWorldDraw()

virtual bool OdIfc::OdIfcProject::subWorldDraw ( OdGiWorldDraw *  pWd) const
virtual

Draws the graphical representation of the project object that is independent of any viewport contexts.

Parameters
pWd[in] A raw pointer to the <exref target="https://docs.opendesign.com/tv/OdGiDrawable.html">OdGiDrawable</exref> object that encapsulates parameters of view port independent vectorization.
Returns
true if the drawing was successful; otherwise, the method returns false.

Reimplemented from OdIfc::OdIfcCompound.

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