#include <BcfClippingPlanes.h>
Inheritance diagram for OdBcf::OdBcfClippingPlanes:
Public Member Functions | |
| ODRX_DECLARE_MEMBERS (OdBcfClippingPlanes) | |
| virtual OdResult | inFields (TiXmlElement *pParent) ODRX_OVERRIDE |
| virtual OdResult | outFields (TiXmlElement *pParent) const ODRX_OVERRIDE |
| virtual bool | validate () const ODRX_OVERRIDE |
| const OdBcfClippingPlaneArray & | getClippingPlane () const |
| bool | isClippingPlaneUnset () const |
 Public Member Functions inherited from OdBcf::OdBcfElement | |
| ODRX_DECLARE_MEMBERS (OdBcfElement) | |
| virtual OdResult | inFields (TiXmlElement *pParent)=0 |
| virtual OdResult | outFields (TiXmlElement *pParent) const =0 |
| virtual bool | validate () const =0 |
| Public Member Functions inherited from OdRxObject | |
| ODRX_HEAP_OPERATORS () | |
| OdRxObject () | |
| virtual | ~OdRxObject () |
| virtual OdRxObject * | queryX (const OdRxClass *pClass) const |
| virtual OdRxObject * | x (const OdRxClass *pClass) const |
| virtual OdRxClass * | isA () const |
| virtual void | addRef ()=0 |
| virtual void | release ()=0 |
| virtual long | numRefs () const |
| bool | isKindOf (const OdRxClass *pClass) const |
| virtual OdRxObjectPtr | clone () const |
| virtual void | copyFrom (const OdRxObject *pSource) |
| virtual OdRx::Ordering | comparedTo (const OdRxObject *pOther) const |
| virtual bool | isEqualTo (const OdRxObject *pOther) const |
Static Public Member Functions | |
| static OdSmartPtr< OdBcfClippingPlanes > | createObject (const OdBcfClippingPlaneArray &clippingPlane) |
| Static Public Member Functions inherited from OdRxObject | |
| static OdRxObjectPtr | cast (const OdRxObject *pointer) |
| static OdRxClass * | desc () |
Protected Attributes | |
| OdBcfClippingPlaneArray | m_clippingPlane |
Detailed Description
A class that stores and operates the information about clipping planes.
Definition at line 48 of file BcfClippingPlanes.h.
Member Function Documentation
◆ createObject()
|
static |
Creates a new clipping planes object.
- Parameters
-
clippingPlane [in] An array of smart pointers to clipping plane objects.
- Returns
- A smart pointer to the created <link OdBcf::OdBcfClippingPlanes, OdBcfClippingPlanes> instance.
◆ getClippingPlane()
| const OdBcfClippingPlaneArray & OdBcf::OdBcfClippingPlanes::getClippingPlane | ( | ) | const |
Retrieves the array of clipping planes.
- Returns
- An array of smart pointers to <link OdBcf::OdBcfClippingPlane, OdBcfClippingPlane> objects.
- Remarks
- The array returned by the method can't be modified in the calling subroutine.
◆ inFields()
|
virtual |
Reads XML data into ODA data structures.
- Parameters
-
pParent [in] A pointer to the parent element of the data structure.
- Returns
- eOk if data was successfully read; otherwise, the method returns an appropriate error code.
Implements OdBcf::OdBcfElement.
◆ isClippingPlaneUnset()
| bool OdBcf::OdBcfClippingPlanes::isClippingPlaneUnset | ( | ) | const |
Defines whether the array of clipping planes is not initialized.
- Returns
- true if the array of clipping planes is not initialized; otherwise, the method returns false.
◆ ODRX_DECLARE_MEMBERS()
| OdBcf::OdBcfClippingPlanes::ODRX_DECLARE_MEMBERS | ( | OdBcfClippingPlanes | ) |
◆ outFields()
|
virtual |
Writes data into XML structures.
- Parameters
-
pParent [in] A pointer to the parent element of the data structure.
- Returns
- eOk if data was successfully written; otherwise, the method returns an appropriate error code.
Implements OdBcf::OdBcfElement.
◆ validate()
|
virtual |
Checks whether the instance has all required fields initialized.
- Returns
- true if all required fields are initialized; otherwise, the method returns false.
Implements OdBcf::OdBcfElement.
Member Data Documentation
◆ m_clippingPlane
|
protected |
Definition at line 100 of file BcfClippingPlanes.h.
The documentation for this class was generated from the following file: