CFx SDK Documentation 2026 SP0
Loading...
Searching...
No Matches
OdIfc2x3::IfcBlock Class Reference

#include <IfcBlockAutoImpl.h>

Inheritance diagram for OdIfc2x3::IfcBlock:
OdIfc2x3::IfcCsgPrimitive3D OdIfc2x3::IfcGeometricRepresentationItem OdIfc2x3::IfcRepresentationItem OdIfc2x3::OdIfc2x3Instance OdIfc::OdIfcInstance

Public Member Functions

double getXLength () const
 
void setXLength (double XLength)
 
double getYLength () const
 
void setYLength (double YLength)
 
double getZLength () const
 
void setZLength (double ZLength)
 
 IfcBlock ()
 
virtual OdResult inFields (OdDAI::OdSpfFilerBase *rdFiler) override
 
virtual OdResult outFields (OdDAI::OdSpfFilerBase *wrFiler) 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 OdIfc2x3::IfcCsgPrimitive3D
const OdDAIObjectId & getPosition () const
 
void setPosition (const OdDAIObjectId &Position)
 
- Public Member Functions inherited from OdIfc2x3::IfcRepresentationItem
void getInvLayerAssignments (OdDAIObjectIds &LayerAssignments) const
 
void getInvStyledByItem (OdDAIObjectIds &StyledByItem) const
 
- Public Member Functions inherited from OdIfc2x3::OdIfc2x3Instance
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

IfcPositiveLengthMeasure m_XLength
 
IfcPositiveLengthMeasure m_YLength
 
IfcPositiveLengthMeasure m_ZLength
 
- Protected Attributes inherited from OdIfc2x3::IfcCsgPrimitive3D
OdDAIObjectId m_Position
 
- 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 IfcBlock is a Construction Solid Geometry (CSG) 3D primitive. It is defined by a position and a positive distance along the three orthogonal axes.

  • Details - The inherited Position attribute has the IfcAxisPlacement3D type and provides: SELF\IfcCsgPrimitive3D.Position: The location and orientation of the axis system for the primitive. SELF\IfcCsgPrimitive3D.Position.Location: The block has one vertex at location and the edges are aligned with the placement axes in the positive sense.

The XLength, YLength, and ZLength attributes define the size of the IfcBlock along the three axes. The image below illustrates geometric parameters of a block where the block positioned within its own placement coordinate system. The values for XLength, YLength, and ZLength are applied to the positive direction of the X, Y, and Z axis.

<IMAGE ifcblock-layout1>

  • Texture Use Definition - On each side face, textures are aligned facing upright. On the top and bottom faces, textures are aligned facing front-to-back. Textures are stretched or repeated to the extent of each face according to RepeatS and RepeatT. The image below illustrates default texture mapping with a clamped texture (RepeatS=False and RepeatT=False). The image on the left shows the texture where the S axis points to the right and the T axis points up. The image on the right shows the texture applied to the geometry where the X axis points back to the right, the Y axis points back to the left, and the Z axis points up.

<IMAGE ifcblock-texture>

Definition at line 63 of file Ifc2x3/IfcBlockAutoImpl.h.

Constructor & Destructor Documentation

◆ IfcBlock()

OdIfc2x3::IfcBlock::IfcBlock ( )

Default constructor for the IfcBlock class.

Member Function Documentation

◆ comparedToEarlyImpl()

virtual bool OdIfc2x3::IfcBlock::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 OdIfc2x3::IfcCsgPrimitive3D.

◆ getAttr() [1/2]

virtual OdRxValue OdIfc2x3::IfcBlock::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.

Reimplemented from OdIfc2x3::IfcCsgPrimitive3D.

◆ getAttr() [2/2]

virtual OdRxValue OdIfc2x3::IfcBlock::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 OdIfc2x3::IfcCsgPrimitive3D.

◆ getInstanceType()

virtual OdDAI::Entity * OdIfc2x3::IfcBlock::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 OdIfc2x3::IfcCsgPrimitive3D.

◆ getXLength()

double OdIfc2x3::IfcBlock::getXLength ( ) const

Returns the value of XLength attribute. This attribute represents the size of the block along the placement X axis. It is provided by the inherited axis placement through SELF\IfcCsgPrimitive3D.Position.P[1].

Returns
Returns the value of XLength attribute.

◆ getYLength()

double OdIfc2x3::IfcBlock::getYLength ( ) const

Returns the value of YLength attribute. This attribute represents the size of the block along the placement Y axis. It is provided by the inherited axis placement through SELF\IfcCsgPrimitive3D.Position.P[2].

Returns
Returns the value of YLength attribute.

◆ getZLength()

double OdIfc2x3::IfcBlock::getZLength ( ) const

Returns the value of ZLength attribute. This attribute represents the size of the block along the placement Z axis. It is provided by the inherited axis placement through SELF\IfcCsgPrimitive3D.Position.P[3].

Returns
Returns the value of ZLength attribute.

◆ inFields()

virtual OdResult OdIfc2x3::IfcBlock::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 OdIfc2x3::IfcCsgPrimitive3D.

◆ isKindOf()

virtual bool OdIfc2x3::IfcBlock::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 OdIfc2x3::IfcCsgPrimitive3D.

◆ outFields()

virtual OdResult OdIfc2x3::IfcBlock::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 OdIfc2x3::IfcCsgPrimitive3D.

◆ putAttr() [1/2]

virtual bool OdIfc2x3::IfcBlock::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 OdIfc2x3::IfcCsgPrimitive3D.

◆ putAttr() [2/2]

virtual bool OdIfc2x3::IfcBlock::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 OdIfc2x3::IfcCsgPrimitive3D.

◆ setXLength()

void OdIfc2x3::IfcBlock::setXLength ( double XLength)

Sets the value of XLength attribute. This attribute represents the size of the block along the placement X axis. It is provided by the inherited axis placement through SELF\IfcCsgPrimitive3D.Position.P[1].

Parameters
XLength[in] XLength to set.

◆ setYLength()

void OdIfc2x3::IfcBlock::setYLength ( double YLength)

Sets the value of YLength attribute. This attribute represents the size of the block along the placement Y axis. It is provided by the inherited axis placement through SELF\IfcCsgPrimitive3D.Position.P[2].

Parameters
YLength[in] YLength to set.

◆ setZLength()

void OdIfc2x3::IfcBlock::setZLength ( double ZLength)

Sets the value of ZLength attribute. This attribute represents the size of the block along the placement Z axis. It is provided by the inherited axis placement through SELF\IfcCsgPrimitive3D.Position.P[3].

Parameters
ZLength[in] ZLength to set.

◆ testAttr() [1/2]

virtual bool OdIfc2x3::IfcBlock::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 OdIfc2x3::IfcCsgPrimitive3D.

◆ testAttr() [2/2]

virtual bool OdIfc2x3::IfcBlock::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 OdIfc2x3::IfcCsgPrimitive3D.

◆ type()

virtual OdIfc::OdIfcEntityType OdIfc2x3::IfcBlock::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 OdIfc2x3::IfcCsgPrimitive3D.

◆ unsetAttr() [1/2]

virtual void OdIfc2x3::IfcBlock::unsetAttr ( const char * explicitAttrName)
overridevirtual

Resets a value for the specified attribute.

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

Reimplemented from OdIfc2x3::IfcCsgPrimitive3D.

◆ unsetAttr() [2/2]

virtual void OdIfc2x3::IfcBlock::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 OdIfc2x3::IfcCsgPrimitive3D.

Member Data Documentation

◆ m_XLength

IfcPositiveLengthMeasure OdIfc2x3::IfcBlock::m_XLength
protected

Definition at line 257 of file Ifc2x3/IfcBlockAutoImpl.h.

◆ m_YLength

IfcPositiveLengthMeasure OdIfc2x3::IfcBlock::m_YLength
protected

Definition at line 258 of file Ifc2x3/IfcBlockAutoImpl.h.

◆ m_ZLength

IfcPositiveLengthMeasure OdIfc2x3::IfcBlock::m_ZLength
protected

Definition at line 259 of file Ifc2x3/IfcBlockAutoImpl.h.


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