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

#include <IfcGridAxisAutoImpl.h>

Inheritance diagram for OdIfc2x3::IfcGridAxis:
OdIfc2x3::OdIfc2x3Instance OdIfc::OdIfcInstance

Public Member Functions

const OdAnsiString & getAxisTag () const
 
void setAxisTag (const OdAnsiString &AxisTag)
 
const OdDAIObjectId & getAxisCurve () const
 
void setAxisCurve (const OdDAIObjectId &AxisCurve)
 
OdDAI::Boolean getSameSense () const
 
void setSameSense (OdDAI::Boolean SameSense)
 
void getInvPartOfW (OdDAIObjectIds &PartOfW) const
 
void getInvPartOfV (OdDAIObjectIds &PartOfV) const
 
void getInvPartOfU (OdDAIObjectIds &PartOfU) const
 
void getInvHasIntersections (OdDAIObjectIds &HasIntersections) const
 
 IfcGridAxis ()
 
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::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

OdAnsiString m_AxisTag
 
OdDAIObjectId m_AxisCurve
 
OdDAI::Boolean m_SameSense
 
- Protected Attributes inherited from OdIfc::OdIfcInstance
voidm_resPtr
 
IfcOpResult m_resolved
 

Friends

class IfcGrid
 
class IfcVirtualGridIntersection
 

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

This definition represents a grid axis. An individual axis, IfcGridAxis, is defined in the context of a design grid. The axis definition is based on a curve of dimensionality 2. The grid axis is positioned within the XY plane of the position coordinate system defined by the IfcGrid.

The standard geometric representation of IfcGridAxis is defined using a 2D curve entity. Grid axes are normally defined by an offset to another axis. The IfcOffsetCurve2D supports this concept. Each grid axis has a sense specified by the parameterization of the curve. The attribute SameSense indicates whether the sense of the grid axis agrees with the underlying curve or opposes it.

<IMAGE ifcgridaxis-layout1>

As shown on the image above, the grid axis is defined as a 2D curve within the xy plane of the position coordinate system. Any curve can be used to define a grid axis, most common is the use of IfcLine for linear grids and IfcCircle for radial grids.

Definition at line 58 of file Ifc2x3/IfcGridAxisAutoImpl.h.

Constructor & Destructor Documentation

◆ IfcGridAxis()

OdIfc2x3::IfcGridAxis::IfcGridAxis ( )

Default constructor for the IfcGridAxis class.

Member Function Documentation

◆ comparedToEarlyImpl()

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

◆ getAttr() [1/2]

virtual OdRxValue OdIfc2x3::IfcGridAxis::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 OdIfc2x3::IfcGridAxis::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 OdIfc::OdIfcInstance.

◆ getAxisCurve()

const OdDAIObjectId & OdIfc2x3::IfcGridAxis::getAxisCurve ( ) const

Returns the value of AxisCurve attribute. This attribute represents underlying curve which provides the geometry for this grid axis.

Returns
Returns the value of AxisCurve attribute.

◆ getAxisTag()

const OdAnsiString & OdIfc2x3::IfcGridAxis::getAxisTag ( ) const

Returns the value of AxisTag attribute. This attribute represents the tag or name for this grid axis.

Returns
Returns the value of AxisTag attribute.

◆ getInstanceType()

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

◆ getInvHasIntersections()

void OdIfc2x3::IfcGridAxis::getInvHasIntersections ( OdDAIObjectIds & HasIntersections) const

Returns the value of HasIntersections attribute. This attribute represents the reference to a set of IfcVirtualGridIntersection's instances that connect other grid axes to this grid axis.

Parameters
HasIntersections[out] Receives the value of HasIntersections attribute.

◆ getInvPartOfU()

void OdIfc2x3::IfcGridAxis::getInvPartOfU ( OdDAIObjectIds & PartOfU) const

Returns the value of PartOfU attribute. This attribute represents the IfcGridAxis (if provided) is part of the UAxes of IfcGrid.

Parameters
PartOfU[out] Receives the value of PartOfU attribute.

◆ getInvPartOfV()

void OdIfc2x3::IfcGridAxis::getInvPartOfV ( OdDAIObjectIds & PartOfV) const

Returns the value of PartOfV attribute. This attribute represents the IfcGridAxis (if provided) is part of the VAxes of IfcGrid.

Parameters
PartOfV[out] Receives the value of PartOfV attribute.

◆ getInvPartOfW()

void OdIfc2x3::IfcGridAxis::getInvPartOfW ( OdDAIObjectIds & PartOfW) const

Returns the value of PartOfW attribute. This attribute represents the IfcGridAxis (if provided) that is a part of the WAxes of IfcGrid.

Parameters
PartOfW[out] Receives the value of PartOfW attribute.

◆ getSameSense()

OdDAI::Boolean OdIfc2x3::IfcGridAxis::getSameSense ( ) const

Returns the value of SameSense attribute. This attribute indicates whether the original sense of curve is used or whether it is reversed in the context of the grid axis.

Returns
Returns the value of SameSense attribute.

◆ inFields()

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

◆ isKindOf()

virtual bool OdIfc2x3::IfcGridAxis::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 OdIfc::OdIfcInstance.

◆ outFields()

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

◆ putAttr() [1/2]

virtual bool OdIfc2x3::IfcGridAxis::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 OdIfc2x3::IfcGridAxis::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 OdIfc::OdIfcInstance.

◆ setAxisCurve()

void OdIfc2x3::IfcGridAxis::setAxisCurve ( const OdDAIObjectId & AxisCurve)

Sets the value of AxisCurve attribute. This attribute represents underlying curve which provides the geometry for this grid axis.

Parameters
AxisCurve[in] Axis curve to set.

◆ setAxisTag()

void OdIfc2x3::IfcGridAxis::setAxisTag ( const OdAnsiString & AxisTag)

Sets the value of AxisTag attribute. This attribute represents the tag or name for this grid axis.

Parameters
AxisTag[in] AxisTag to set.

◆ setSameSense()

void OdIfc2x3::IfcGridAxis::setSameSense ( OdDAI::Boolean SameSense)

Sets the value of SameSense attribute. This attribute indicates whether the original sense of curve is used or whether it is reversed in the context of the grid axis.

Parameters
SameSense[in] SameSense to set.

◆ testAttr() [1/2]

virtual bool OdIfc2x3::IfcGridAxis::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 OdIfc::OdIfcInstance.

◆ testAttr() [2/2]

virtual bool OdIfc2x3::IfcGridAxis::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 OdIfc::OdIfcInstance.

◆ type()

virtual OdIfc::OdIfcEntityType OdIfc2x3::IfcGridAxis::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 OdIfc::OdIfcInstance.

◆ unsetAttr() [1/2]

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

Resets a value for the specified attribute.

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

Reimplemented from OdIfc::OdIfcInstance.

◆ unsetAttr() [2/2]

virtual void OdIfc2x3::IfcGridAxis::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 OdIfc::OdIfcInstance.

Friends And Related Symbol Documentation

◆ IfcGrid

IfcGrid
friend

Definition at line 280 of file Ifc2x3/IfcGridAxisAutoImpl.h.

◆ IfcVirtualGridIntersection

friend class IfcVirtualGridIntersection
friend

Definition at line 283 of file Ifc2x3/IfcGridAxisAutoImpl.h.

Member Data Documentation

◆ m_AxisCurve

OdDAIObjectId OdIfc2x3::IfcGridAxis::m_AxisCurve
protected

Definition at line 276 of file Ifc2x3/IfcGridAxisAutoImpl.h.

◆ m_AxisTag

OdAnsiString OdIfc2x3::IfcGridAxis::m_AxisTag
protected

Definition at line 275 of file Ifc2x3/IfcGridAxisAutoImpl.h.

◆ m_SameSense

OdDAI::Boolean OdIfc2x3::IfcGridAxis::m_SameSense
protected

Definition at line 277 of file Ifc2x3/IfcGridAxisAutoImpl.h.


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