CFx SDK Documentation 2026 SP0
Loading...
Searching...
No Matches
OdIfc4x4::IfcClothoid Class Reference

#include <IfcClothoidAutoImpl.h>

Inheritance diagram for OdIfc4x4::IfcClothoid:
OdIfc4x4::IfcSpiral OdIfc4x4::IfcCurve OdIfc4x4::IfcGeometricRepresentationItem OdIfc4x4::IfcRepresentationItem OdIfc4x4::OdIFC4X4Instance OdIfc::OdIfcInstance

Public Member Functions

double getClothoidConstant () const
 
void setClothoidConstant (double ClothoidConstant)
 
 IfcClothoid ()
 
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 OdIfc4x4::IfcSpiral
IfcAxis2Placement position ()
 
 IfcSpiral ()
 
- Public Member Functions inherited from OdIfc4x4::IfcRepresentationItem
void getInvLayerAssignment (OdDAIObjectIds &LayerAssignment) const
 
void getInvStyledByItem (OdDAIObjectIds &StyledByItem) const
 
- Public Member Functions inherited from OdIfc4x4::OdIFC4X4Instance
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

double m_ClothoidConstant
 
- Protected Attributes inherited from OdIfc4x4::IfcSpiral
OdDAI::Select 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

A clothoid is a planar curve in the form of a spiral. This curve has the property that the curvature varies linearly with the arc length.

  • Details - Interpretation of the data is the following:
    C = SELF\IfcSpiral.Position.Location  
    x = SELF\IfcSpiral.Position.P[1] 
    y = SELF\IfcSpiral.Position.P[2]   
    A = ClothoidConstant
    
    and the clothoid is parameterized as:

<IMAGE ifcclothoid_parameterisation>

The parametric range is: -∞ < u < ∞. The arc length s of the curve, from the point C, is given by the formula:

<IMAGE ifcclothoid_arclength>

The curvature κ and radius of the curvature ρ, at any point of the curve, are related to the arc length s by the formulae:

<IMAGE ifcclothoid_curvature>

Definition at line 60 of file IFC4X4/IfcClothoidAutoImpl.h.

Constructor & Destructor Documentation

◆ IfcClothoid()

OdIfc4x4::IfcClothoid::IfcClothoid ( )

Default constructor for the IfcClothoid class.

Member Function Documentation

◆ comparedToEarlyImpl()

virtual bool OdIfc4x4::IfcClothoid::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 OdIfc4x4::IfcSpiral.

◆ getAttr() [1/2]

virtual OdRxValue OdIfc4x4::IfcClothoid::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 OdIfc4x4::IfcSpiral.

◆ getAttr() [2/2]

virtual OdRxValue OdIfc4x4::IfcClothoid::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 OdIfc4x4::IfcSpiral.

◆ getClothoidConstant()

double OdIfc4x4::IfcClothoid::getClothoidConstant ( ) const

Returns the value of ClothoidConstant. ClothoidConstant is the constant that defines the relationship between curvature and arc length for the curve.

Returns
Returns the value of ClothoidConstant.

◆ getInstanceType()

virtual OdDAI::Entity * OdIfc4x4::IfcClothoid::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 OdIfc4x4::IfcSpiral.

◆ inFields()

virtual OdResult OdIfc4x4::IfcClothoid::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 OdIfc4x4::IfcSpiral.

◆ isKindOf()

virtual bool OdIfc4x4::IfcClothoid::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 OdIfc4x4::IfcSpiral.

◆ outFields()

virtual OdResult OdIfc4x4::IfcClothoid::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 OdIfc4x4::IfcSpiral.

◆ putAttr() [1/2]

virtual bool OdIfc4x4::IfcClothoid::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 OdIfc4x4::IfcSpiral.

◆ putAttr() [2/2]

virtual bool OdIfc4x4::IfcClothoid::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 OdIfc4x4::IfcSpiral.

◆ setClothoidConstant()

void OdIfc4x4::IfcClothoid::setClothoidConstant ( double ClothoidConstant)

Sets the value of ClothoidConstant. ClothoidConstant is the constant that defines the relationship between curvature and arc length for the curve.

Parameters
ClothoidConstant[in] ClothoidConstant to set.

◆ testAttr() [1/2]

virtual bool OdIfc4x4::IfcClothoid::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 OdIfc4x4::IfcSpiral.

◆ testAttr() [2/2]

virtual bool OdIfc4x4::IfcClothoid::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 OdIfc4x4::IfcSpiral.

◆ type()

virtual OdIfc::OdIfcEntityType OdIfc4x4::IfcClothoid::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 OdIfc4x4::IfcSpiral.

◆ unsetAttr() [1/2]

virtual void OdIfc4x4::IfcClothoid::unsetAttr ( const char * explicitAttrName)
overridevirtual

Resets a value for the specified attribute.

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

Reimplemented from OdIfc4x4::IfcSpiral.

◆ unsetAttr() [2/2]

virtual void OdIfc4x4::IfcClothoid::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 OdIfc4x4::IfcSpiral.

Member Data Documentation

◆ m_ClothoidConstant

double OdIfc4x4::IfcClothoid::m_ClothoidConstant
protected

Definition at line 216 of file IFC4X4/IfcClothoidAutoImpl.h.


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