OdBcf::OdBcfPerspectiveCamera Class Reference

#include <BcfPerspectiveCamera.h>

Inheritance diagram for OdBcf::OdBcfPerspectiveCamera:

Public Member Functions
	ODRX_DECLARE_MEMBERS (OdBcfPerspectiveCamera)
	OdBcfPerspectiveCamera ()
virtual OdResult	inFields (TiXmlElement *pParent) ODRX_OVERRIDE
virtual OdResult	outFields (TiXmlElement *pParent) const ODRX_OVERRIDE
virtual bool	validate () const ODRX_OVERRIDE
	DECLARE_CONST_ACCESSORS (CameraViewPoint, OdBcfPointPtr, m_pCameraViewPoint)
	DECLARE_CONST_ACCESSORS (CameraDirection, OdBcfDirectionPtr, m_pCameraDirection)
	DECLARE_CONST_ACCESSORS (CameraUpVector, OdBcfDirectionPtr, m_pCameraUpVector)
	DECLARE_CONST_ACCESSORS (FieldOfView, double, m_fieldOfView)
Public Member Functions inherited from OdBcf::OdBcfElement
	ODRX_DECLARE_MEMBERS (OdBcfElement)
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< OdBcfPerspectiveCamera >	createObject (const OdBcfPointPtr &pCameraViewPoint, const OdBcfDirectionPtr &pCameraDirection, const OdBcfDirectionPtr &pCameraUpVector, double fieldOfView)
Static Public Member Functions inherited from OdRxObject
static OdRxObjectPtr	cast (const OdRxObject *pointer)
static OdRxClass *	desc ()

Protected Attributes
OdBcfPointPtr	m_pCameraViewPoint
OdBcfDirectionPtr	m_pCameraDirection
OdBcfDirectionPtr	m_pCameraUpVector
double	m_fieldOfView

Detailed Description

A class that contains PerspectiveCamera data type.

Definition at line 45 of file BcfPerspectiveCamera.h.

Constructor & Destructor Documentation

OdBcfPerspectiveCamera()

OdBcf::OdBcfPerspectiveCamera::OdBcfPerspectiveCamera

(

)

Creates a new object with default parameters.

Member Function Documentation

createObject()

static OdSmartPtr<OdBcfPerspectiveCamera> OdBcf::OdBcfPerspectiveCamera::createObject ( const OdBcfPointPtr &  pCameraViewPoint, const OdBcfDirectionPtr &  pCameraDirection, const OdBcfDirectionPtr &  pCameraUpVector, double  fieldOfView  )

static

Creates a new perspective camera object.

Parameters

pCameraViewPoint	[in] A pointer to camera view point.
pCameraDirection	[in] A pointer to camera direction.
pCameraUpVector	[in] A pointer to camera up vector.
fieldOfView	[in] A value of camera field of view.

Returns

Returns a smart pointer to the created <link OdBcf::OdBcfPerspectiveCamera, OdBcfPerspectiveCamera> instance.

DECLARE_CONST_ACCESSORS() [1/4]

OdBcf::OdBcfPerspectiveCamera::DECLARE_CONST_ACCESSORS	(	CameraDirection	,
		OdBcfDirectionPtr	,
		m_pCameraDirection
	)

DECLARE_CONST_ACCESSORS() [2/4]

OdBcf::OdBcfPerspectiveCamera::DECLARE_CONST_ACCESSORS	(	CameraUpVector	,
		OdBcfDirectionPtr	,
		m_pCameraUpVector
	)

DECLARE_CONST_ACCESSORS() [3/4]

OdBcf::OdBcfPerspectiveCamera::DECLARE_CONST_ACCESSORS	(	CameraViewPoint	,
		OdBcfPointPtr	,
		m_pCameraViewPoint
	)

DECLARE_CONST_ACCESSORS() [4/4]

OdBcf::OdBcfPerspectiveCamera::DECLARE_CONST_ACCESSORS	(	FieldOfView	,
		double	,
		m_fieldOfView
	)

inFields()

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

virtual

Reads XML data into ODA data structures.

Parameters

pParent

[in] A pointer to parent element of the data structure.

Returns

Returns eOk if data was successfully read; otherwise, the method returns an appropriate error.

Implements OdBcf::OdBcfElement.

ODRX_DECLARE_MEMBERS()

OdBcf::OdBcfPerspectiveCamera::ODRX_DECLARE_MEMBERS

(

OdBcfPerspectiveCamera

)

outFields()

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

virtual

Writes data into XML structures.

Parameters

pParent

[in] A pointer to parent element of the data structure.

Returns

Returns eOk if data was successfully written; otherwise, the method returns an appropriate error.

Implements OdBcf::OdBcfElement.

validate()

virtual bool OdBcf::OdBcfPerspectiveCamera::validate ( ) const

virtual

Checks if instance has all required fields initialized.

Returns

Returns true if all required fields are initialized; otherwise the method returns false.

Implements OdBcf::OdBcfElement.

Member Data Documentation

m_fieldOfView

double OdBcf::OdBcfPerspectiveCamera::m_fieldOfView

protected

Definition at line 102 of file BcfPerspectiveCamera.h.

m_pCameraDirection

OdBcfDirectionPtr OdBcf::OdBcfPerspectiveCamera::m_pCameraDirection

protected

Definition at line 100 of file BcfPerspectiveCamera.h.

m_pCameraUpVector

OdBcfDirectionPtr OdBcf::OdBcfPerspectiveCamera::m_pCameraUpVector

protected

Definition at line 101 of file BcfPerspectiveCamera.h.

m_pCameraViewPoint

OdBcfPointPtr OdBcf::OdBcfPerspectiveCamera::m_pCameraViewPoint

protected

Definition at line 99 of file BcfPerspectiveCamera.h.

---

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

• BcfPerspectiveCamera.h