CFx SDK Documentation 2026 SP0
Loading...
Searching...
No Matches
OdIfc4::IfcStyledItem Class Reference

#include <IfcStyledItemAutoImpl.h>

Inheritance diagram for OdIfc4::IfcStyledItem:
OdIfc4::IfcRepresentationItem OdIfc4::OdIfc4Instance OdIfc::OdIfcInstance

Public Member Functions

const OdDAIObjectId & getItem () const
 
void setItem (const OdDAIObjectId &Item)
 
void getStyles (OdArray< OdDAI::Select > &Styles) const
 
void getStylesWrapperArray (OdArray< IfcStyleAssignmentSelect > &Styles) const
 
OdDAI::SetOfSelect & styles ()
 
const OdAnsiString & getName () const
 
void setName (const OdAnsiString &Name)
 
 IfcStyledItem ()
 
virtual OdResult inFields (OdDAI::OdSpfFilerBase *rdFiler) override
 
virtual OdResult outFields (OdDAI::OdSpfFilerBase *wrFiler) override
 
virtual void setInverseCounterParts () override
 
virtual OdDAI::Entity * getInstanceType () const override
 
virtual OdRxValue getAttr (const char *attrName) const override
 
virtual bool comparedToEarlyImpl (const OdDAI::ApplicationInstance *pOther, OdRx::Ordering &ordering) const override
 
virtual void unsetAttr (const char *explicitAttrName) override
 
virtual bool testAttr (const char *explicitAttrName) const override
 
virtual bool putAttr (const char *explicitAttrName, const OdRxValue &val) override
 
virtual bool isKindOf (OdIfc::OdIfcEntityType entityType) const override
 
virtual OdIfc::OdIfcEntityType type () const override
 
virtual OdRxValue getAttr (const OdIfc::OdIfcAttribute attrDef) const override
 
virtual void unsetAttr (const OdIfc::OdIfcAttribute explicitAttrDef) override
 
virtual bool testAttr (const OdIfc::OdIfcAttribute explicitAttrDef) const override
 
virtual bool putAttr (const OdIfc::OdIfcAttribute explicitAttrDef, const OdRxValue &val) override
 
- Public Member Functions inherited from OdIfc4::IfcRepresentationItem
void getInvLayerAssignment (OdDAIObjectIds &LayerAssignment) const
 
void getInvStyledByItem (OdDAIObjectIds &StyledByItem) const
 
- Public Member Functions inherited from OdIfc4::OdIfc4Instance
void setInverseCounterParts () override
 
- Public Member Functions inherited from OdIfc::OdIfcInstance
 ODRX_DECLARE_MEMBERS (OdIfcInstance)
 
 OdIfcInstance ()
 
 ~OdIfcInstance ()
 
bool isInstanceOf (OdIfcEntityType entityType) const
 
IfcOpResult resolved ()
 
void resolve (IfcOpResult resolved, void *resPtr)
 
void unresolve ()
 
virtual void setGsNode (OdGsCache *pGsNode)
 
virtual OdGsCachegsNode () const
 
virtual OdUInt32 subSetAttributes (OdGiDrawableTraits *traits) const
 
virtual bool subWorldDraw (OdGiWorldDraw *wd) const
 
virtual OdDbStub * ownerId () const
 

Protected Attributes

OdDAIObjectId m_Item
 
OdDAI::SetOfSelect m_Styles
 
OdAnsiString m_Name
 
- Protected Attributes inherited from OdIfc::OdIfcInstance
voidm_resPtr
 
IfcOpResult m_resolved
 

Additional Inherited Members

- Static Public Member Functions inherited from OdIfc::OdIfcInstance
static const OdGePoint3dasPoint3d (const OdIfcInstance *inst)
 
static const OdGePoint2dasPoint2d (const OdIfcInstance *inst)
 
static const OdGeVector3dasVector3d (const OdIfcInstance *inst)
 
static const OdGeVector2dasVector2d (const OdIfcInstance *inst)
 
static const OdGeMatrix2dasMatrix2d (const OdIfcInstance *inst)
 
static const OdGeMatrix3dasMatrix3d (const OdIfcInstance *inst)
 
static OdIfcCompoundPtr asCompound (OdSmartPtr< OdIfcInstance > inst)
 
static const OdCmEntityColorasRgbColor (const OdIfcInstance *inst)
 

Detailed Description

The IfcStyledItem holds presentation style information for products, either explicitly for an IfcGeometricRepresentationItem being part of an IfcShapeRepresentation assigned to a product, or by assigning presentation information to IfcMaterial being assigned as other representation for a product. If the IfcStyledItem is used within a reference from an IfcProductDefinitionShape then one Item is provided. If the IfcStyledItem is used within a reference from an IfcMaterialDefinitionRepresentation then no Item is provided.

  • Example - The image below illustrates use of IfcStyledItem for the two usage examples: As a presentation for a geometric representation item As a presentation for a material definition

<IMAGE ifcstyleditem_fig-1>

The new IfcStyleAssignmentSelect allows the direct assignment styles, such as IfcCurveStyle, IfcSurfaceStyle without using the intermediate IfcPresentationStyleAssignment.

\changes

IFC4 changes: Type of the Styles attribute changed from "set[1:?] of IfcPresentationStyleAssignment" to "set[1:?] of IfcStyleAssignmentSelect"

Definition at line 59 of file Ifc4/IfcStyledItemAutoImpl.h.

Constructor & Destructor Documentation

◆ IfcStyledItem()

OdIfc4::IfcStyledItem::IfcStyledItem ( )

Default constructor for the IfcStyledItem class.

Member Function Documentation

◆ comparedToEarlyImpl()

virtual bool OdIfc4::IfcStyledItem::comparedToEarlyImpl ( const OdDAI::ApplicationInstance * pOther,
OdRx::Ordering & ordering ) const
overridevirtual

Early-bound version of instances comparison.

Parameters
pOther[in] Other application instance.
ordering[out] Receives the ordering (comparison) status.
Returns
true if comparison was performed, false if method has no implementation, so late-bound version could be applied.
Remarks
If the method returns true, the ordering parameter can receive one of the following statuses:
Value Description kLessThan -1 This object < Other Object. kEqual 0 This object = Other Object. kGreaterThan 1 This object > Other Object. kNotOrderable 2 This class is not orderable.

Reimplemented from OdIfc4::IfcRepresentationItem.

◆ getAttr() [1/2]

virtual OdRxValue OdIfc4::IfcStyledItem::getAttr ( const char * attrName) const
overridevirtual

Returns an attribute value for the specified attribute name.

Parameters
attrName[in] Name of an attribute to query.
Returns
OdRxValue object that represents a generic variant type value.

◆ getAttr() [2/2]

virtual OdRxValue OdIfc4::IfcStyledItem::getAttr ( const OdIfc::OdIfcAttribute attrDef) const
overridevirtual

Returns an attribute value for the specified attribute definition.

Parameters
attrDef[in] Attribute definition to query.
Returns
OdRxValue object that represents a generic variant type value.

Reimplemented from OdIfc4::IfcRepresentationItem.

◆ getInstanceType()

virtual OdDAI::Entity * OdIfc4::IfcStyledItem::getInstanceType ( ) const
overridevirtual

Returns a type of a class instance.

Returns
Pointer to the <exref target=https://docs.opendesign.com/tkernel_api_cpp/OdDAI__Entity.html>>OdDAI::Entity</exref> type that determines an entity definition within a schema.

Reimplemented from OdIfc4::IfcRepresentationItem.

◆ getItem()

const OdDAIObjectId & OdIfc4::IfcStyledItem::getItem ( ) const

Returns the value of Item attribute. This attribute represents a geometric representation item to which the style is assigned.

Returns
Returns the value of Item attribute.
Remarks
IFC2x2 change: The attribute Item has been made optional. Upward compatibility for file based exchange is guaranteed.

◆ getName()

const OdAnsiString & OdIfc4::IfcStyledItem::getName ( ) const

Returns the value of Name attribute. This attribute represents the word, or group of words, by which the styled item is referred to.

Returns
Returns the value of Name attribute.

◆ getStyles()

void OdIfc4::IfcStyledItem::getStyles ( OdArray< OdDAI::Select > & Styles) const

Gets the value of Styles attribute. This attribute represents representation styles which are assigned, either to an geometric representation item, or to a material definition.

Parameters
Styles[out] Receives the Styles attribute.
Remarks
IFC4 change: The data type has been changed to IfcStyleAssignmentSelect with upward compatibility for file based exchange. Only the select item IfcPresentationStyle is used from IFC4 onwards, the IfcPresentationStyleAssignment has been deprecated.

◆ getStylesWrapperArray()

void OdIfc4::IfcStyledItem::getStylesWrapperArray ( OdArray< IfcStyleAssignmentSelect > & Styles) const

Gets the value of Styles attribute. This attribute represents representation styles which are assigned, either to an geometric representation item, or to a material definition.

Parameters
Styles[out] Receives the Styles attribute.
Remarks
IFC4 change: The data type has been changed to IfcStyleAssignmentSelect with upward compatibility for file based exchange. Only the select item IfcPresentationStyle is used from IFC4 onwards, the IfcPresentationStyleAssignment has been deprecated.

◆ inFields()

virtual OdResult OdIfc4::IfcStyledItem::inFields ( OdDAI::OdSpfFilerBase * rdFiler)
overridevirtual

Reads object's data from the specified filer.

Parameters
rdFiler[in] Pointer to a filer from which to read the data.
Returns
A value of OdResult type that contains the result of the method execution.

Reimplemented from OdIfc4::IfcRepresentationItem.

◆ isKindOf()

virtual bool OdIfc4::IfcStyledItem::isKindOf ( OdIfc::OdIfcEntityType entityType) const
overridevirtual

Checks whether the specified instance is the object derived from or belongs to this class.

Parameters
entityType[in] Entity to check.
Returns
true if the specified instance is the object derived from or belongs to this class, false otherwise.

Reimplemented from OdIfc4::IfcRepresentationItem.

◆ outFields()

virtual OdResult OdIfc4::IfcStyledItem::outFields ( OdDAI::OdSpfFilerBase * wrFiler)
overridevirtual

Writes object's data the the specified filer.

Parameters
wrFiler[in] Pointer to a filer to which to write the data.
Returns
A value of OdResult type that contains the result of the method execution.

Reimplemented from OdIfc4::IfcRepresentationItem.

◆ putAttr() [1/2]

virtual bool OdIfc4::IfcStyledItem::putAttr ( const char * explicitAttrName,
const OdRxValue & val )
overridevirtual

Sets the specified attribute with a given value.

Parameters
explicitAttrName[in] Explicit name of the attribute to set.
val[in] Value to set.
Returns
true if the value is successfully set for the specified attribute, false otherwise.

Reimplemented from OdIfc::OdIfcInstance.

◆ putAttr() [2/2]

virtual bool OdIfc4::IfcStyledItem::putAttr ( const OdIfc::OdIfcAttribute explicitAttrDef,
const OdRxValue & val )
overridevirtual

Sets the specified attribute with a given value.

Parameters
explicitAttrDef[in] Explicit attribute definition to set.
val[in] Value to set.
Returns
true if the value is successfully set for the specified attribute, false otherwise.

Reimplemented from OdIfc4::IfcRepresentationItem.

◆ setInverseCounterParts()

virtual void OdIfc4::IfcStyledItem::setInverseCounterParts ( )
overridevirtual

Sets the object ID of this instance to inverse attributes of related instances according to schema specification of inverse attributes.

◆ setItem()

void OdIfc4::IfcStyledItem::setItem ( const OdDAIObjectId & Item)

Sets the value of Item attribute. This attribute represents a geometric representation item to which the style is assigned.

Parameters
Item[in] Item to set.
Remarks
IFC2x2 change: The attribute Item has been made optional. Upward compatibility for file based exchange is guaranteed.

◆ setName()

void OdIfc4::IfcStyledItem::setName ( const OdAnsiString & Name)

Sets the value of Name attribute. This attribute represents the word, or group of words, by which the styled item is referred to.

Parameters
Name[in] Name to set.

◆ styles()

OdDAI::SetOfSelect & OdIfc4::IfcStyledItem::styles ( )

Returns the value of Styles attribute. This attribute represents representation styles which are assigned, either to an geometric representation item, or to a material definition.

Returns
Returns the value of Styles attribute.
Remarks
IFC4 change: The data type has been changed to IfcStyleAssignmentSelect with upward compatibility for file based exchange. Only the select item IfcPresentationStyle is used from IFC4 onwards, the IfcPresentationStyleAssignment has been deprecated.

◆ testAttr() [1/2]

virtual bool OdIfc4::IfcStyledItem::testAttr ( const char * explicitAttrName) const
overridevirtual

Checks whether the specified attribute is set.

Parameters
explicitAttrName[in] Explicit name of the attribute to test.
Returns
true if the specified attribute is set, false otherwise.

Reimplemented from OdIfc4::IfcRepresentationItem.

◆ testAttr() [2/2]

virtual bool OdIfc4::IfcStyledItem::testAttr ( const OdIfc::OdIfcAttribute explicitAttrDef) const
overridevirtual

Checks whether the specified attribute is set.

Parameters
explicitAttrDef[in] Attribute definition to test.
Returns
true if the specified attribute is set, false otherwise.

Reimplemented from OdIfc4::IfcRepresentationItem.

◆ type()

virtual OdIfc::OdIfcEntityType OdIfc4::IfcStyledItem::type ( ) const
overridevirtual

Returns the type of this entity.

Returns
A value of the <exref target=https://docs.opendesign.com/tkernel_api_cpp/OdIfc__OdIfcEntityType.html>>OdIfc::OdIfcEntityType</exref> type that represents type of this entity.

Reimplemented from OdIfc4::IfcRepresentationItem.

◆ unsetAttr() [1/2]

virtual void OdIfc4::IfcStyledItem::unsetAttr ( const char * explicitAttrName)
overridevirtual

Resets a value for the specified attribute.

Parameters
explicitAttrName[in] Explicit name of the attribute to reset.

Reimplemented from OdIfc4::IfcRepresentationItem.

◆ unsetAttr() [2/2]

virtual void OdIfc4::IfcStyledItem::unsetAttr ( const OdIfc::OdIfcAttribute explicitAttrDef)
overridevirtual

Resets a value for the specified attribute.

Parameters
explicitAttrDef[in] Explicit definition that represents an attribute to reset.

Reimplemented from OdIfc4::IfcRepresentationItem.

Member Data Documentation

◆ m_Item

OdDAIObjectId OdIfc4::IfcStyledItem::m_Item
protected

Definition at line 272 of file Ifc4/IfcStyledItemAutoImpl.h.

◆ m_Name

OdAnsiString OdIfc4::IfcStyledItem::m_Name
protected

Definition at line 274 of file Ifc4/IfcStyledItemAutoImpl.h.

◆ m_Styles

OdDAI::SetOfSelect OdIfc4::IfcStyledItem::m_Styles
protected

Definition at line 273 of file Ifc4/IfcStyledItemAutoImpl.h.


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