#include <IfcRectangularPyramidAutoImpl.h>

Inheritance diagram for OdIfc2x3::IfcRectangularPyramid:

Public Member Functions
double	getXLength () const

void	setXLength (double XLength)

double	getYLength () const

void	setYLength (double YLength)

double	getHeight () const

void	setHeight (double Height)

	IfcRectangularPyramid ()

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 OdGsCache *	gsNode () 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_Height

Protected Attributes inherited from OdIfc2x3::IfcCsgPrimitive3D
OdDAIObjectId	m_Position

Protected Attributes inherited from OdIfc::OdIfcInstance
void *	m_resPtr

IfcOpResult	m_resolved

Additional Inherited Members
Static Public Member Functions inherited from OdIfc::OdIfcInstance
static const OdGePoint3d *	asPoint3d (const OdIfcInstance *inst)

static const OdGePoint2d *	asPoint2d (const OdIfcInstance *inst)

static const OdGeVector3d *	asVector3d (const OdIfcInstance *inst)

static const OdGeVector2d *	asVector2d (const OdIfcInstance *inst)

static const OdGeMatrix2d *	asMatrix2d (const OdIfcInstance *inst)

static const OdGeMatrix3d *	asMatrix3d (const OdIfcInstance *inst)

static OdIfcCompoundPtr	asCompound (OdSmartPtr< OdIfcInstance > inst)

static const OdCmEntityColor *	asRgbColor (const OdIfcInstance *inst)

Detailed Description

The IfcRectangularPyramid is a Construction Solid Geometry (CSG) 3D primitive. It is a solid with a rectangular base and a point called apex as the top. The tapers from the base to the top. The axis from the center of the base to the apex is perpendicular to the base. The inherited Position attribute defines the IfcAxisPlacement3D and provides the location and orientation of the pyramid: 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 cone. SELF\IfcCsgPrimitive3D.Position.Position[3]: The z-axis of the inherited placement coordinate system provides the center axis of the IfcRightCircularCone, and the apex is at the Height value applied to the positive direction of the z-axis. The BottomRadius defines the circular base at the xy-plane of the placement coordinate system.

Example - As shown on the image below, the pyramid is positioned within its own placement coordinate system. The origin is the center of the bottom rectangle, that lies in the XY plane. The apex lies on the positive z axis at [0, 0, Height].

Texture Use Definition - On each triangular side face, textures are aligned facing upright. Textures are stretched or repeated to the extent of the base of each face according to RepeatS. Textures are stretched or repeated towards the top point according to Repeat T, where the top point has coordinates of (0.5,1.0) if RepeatT is False. On the bottom face, textures are aligned facing front-to-back.

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.

Definition at line 66 of file Ifc2x3/IfcRectangularPyramidAutoImpl.h.

Constructor & Destructor Documentation

◆ IfcRectangularPyramid()

OdIfc2x3::IfcRectangularPyramid::IfcRectangularPyramid ( )

Default constructor for the IfcRectangularPyramid class.

Member Function Documentation

◆ comparedToEarlyImpl()

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

◆ getHeight()

double OdIfc2x3::IfcRectangularPyramid::getHeight ( ) const

Returns the value of Height attribute. This attribute represents the height of the apex above the plane of the base, measured in the direction of the placement Z axis, the SELF\IfcCsgPrimitive3D.Position.P[2].

Returns: Returns the value of Height attribute.

◆ getInstanceType()

virtual OdDAI::Entity * OdIfc2x3::IfcRectangularPyramid::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::IfcRectangularPyramid::getXLength ( ) const

Returns the value of XLength attribute. This attribute represents the length of the base measured 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::IfcRectangularPyramid::getYLength ( ) const

Returns the value of YLength attribute. This attribute represents the length of the base measured 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.

◆ inFields()

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

◆ setHeight()

void OdIfc2x3::IfcRectangularPyramid::setHeight ( double Height )

Sets the value of Height attribute. This attribute represents the height of the apex above the plane of the base, measured in the direction of the placement Z axis, the SELF\IfcCsgPrimitive3D.Position.P[2].

Parameters

Height [in] Height to set.

◆ setXLength()

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

Sets the value of XLength attribute. This attribute represents the length of the base measured 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::IfcRectangularPyramid::setYLength ( double YLength )

Sets the value of YLength attribute. This attribute represents the length of the base measured 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.

◆ testAttr() [1/2]

virtual bool OdIfc2x3::IfcRectangularPyramid::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::IfcRectangularPyramid::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::IfcRectangularPyramid::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::IfcRectangularPyramid::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::IfcRectangularPyramid::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_Height

IfcPositiveLengthMeasure OdIfc2x3::IfcRectangularPyramid::m_Height

protected

Definition at line 262 of file Ifc2x3/IfcRectangularPyramidAutoImpl.h.

◆ m_XLength

IfcPositiveLengthMeasure OdIfc2x3::IfcRectangularPyramid::m_XLength

protected

Definition at line 260 of file Ifc2x3/IfcRectangularPyramidAutoImpl.h.

◆ m_YLength

IfcPositiveLengthMeasure OdIfc2x3::IfcRectangularPyramid::m_YLength

protected

Definition at line 261 of file Ifc2x3/IfcRectangularPyramidAutoImpl.h.

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

Ifc2x3/IfcRectangularPyramidAutoImpl.h

Public Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ IfcRectangularPyramid()

Member Function Documentation

◆ comparedToEarlyImpl()

◆ getAttr() [1/2]

◆ getAttr() [2/2]

◆ getHeight()

◆ getInstanceType()

◆ getXLength()

◆ getYLength()

◆ inFields()

◆ isKindOf()

◆ outFields()

◆ putAttr() [1/2]

◆ putAttr() [2/2]

◆ setHeight()

◆ setXLength()

◆ setYLength()

◆ testAttr() [1/2]

◆ testAttr() [2/2]

◆ type()

◆ unsetAttr() [1/2]

◆ unsetAttr() [2/2]

Member Data Documentation

◆ m_Height

◆ m_XLength

◆ m_YLength