CFx SDK Documentation  2023 SP0
Public Member Functions | Public Attributes | List of all members
OdIfc::OdIfcArr2d3d Class Reference

#include <IfcArr2d3d.h>

Public Member Functions

 OdIfcArr2d3d ()
 
 operator double * ()
 
 operator const double * () const
 
void clear ()
 
int size () const
 
bool empty () const
 
OdGePoint2dcreatePoint2d ()
 
OdGePoint3dcreatePoint3d ()
 
OdGeVector2dcreateVector2d ()
 
OdGeVector3dcreateVector3d ()
 
bool initFromOdArray (const OdRxValue &val)
 

Public Attributes

double m_Coordinates [3]
 

Detailed Description

A class that stores an array of two- and three-dimensional geometric coordinates.

Definition at line 42 of file IfcArr2d3d.h.

Constructor & Destructor Documentation

◆ OdIfcArr2d3d()

OdIfc::OdIfcArr2d3d::OdIfcArr2d3d ( )

Creates a new array of coordinates with default values.

Member Function Documentation

◆ clear()

void OdIfc::OdIfcArr2d3d::clear ( )

Clears coordinates. After clearing, coordinate values become equal to an <link OdDAI::Consts::OdNan, OdNan> constant.

◆ createPoint2d()

OdGePoint2d* OdIfc::OdIfcArr2d3d::createPoint2d ( )

Creates a new two-dimensional point object from the coordinate array.

Returns
Returns a raw pointer to the created <exref target="https://docs.opendesign.com/tkernel/OdGePoint2d.html">OdGePoint2d</exref> object.

◆ createPoint3d()

OdGePoint3d* OdIfc::OdIfcArr2d3d::createPoint3d ( )

Creates a new three-dimensional point object from the coordinate array.

Returns
Returns a raw pointer to the created <exref target="https://docs.opendesign.com/tkernel/OdGePoint3d.html">OdGePoint3d</exref> object.

◆ createVector2d()

OdGeVector2d* OdIfc::OdIfcArr2d3d::createVector2d ( )

Creates a new two-dimensional vector object from the coordinate array.

Returns
Returns a raw pointer to the created <exref target="https://docs.opendesign.com/tkernel/OdGeVector2d.html">OdGeVector2d</exref> object.

◆ createVector3d()

OdGeVector3d* OdIfc::OdIfcArr2d3d::createVector3d ( )

Creates a new three-dimensional vector object from the coordinate array.

Returns
Returns a raw pointer to the created <exref target="https://docs.opendesign.com/tkernel/OdGeVector3d.html">OdGeVector3d</exref> object.

◆ empty()

bool OdIfc::OdIfcArr2d3d::empty ( ) const

Retrieves whether the coordinate array is empty or not.

Returns
Returns true if the coordinate array is empty; otherwise, the method returns false.

◆ initFromOdArray()

bool OdIfc::OdIfcArr2d3d::initFromOdArray ( const OdRxValue val)

Initializes the coordinate array from an <exref target="https://docs.opendesign.com/tkernel/OdArray.html">OdArray</exref> object that is contained in an OdRxValue.

Parameters
val[in] An OdRxValue object that contains the array of doubles inside.
Returns
Returns true if the operation succeeds; otherwise returns false.

◆ operator const double *()

OdIfc::OdIfcArr2d3d::operator const double * ( ) const
inline

An operator that returns a raw pointer to the const coordinates array.

Definition at line 63 of file IfcArr2d3d.h.

◆ operator double *()

OdIfc::OdIfcArr2d3d::operator double * ( )
inline

An operator that returns a raw pointer to the coordinates array.

Definition at line 58 of file IfcArr2d3d.h.

◆ size()

int OdIfc::OdIfcArr2d3d::size ( ) const

Retrieves the current size of the coordinate array.

Returns
Returns the current size of the array (2 for 2D objects, 3 for 3D objects).

Member Data Documentation

◆ m_Coordinates

double OdIfc::OdIfcArr2d3d::m_Coordinates[3]

Definition at line 46 of file IfcArr2d3d.h.


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