#include <BcfVisualizationInfo.h>

Inheritance diagram for OdBcf::OdBcfVisualizationInfo:

Public Member Functions
	ODRX_DECLARE_MEMBERS (OdBcfVisualizationInfo)

	OdBcfVisualizationInfo ()

virtual OdResult	inFields (TiXmlElement *pParent) ODRX_OVERRIDE

virtual OdResult	outFields (TiXmlElement *pParent) const ODRX_OVERRIDE

virtual bool	validate () const ODRX_OVERRIDE

const OdBcfComponentsPtr &	getComponents () const

bool	isComponentsUnset () const

const OdBcfOrthogonalCameraPtr &	getOrthogonalCamera () const

bool	isOrthogonalCameraUnset () const

const OdBcfPerspectiveCameraPtr &	getPerspectiveCamera () const

bool	isPerspectiveCameraUnset () const

const OdBcfLinesPtr &	getLines () const

bool	isLinesUnset () const

const OdBcfClippingPlanesPtr &	getClippingPlanes () const

bool	isClippingPlanesUnset () const

const OdBcfBitmapArray &	getBitmap () const

bool	isBitmapUnset () 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
void	setGuid (const OdGUID &guidValue)

OdBcfVisualizationInfo &	operator= (const OdBcfVisualizationInfoData &val)

Friends
class	OdBcfSession

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

static OdRxClass *	desc ()

Protected Attributes inherited from OdBcf::OdBcfVisualizationInfoData
OdGUID	m_guid

OdBcfComponentsPtr	m_pComponents

OdBcfOrthogonalCameraPtr	m_pOrthogonalCamera

OdBcfPerspectiveCameraPtr	m_pPerspectiveCamera

OdBcfLinesPtr	m_pLines

OdBcfClippingPlanesPtr	m_pClippingPlanes

OdBcfBitmapArray	m_bitmap

Detailed Description

A class that stores and operates the visualization information within the BCF format.

Definition at line 109 of file BcfVisualizationInfo.h.

Constructor & Destructor Documentation

◆ OdBcfVisualizationInfo()

OdBcf::OdBcfVisualizationInfo::OdBcfVisualizationInfo ( )

Creates a new visualization information object with default parameters.

Member Function Documentation

◆ getBitmap()

const OdBcfBitmapArray & OdBcf::OdBcfVisualizationInfo::getBitmap ( ) const

Retrieves bitmaps from the visualization information instance.

Returns: An array of smart pointers to <link OdBcf::OdBcfBitmap, OdBcfBitmap> objects.

Remarks: The <link OdBcf::OdBcfBitmap, OdBcfBitmap> objects array returned by the method can't be modified in the calling subroutine.

◆ getClippingPlanes()

const OdBcfClippingPlanesPtr & OdBcf::OdBcfVisualizationInfo::getClippingPlanes ( ) const

Retrieves the clipping planes from the visualization information instance.

Returns: A smart pointer to the <link OdBcf::OdBcfClippingPlanes, OdBcfClippingPlanes> object.

Remarks: The <link OdBcf::OdBcfClippingPlanes, OdBcfClippingPlanes> object returned by the method can't be modified in the calling subroutine.

◆ getComponents()

const OdBcfComponentsPtr & OdBcf::OdBcfVisualizationInfo::getComponents ( ) const

Retrieves the visualization info components.

Returns: A smart pointer to the <link OdBcf::OdBcfComponents, OdBcfComponents> object associated with the visualization info.

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

◆ getGuid()

const OdGUID & OdBcf::OdBcfVisualizationInfo::getGuid ( ) const

Retrieves the global unique identifier (GUID) of the visualization information object.

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

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

◆ getLines()

const OdBcfLinesPtr & OdBcf::OdBcfVisualizationInfo::getLines ( ) const

Retrieves the lines object from the visualization information instance.

Returns: A smart pointer to the <link OdBcf::OdBcfLines, OdBcfLines> object.

Remarks: The <link OdBcf::OdBcfLines, OdBcfLines> object returned by the method can't be modified in the calling subroutine.

◆ getOrthogonalCamera()

const OdBcfOrthogonalCameraPtr & OdBcf::OdBcfVisualizationInfo::getOrthogonalCamera ( ) const

Retrieves the orthogonal camera object from the visualization information instance.

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

Remarks: The <link OdBcf::OdBcfOrthogonalCamera, OdBcfOrthogonalCamera> object returned by the method can't be modified in the calling subroutine.

◆ getPerspectiveCamera()

const OdBcfPerspectiveCameraPtr & OdBcf::OdBcfVisualizationInfo::getPerspectiveCamera ( ) const

Retrieves the perspective camera object from the visualization information instance.

Returns: A smart pointer to the <link OdBcf::OdBcfPerspectiveCamera, OdBcfPerspectiveCamera> object.

Remarks: The <link OdBcf::OdBcfPerspectiveCamera, OdBcfPerspectiveCamera> object returned by the method can't be modified in the calling subroutine.

◆ inFields()

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

◆ isBitmapUnset()

bool OdBcf::OdBcfVisualizationInfo::isBitmapUnset ( ) const

Defines whether the array of bitmap objects within the visualization information is not initialized.

Returns: true if the bitmap objects array is not initialized; otherwise, the method returns false.

◆ isClippingPlanesUnset()

bool OdBcf::OdBcfVisualizationInfo::isClippingPlanesUnset ( ) const

Defines whether the clipping planes object within the visualization information is not initialized.

Returns: true if the clipping planes object is not initialized; otherwise, the method returns false.

◆ isComponentsUnset()

bool OdBcf::OdBcfVisualizationInfo::isComponentsUnset ( ) const

Defines whether the components of the visualization info are not initialized.

Returns: true if the components are not initialized; otherwise, the method returns false.

◆ isGuidUnset()

bool OdBcf::OdBcfVisualizationInfo::isGuidUnset ( ) const

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

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

◆ isLinesUnset()

bool OdBcf::OdBcfVisualizationInfo::isLinesUnset ( ) const

Defines whether the lines object within the visualization information is not initialized.

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

◆ isOrthogonalCameraUnset()

bool OdBcf::OdBcfVisualizationInfo::isOrthogonalCameraUnset ( ) const

Defines whether the orthogonal camera object within the visualization information is not initialized.

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

◆ isPerspectiveCameraUnset()

bool OdBcf::OdBcfVisualizationInfo::isPerspectiveCameraUnset ( ) const

Defines whether the perspective camera object within the visualization information is not initialized.

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

◆ ODRX_DECLARE_MEMBERS()

OdBcf::OdBcfVisualizationInfo::ODRX_DECLARE_MEMBERS ( OdBcfVisualizationInfo )

◆ operator=()

OdBcfVisualizationInfo & OdBcf::OdBcfVisualizationInfo::operator= ( const OdBcfVisualizationInfoData & val )

protected

An assignment operator for the visualizaion info objects.

Parameters

val	[in] Another visualization info object to be assigned (right-hand operand of the assignment operation).

Returns: The reference to the visualization info object modified with the assignment operation.

◆ outFields()

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

◆ setGuid()

void OdBcf::OdBcfVisualizationInfo::setGuid ( const OdGUID & guidValue )

protected

Sets the global unique identifier (GUID) of the visualization info object.

Parameters

guidValue [in] An <exref target="https://docs.opendesign.com/tkernel/OdGUID.html">OdGUID</exref> object that represents the GUID to be set.

◆ validate()

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

virtual

Checks whether the visualization information instance has all required fields initialized.

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

Implements OdBcf::OdBcfElement.

Friends And Related Function Documentation

◆ OdBcfSession

friend class OdBcfSession

friend

Definition at line 256 of file BcfVisualizationInfo.h.

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

BcfVisualizationInfo.h

Public Member Functions

Protected Member Functions

Friends

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ OdBcfVisualizationInfo()

Member Function Documentation

◆ getBitmap()

◆ getClippingPlanes()

◆ getComponents()

◆ getGuid()

◆ getLines()

◆ getOrthogonalCamera()

◆ getPerspectiveCamera()

◆ inFields()

◆ isBitmapUnset()

◆ isClippingPlanesUnset()

◆ isComponentsUnset()

◆ isGuidUnset()

◆ isLinesUnset()

◆ isOrthogonalCameraUnset()

◆ isPerspectiveCameraUnset()

◆ ODRX_DECLARE_MEMBERS()

◆ operator=()

◆ outFields()

◆ setGuid()

◆ validate()

Friends And Related Function Documentation

◆ OdBcfSession