OdBcf::OdBcfViewPoint Class Reference

#include <BcfViewpoint.h>

Inheritance diagram for OdBcf::OdBcfViewPoint:

Public Member Functions
	ODRX_DECLARE_MEMBERS (OdBcfViewPoint)
	OdBcfViewPoint ()
virtual OdResult	inFields (TiXmlElement *pParent) ODRX_OVERRIDE
virtual OdResult	outFields (TiXmlElement *pParent) const ODRX_OVERRIDE
virtual bool	validate () const ODRX_OVERRIDE
const OdString &	getViewpoint () const
bool	isViewpointUnset () const
const OdString &	getSnapshot () const
bool	isSnapshotUnset () const
const OdInt32 &	getIndex () const
bool	isIndexUnset () const
const OdGUID &	getGuid () const
bool	isGuidUnset () 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

Protected Member Functions
OdBcfViewPoint &	operator= (const OdBcfViewPointData &val)

Protected Attributes
friend	OdBcfSession
Protected Attributes inherited from OdBcf::OdBcfViewPointData
OdString	m_viewpoint
OdString	m_snapshot
OdInt32	m_index
OdGUID	m_guid
friend	OdBcfSession

Additional Inherited Members
Static Public Member Functions inherited from OdRxObject
static OdRxObjectPtr	cast (const OdRxObject *pointer)
static OdRxClass *	desc ()

Detailed Description

A class that stores and operates a viewpoint data.

Definition at line 71 of file BcfViewpoint.h.

Constructor & Destructor Documentation

OdBcfViewPoint()

OdBcf::OdBcfViewPoint::OdBcfViewPoint

(

)

Creates a new viewpoint object with default parameters.

Member Function Documentation

getGuid()

const OdGUID & OdBcf::OdBcfViewPoint::getGuid

(

)

const

Retrieves the viewport's global unique identifier (GUID).

Returns

An <exref target="https://docs.opendesign.com/tkernel/OdGUID.html">OdGUID</exref> object that contains the viewport GUID.

Remarks

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

getIndex()

const OdInt32 & OdBcf::OdBcfViewPoint::getIndex

(

)

const

Retrieves the viewport index.

Returns

A 32-bit integer value that contains the index value.

Remarks

The index value returned by the method can't be modified in the calling subroutine.

getSnapshot()

const OdString & OdBcf::OdBcfViewPoint::getSnapshot

(

)

const

Retrieves the value of the Snapshot property of the viewport object.

Returns

A string that contains the Snapshot property value.

Remarks

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

getViewpoint()

const OdString & OdBcf::OdBcfViewPoint::getViewpoint

(

)

const

Retrieves the viewpoint of the viewport.

Returns

A string that contains information about the viewpoint.

Remarks

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

inFields()

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

isGuidUnset()

bool OdBcf::OdBcfViewPoint::isGuidUnset

(

)

const

Defines whether the global unique identifier (GUID) of the viewport object is not initialized.

Returns

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

isIndexUnset()

bool OdBcf::OdBcfViewPoint::isIndexUnset

(

)

const

Defines whether the index of the viewport object is not initialized.

Returns

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

isSnapshotUnset()

bool OdBcf::OdBcfViewPoint::isSnapshotUnset

(

)

const

Defines whether the value of the Snapshot property of the viewport object is not initialized.

Returns

true if the Snapshot property value is not initialized; otherwise, the method returns false.

isViewpointUnset()

bool OdBcf::OdBcfViewPoint::isViewpointUnset

(

)

const

Defines whether the information about the viewpoint is not initialized.

Returns

true if the string with the information about the viewpoint is not initialized; otherwise, the method returns false.

ODRX_DECLARE_MEMBERS()

OdBcf::OdBcfViewPoint::ODRX_DECLARE_MEMBERS

(

OdBcfViewPoint

)

operator=()

OdBcfViewPoint & OdBcf::OdBcfViewPoint::operator= ( const OdBcfViewPointData &  val )

protected

outFields()

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

virtual

Checks whether the viewpoint 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

OdBcfSession

friend OdBcf::OdBcfViewPoint::OdBcfSession

protected

Definition at line 165 of file BcfViewpoint.h.

---

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

• BcfViewpoint.h