OdBcf::OdBcfClippingPlane Class Reference

#include <BcfClippingPlane.h>

Inheritance diagram for OdBcf::OdBcfClippingPlane:

Public Member Functions
	ODRX_DECLARE_MEMBERS (OdBcfClippingPlane)
virtual OdResult	inFields (TiXmlElement *pParent) ODRX_OVERRIDE
virtual OdResult	outFields (TiXmlElement *pParent) const ODRX_OVERRIDE
virtual bool	validate () const ODRX_OVERRIDE
const OdBcfPointPtr &	getLocation () const
bool	isLocationUnset () const
const OdBcfDirectionPtr &	getDirection () const
bool	isDirectionUnset () 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< OdBcfClippingPlane >	createObject (const OdBcfPointPtr &pLocation, const OdBcfDirectionPtr &pDirection)
Static Public Member Functions inherited from OdRxObject
static OdRxObjectPtr	cast (const OdRxObject *pointer)
static OdRxClass *	desc ()

Protected Attributes
OdBcfPointPtr	m_pLocation
OdBcfDirectionPtr	m_pDirection

Detailed Description

A class that stores and operates the information about a clipping plane.

Definition at line 45 of file BcfClippingPlane.h.

Member Function Documentation

createObject()

static OdSmartPtr< OdBcfClippingPlane > OdBcf::OdBcfClippingPlane::createObject ( const OdBcfPointPtr &  pLocation, const OdBcfDirectionPtr &  pDirection  )

static

Creates a new clipping plane object.

Parameters

pLocation	[in] A pointer to the location that defines the clipping plane.
pDirection	[in] A pointer to the direction that defines the clipping plane.

Returns

A smart pointer to the created <link OdBcf::OdBcfClippingPlane, OdBcfClippingPlane> instance.

getDirection()

const OdBcfDirectionPtr & OdBcf::OdBcfClippingPlane::getDirection

(

)

const

Retrieves the direction of the clipping plane object.

Returns

A smart pointer to the <link OdBcf::OdBcfDirection, OdBcfDirection> object that represents the direction.

Remarks

The direction object returned by the method can't be modified in the calling subroutine.

getLocation()

const OdBcfPointPtr & OdBcf::OdBcfClippingPlane::getLocation

(

)

const

Retrieves the location of the clipping plane object.

Returns

A smart pointer to the <link OdBcf::OdBcfPoint, OdBcfPoint> object that represents the location.

Remarks

The location point returned by the method can't be modified in the calling subroutine.

inFields()

virtual OdResult OdBcf::OdBcfClippingPlane::inFields ( TiXmlElement *  pParent )

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.

isDirectionUnset()

bool OdBcf::OdBcfClippingPlane::isDirectionUnset

(

)

const

Defines whether the clipping plane's direction is not initialized.

Returns

true if the direction is not initialized; otherwise, the method returns false.

isLocationUnset()

bool OdBcf::OdBcfClippingPlane::isLocationUnset

(

)

const

Defines whether the clipping plane's location is not initialized.

Returns

true if the location is not initialized; otherwise, the method returns false.

ODRX_DECLARE_MEMBERS()

OdBcf::OdBcfClippingPlane::ODRX_DECLARE_MEMBERS

(

OdBcfClippingPlane

)

outFields()

virtual OdResult OdBcf::OdBcfClippingPlane::outFields ( TiXmlElement *  pParent ) const

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 bool OdBcf::OdBcfClippingPlane::validate ( ) const

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_pDirection

OdBcfDirectionPtr OdBcf::OdBcfClippingPlane::m_pDirection

protected

Definition at line 115 of file BcfClippingPlane.h.

m_pLocation

OdBcfPointPtr OdBcf::OdBcfClippingPlane::m_pLocation

protected

Definition at line 114 of file BcfClippingPlane.h.

---

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

• BcfClippingPlane.h