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

#include <IfcGridPlacementAutoImpl.h>

Inheritance diagram for OdIfc4::IfcGridPlacement:
OdIfc4::IfcObjectPlacement OdIfc4::OdIfc4Instance OdIfc::OdIfcInstance

Public Member Functions

const OdDAIObjectId & getPlacementLocation () const
 
void setPlacementLocation (const OdDAIObjectId &PlacementLocation)
 
IfcGridPlacementDirectionSelect placementRefDirection ()
 
 IfcGridPlacement ()
 
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 OdIfc4::IfcObjectPlacement
void getInvPlacesObject (OdDAIObjectIds &PlacesObject) const
 
void getInvReferencedByPlacements (OdDAIObjectIds &ReferencedByPlacements) 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_PlacementLocation
 
OdDAI::Select m_PlacementRefDirection
 
- 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

IfcGridPlacement provides a specialization of IfcObjectPlacement in which the placement and axis direction of the object coordinate system is defined by a reference to the design grid.

The location of the object coordinate system is specified by the attribute PlacementLocation. It is defined as an IfcVirtualGridIntersection, that is, an intersection between two grid axes with optional offsets. The axis direction of the x-axis of the object coordinate system is specified either: PlacementRefDirection = NIL: by the tangent of the first grid axis (PlacementLocation.IntersectingAxes[1]) at the virtual intersection (maybe using the offset curve, if PlacementLocation.OffsetDistances is specified); PlacementRefDirection = IfcDirection: by the explicitly provided direction information; PlacementRefDirection = IfcVirtualGridIntersection: by the tangent between the virtual grid intersection of PlacementLocation and the virtual grid intersection of PlacementRefDirection. Offsets as potentially provided in the IfcVirtualGridIntersection's of PlacementLocation and PlacementRefDirection have to be taken into account.

The direction of the y-axis of the IfcGridPlacement is the orthogonal complement to the x-axis. The plane defined by the x and y axis are co-planar to the xy plane of the local placement of the IfcGrid. The direction of the z-axis is the orientation of the cross product of the x-axis and the y-axis, i.e. the z-axis of the IfcGridPlacement is co-linear to the z-axis of the local placement of the IfcGrid.

The image below illustrates the case where PlacementRefDirection is not specified - the object coordinate system is defined by: Its location: specified by the virtual grid intersection of PlacementLocation Its x-axis direction: specified by the tangent of the first intersecting axis in the offset location of the virtual grid intersection

<IMAGE ifcgridplacement-layout1>

The image below illustrates the case where PlacementRefDirection is specified as an IfcDirection - the object coordinate system is defined by: Its location: specified by the virtual grid intersection of PlacementLocation Its x-axis direction: specified by the DirectionRatios of the IfcDirection, only the ratios for x and y are taken into account

<IMAGE ifcgridplacement-layout3>

The image below illustrates the case where PlacementRefDirection is specified as an IfcVirtualGridIntersection - the object coordinate system is defined by: Its location: specified by the virtual grid intersection of PlacementLocation Its x-axis direction: specified by the tangent of the line between the virtual grid intersection of the PlacementLocation and the virtual grid intersection of the PlacementRefDirection.

<IMAGE ifcgridplacement-layout2>

\changes

IFC4 changes: Type of the PlacementRefDirection attribute changed from "IfcVirtualGridIntersection" to "IfcGridPlacementDirectionSelect"

Definition at line 80 of file Ifc4/IfcGridPlacementAutoImpl.h.

Constructor & Destructor Documentation

◆ IfcGridPlacement()

OdIfc4::IfcGridPlacement::IfcGridPlacement ( )

Default constructor for the IfcGridPlacement class.

Member Function Documentation

◆ comparedToEarlyImpl()

virtual bool OdIfc4::IfcGridPlacement::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::IfcObjectPlacement.

◆ getAttr() [1/2]

virtual OdRxValue OdIfc4::IfcGridPlacement::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::IfcGridPlacement::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::IfcObjectPlacement.

◆ getInstanceType()

virtual OdDAI::Entity * OdIfc4::IfcGridPlacement::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::IfcObjectPlacement.

◆ getPlacementLocation()

const OdDAIObjectId & OdIfc4::IfcGridPlacement::getPlacementLocation ( ) const

Returns the value of PlacementLocation attribute. This attribute represents placement of the object coordinate system defined by the intersection of two grid axes.

Returns
Returns the value of PlacementLocation attribute.

◆ inFields()

virtual OdResult OdIfc4::IfcGridPlacement::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::IfcObjectPlacement.

◆ isKindOf()

virtual bool OdIfc4::IfcGridPlacement::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::IfcObjectPlacement.

◆ outFields()

virtual OdResult OdIfc4::IfcGridPlacement::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::IfcObjectPlacement.

◆ placementRefDirection()

IfcGridPlacementDirectionSelect OdIfc4::IfcGridPlacement::placementRefDirection ( )

Returns the value of PlacementRefDirection attribute. This attribute represents reference to either an explicit direction, or a second grid axis intersection, which defines the orientation of the grid placement.

Returns
Returns the value of PlacementRefDirection attribute.

◆ putAttr() [1/2]

virtual bool OdIfc4::IfcGridPlacement::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::IfcGridPlacement::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::IfcObjectPlacement.

◆ setPlacementLocation()

void OdIfc4::IfcGridPlacement::setPlacementLocation ( const OdDAIObjectId & PlacementLocation)

Sets the value of PlacementLocation attribute. This attribute represents placement of the object coordinate system defined by the intersection of two grid axes.

Parameters
PlacementLocation[in] Placement location to set.

◆ testAttr() [1/2]

virtual bool OdIfc4::IfcGridPlacement::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::IfcObjectPlacement.

◆ testAttr() [2/2]

virtual bool OdIfc4::IfcGridPlacement::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::IfcObjectPlacement.

◆ type()

virtual OdIfc::OdIfcEntityType OdIfc4::IfcGridPlacement::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::IfcObjectPlacement.

◆ unsetAttr() [1/2]

virtual void OdIfc4::IfcGridPlacement::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::IfcObjectPlacement.

◆ unsetAttr() [2/2]

virtual void OdIfc4::IfcGridPlacement::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::IfcObjectPlacement.

Member Data Documentation

◆ m_PlacementLocation

OdDAIObjectId OdIfc4::IfcGridPlacement::m_PlacementLocation
protected

Definition at line 247 of file Ifc4/IfcGridPlacementAutoImpl.h.

◆ m_PlacementRefDirection

OdDAI::Select OdIfc4::IfcGridPlacement::m_PlacementRefDirection
protected

Definition at line 248 of file Ifc4/IfcGridPlacementAutoImpl.h.


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