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

#include <IfcModelContext.h>

Public Member Functions

 OdIfcModelContext (OdIfcDeviationParams params=OdIfcDeviationParams(), OdCmEntityColor color=OdCmEntityColor::kNone)
 
OdIfcDeviationParams getDeviationParams () const
 
void setDeviationParams (OdIfcDeviationParams params)
 
OdCmEntityColor getDefaultEntityColor () const
 
void setDefaultEntityColor (const OdCmEntityColor &color)
 
OdArray< OdIfc::OdIfcEntityType > & getGeometryComposeTypes ()
 
void setGeometryComposeTypes (const OdArray< OdIfc::OdIfcEntityType > &geometryComposeTypes)
 
void setSkipComposeIds (const OdDAIObjectIds &notComposeContext)
 
bool checkSkipComposeId (const OdDAIObjectId &id) const
 
void setInterruptCallback (OdDAI::InterruptCallback callbackFunction)
 
OdDAI::InterruptCallback getInterruptCallback ()
 

Detailed Description

A class that implements working with an IFC model context.

Definition at line 38 of file IfcModelContext.h.

Constructor & Destructor Documentation

◆ OdIfcModelContext()

OdIfcModelContext::OdIfcModelContext ( OdIfcDeviationParams  params = OdIfcDeviationParams(),
OdCmEntityColor  color = OdCmEntityColor::kNone 
)

Creates a new model context object with specified deviation parameters and color.

Parameters
params[in] Deviation parameters.
color[in] Default model color value.

Member Function Documentation

◆ checkSkipComposeId()

bool OdIfcModelContext::checkSkipComposeId ( const OdDAIObjectId &  id) const

◆ getDefaultEntityColor()

OdCmEntityColor OdIfcModelContext::getDefaultEntityColor ( ) const

Retrieves the current default model color.

Returns
Returns an instance of the <exref target="https://docs.opendesign.com/tkernel/OdCmEntityColor.html">OdCmEntityColor</exref> object that contains the current default color for the model.

◆ getDeviationParams()

OdIfcDeviationParams OdIfcModelContext::getDeviationParams ( ) const

Retrieves the current set of deviation parameters assigned with the model context.

Returns
Returns an instance of the <link OdIfc::OdIfcDeviationParams, OdIfcDeviationParams> class that contains the current deviation parameters.

◆ getGeometryComposeTypes()

OdArray< OdIfc::OdIfcEntityType > & OdIfcModelContext::getGeometryComposeTypes ( )

Retrieves an array of types which instances should participate in geometry compose process.

Returns
an array of IFC entity types for geometry compose.
Remarks
Types should be derived from IfcProduct.

◆ getInterruptCallback()

OdDAI::InterruptCallback OdIfcModelContext::getInterruptCallback ( )

◆ setDefaultEntityColor()

void OdIfcModelContext::setDefaultEntityColor ( const OdCmEntityColor color)

Sets a new default model color.

Parameters
color[in] An instance of the <exref target="https://docs.opendesign.com/tkernel/OdCmEntityColor.html">OdCmEntityColor</exref> object that represents the new default color.

◆ setDeviationParams()

void OdIfcModelContext::setDeviationParams ( OdIfcDeviationParams  params)

Sets new deviation parameters for the model context.

Parameters
params[in] Deviation parameters to be set.

◆ setGeometryComposeTypes()

void OdIfcModelContext::setGeometryComposeTypes ( const OdArray< OdIfc::OdIfcEntityType > &  geometryComposeTypes)

Sets an array of types which instances should participate in geometry compose process to this IFC model context.

Parameters
geometryComposeTypes[in] an array of IFC entity types for geometry compose.
Remarks
Types should be derived from IfcProduct.

◆ setInterruptCallback()

void OdIfcModelContext::setInterruptCallback ( OdDAI::InterruptCallback  callbackFunction)

◆ setSkipComposeIds()

void OdIfcModelContext::setSkipComposeIds ( const OdDAIObjectIds &  notComposeContext)

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