#include <BcfOrthogonalCamera.h>

Inheritance diagram for OdBcf::OdBcfOrthogonalCamera:

Public Member Functions
	ODRX_DECLARE_MEMBERS (OdBcfOrthogonalCamera)

	OdBcfOrthogonalCamera ()

virtual OdResult	inFields (TiXmlElement *pParent) ODRX_OVERRIDE

virtual OdResult	outFields (TiXmlElement *pParent) const ODRX_OVERRIDE

virtual bool	validate () const ODRX_OVERRIDE

const OdBcfPointPtr &	getCameraViewPoint () const

bool	isCameraViewPointUnset () const

const OdBcfDirectionPtr &	getCameraDirection () const

bool	isCameraDirectionUnset () const

const OdBcfDirectionPtr &	getCameraUpVector () const

bool	isCameraUpVectorUnset () const

const double &	getViewToWorldScale () const

bool	isViewToWorldScaleUnset () 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< OdBcfOrthogonalCamera >	createObject (const OdBcfPointPtr &pCameraViewPoint, const OdBcfDirectionPtr &pCameraDirection, const OdBcfDirectionPtr &pCameraUpVector, double viewToWorldScale)

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_viewToWorldScale

Detailed Description

A class that stores and operates an orthogonal camera data within the BCF format.

Definition at line 53 of file BcfOrthogonalCamera.h.

Constructor & Destructor Documentation

◆ OdBcfOrthogonalCamera()

OdBcf::OdBcfOrthogonalCamera::OdBcfOrthogonalCamera ( )

Creates a new orthogonal camera object with default parameters.

Member Function Documentation

◆ createObject()

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

static

Creates a new orthogonal camera object.

Parameters

pCameraViewPoint	[in] A smart pointer to the object that represents the camera view point.
pCameraDirection	[in] A smart pointer to the object that represents the camera direction.
pCameraUpVector	[in] A smart pointer to the object that represents the camera up vector.
viewToWorldScale	[in] A value of the view to world scale.

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

◆ getCameraDirection()

const OdBcfDirectionPtr & OdBcf::OdBcfOrthogonalCamera::getCameraDirection ( ) const

Retrieves the camera direction.

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

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

◆ getCameraUpVector()

const OdBcfDirectionPtr & OdBcf::OdBcfOrthogonalCamera::getCameraUpVector ( ) const

Retrieves the camera up-vector.

Returns: A smart pointer to the <link OdBcf::OdBcfDirection, OdBcfDirection> object that represents the camera up-vector.

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

◆ getCameraViewPoint()

const OdBcfPointPtr & OdBcf::OdBcfOrthogonalCamera::getCameraViewPoint ( ) const

Retrieves the camera viewpoint.

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

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

◆ getViewToWorldScale()

const double & OdBcf::OdBcfOrthogonalCamera::getViewToWorldScale ( ) const

Retrieves the view-to-world scale of the camera.

Returns: A double value that contains the scale.

Remarks: The scale value returned by the method can't be modified in the calling subroutine.

◆ inFields()

virtual OdResult OdBcf::OdBcfOrthogonalCamera::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.

◆ isCameraDirectionUnset()

bool OdBcf::OdBcfOrthogonalCamera::isCameraDirectionUnset ( ) const

Defines whether the camera direction is not initialized.

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

◆ isCameraUpVectorUnset()

bool OdBcf::OdBcfOrthogonalCamera::isCameraUpVectorUnset ( ) const

Defines whether the camera up-vector is not initialized.

Returns: true if the up-vector object is not initialized; otherwise, the method returns false.

◆ isCameraViewPointUnset()

bool OdBcf::OdBcfOrthogonalCamera::isCameraViewPointUnset ( ) const

Defines whether the camera viewpoint is not initialized.

Returns: true if the camera viewpoint is not initialized; otherwise, the method returns false.

◆ isViewToWorldScaleUnset()

bool OdBcf::OdBcfOrthogonalCamera::isViewToWorldScaleUnset ( ) const

Defines whether the view-to-world scale of the camera is not initialized.

Returns: true if the scale value is not initialized; otherwise, the method returns false.

◆ ODRX_DECLARE_MEMBERS()

OdBcf::OdBcfOrthogonalCamera::ODRX_DECLARE_MEMBERS ( OdBcfOrthogonalCamera )

◆ outFields()

virtual OdResult OdBcf::OdBcfOrthogonalCamera::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::OdBcfOrthogonalCamera::validate ( ) const

virtual

Checks whether the orthogonal camera 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_pCameraDirection

OdBcfDirectionPtr OdBcf::OdBcfOrthogonalCamera::m_pCameraDirection

protected

The camera direction.

Definition at line 162 of file BcfOrthogonalCamera.h.

◆ m_pCameraUpVector

OdBcfDirectionPtr OdBcf::OdBcfOrthogonalCamera::m_pCameraUpVector

protected

The camera up-vector.

Definition at line 164 of file BcfOrthogonalCamera.h.

◆ m_pCameraViewPoint

OdBcfPointPtr OdBcf::OdBcfOrthogonalCamera::m_pCameraViewPoint

protected

The camera view point.

Definition at line 160 of file BcfOrthogonalCamera.h.

◆ m_viewToWorldScale

double OdBcf::OdBcfOrthogonalCamera::m_viewToWorldScale

protected

The view-to-world scale of the camera.

Definition at line 166 of file BcfOrthogonalCamera.h.

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

BcfOrthogonalCamera.h

Public Member Functions

Static Public Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ OdBcfOrthogonalCamera()

Member Function Documentation

◆ createObject()

◆ getCameraDirection()

◆ getCameraUpVector()

◆ getCameraViewPoint()

◆ getViewToWorldScale()

◆ inFields()

◆ isCameraDirectionUnset()

◆ isCameraUpVectorUnset()

◆ isCameraViewPointUnset()

◆ isViewToWorldScaleUnset()

◆ ODRX_DECLARE_MEMBERS()

◆ outFields()

◆ validate()

Member Data Documentation

◆ m_pCameraDirection

◆ m_pCameraUpVector

◆ m_pCameraViewPoint

◆ m_viewToWorldScale