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

#include <IfcRightCircularCylinderAutoImpl.h>

Inheritance diagram for OdIfc4::IfcRightCircularCylinder:
OdIfc4::IfcCsgPrimitive3D OdIfc4::IfcGeometricRepresentationItem OdIfc4::IfcRepresentationItem OdIfc4::OdIfc4Instance OdIfc::OdIfcInstance

Public Member Functions

double getHeight () const
 
void setHeight (double Height)
 
double getRadius () const
 
void setRadius (double Radius)
 
 IfcRightCircularCylinder ()
 
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::IfcCsgPrimitive3D
const OdDAIObjectId & getPosition () const
 
void setPosition (const OdDAIObjectId &Position)
 
- 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

IfcPositiveLengthMeasure m_Height
 
IfcPositiveLengthMeasure m_Radius
 
- Protected Attributes inherited from OdIfc4::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 IfcRightCircularCylinder is a Construction Solid Geometry (CSG) 3D primitive.

  • Details - It is a solid with a circular base and top. The cylindrical surface between if formed by points at a fixed distance from the axis of the cylinder. The inherited Position attribute defines the IfcAxisPlacement3D and provides: SELF\IfcCsgPrimitive3D.Position: The location and orientation of the axis system for the primitive. SELF\IfcCsgPrimitive3D.Position.Location: The center of the circular area being the bottom face of the cylinder. SELF\IfcCsgPrimitive3D.Position.Position[3]: The z axis provides the center axis and the height is measured from the origin along the positive direction of the z axis.

The image below illustrates geometric parameters of the cylinder. The cylinder is positioned within its own placement coordinate system. The origin is the center of the bottom circular disk, that lies in the XY plane. The center of the top circular disk is on the positive z axis at [0, 0, Height].

<IMAGE ifcrightcircularcylinder-layout1>

  • Texture Use Definition - On the circular side, textures are aligned facing upright with origin at the back (+Y direction) revolving counter-clockwise. Textures are stretched or repeated to the extent of the circumference according to RepeatS. Textures are stretched or repeated to the extent of the Height according to RepeatT. On the top and bottom faces, textures are aligned facing front-to-back, with the center of the circle aligned to the center of the texture.

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 ifcrightcircularcylinder-texture>

Definition at line 64 of file Ifc4/IfcRightCircularCylinderAutoImpl.h.

Constructor & Destructor Documentation

◆ IfcRightCircularCylinder()

OdIfc4::IfcRightCircularCylinder::IfcRightCircularCylinder ( )

Default constructor for the IfcRightCircularCylinder class.

Member Function Documentation

◆ comparedToEarlyImpl()

virtual bool OdIfc4::IfcRightCircularCylinder::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::IfcCsgPrimitive3D.

◆ getAttr() [1/2]

virtual OdRxValue OdIfc4::IfcRightCircularCylinder::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 OdIfc4::IfcCsgPrimitive3D.

◆ getAttr() [2/2]

virtual OdRxValue OdIfc4::IfcRightCircularCylinder::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::IfcCsgPrimitive3D.

◆ getHeight()

double OdIfc4::IfcRightCircularCylinder::getHeight ( ) const

Returns the value of Height attribute. This attribute represents the distance between the planar circular faces of the cylinder.

Returns
Returns the value of Height attribute.

◆ getInstanceType()

virtual OdDAI::Entity * OdIfc4::IfcRightCircularCylinder::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::IfcCsgPrimitive3D.

◆ getRadius()

double OdIfc4::IfcRightCircularCylinder::getRadius ( ) const

Returns the value of Radius attribute. This attribute represents the radius of the cylinder.

Returns
Returns the value of Radius attribute.

◆ inFields()

virtual OdResult OdIfc4::IfcRightCircularCylinder::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::IfcCsgPrimitive3D.

◆ isKindOf()

virtual bool OdIfc4::IfcRightCircularCylinder::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::IfcCsgPrimitive3D.

◆ outFields()

virtual OdResult OdIfc4::IfcRightCircularCylinder::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::IfcCsgPrimitive3D.

◆ putAttr() [1/2]

virtual bool OdIfc4::IfcRightCircularCylinder::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 OdIfc4::IfcCsgPrimitive3D.

◆ putAttr() [2/2]

virtual bool OdIfc4::IfcRightCircularCylinder::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::IfcCsgPrimitive3D.

◆ setHeight()

void OdIfc4::IfcRightCircularCylinder::setHeight ( double Height)

Sets the value of Height attribute. This attribute represents the distance between the planar circular faces of the cylinder.

Parameters
Height[in] Height to set.

◆ setRadius()

void OdIfc4::IfcRightCircularCylinder::setRadius ( double Radius)

Sets the value of Radius attribute. This attribute represents the radius of the cylinder.

Parameters
Radius[in] Radius to set.

◆ testAttr() [1/2]

virtual bool OdIfc4::IfcRightCircularCylinder::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::IfcCsgPrimitive3D.

◆ testAttr() [2/2]

virtual bool OdIfc4::IfcRightCircularCylinder::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::IfcCsgPrimitive3D.

◆ type()

virtual OdIfc::OdIfcEntityType OdIfc4::IfcRightCircularCylinder::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::IfcCsgPrimitive3D.

◆ unsetAttr() [1/2]

virtual void OdIfc4::IfcRightCircularCylinder::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::IfcCsgPrimitive3D.

◆ unsetAttr() [2/2]

virtual void OdIfc4::IfcRightCircularCylinder::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::IfcCsgPrimitive3D.

Member Data Documentation

◆ m_Height

IfcPositiveLengthMeasure OdIfc4::IfcRightCircularCylinder::m_Height
protected

Definition at line 237 of file Ifc4/IfcRightCircularCylinderAutoImpl.h.

◆ m_Radius

IfcPositiveLengthMeasure OdIfc4::IfcRightCircularCylinder::m_Radius
protected

Definition at line 238 of file Ifc4/IfcRightCircularCylinderAutoImpl.h.


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