#include <BcfBitmap.h>

Inheritance diagram for OdBcf::OdBcfBitmap:

Public Member Functions
	ODRX_DECLARE_MEMBERS (OdBcfBitmap)

	OdBcfBitmap ()

virtual OdResult	inFields (TiXmlElement *pParent) ODRX_OVERRIDE

virtual OdResult	outFields (TiXmlElement *pParent) const ODRX_OVERRIDE

virtual bool	validate () const ODRX_OVERRIDE

const OdString &	getBitmap () const

bool	isBitmapUnset () const

const OdString &	getReference () const

bool	isReferenceUnset () const

const OdBcfPointPtr &	getLocation () const

bool	isLocationUnset () const

const OdBcfDirectionPtr &	getNormal () const

bool	isNormalUnset () const

const OdBcfDirectionPtr &	getUp () const

bool	isUpUnset () const

const double &	getHeight () const

bool	isHeightUnset () 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)

OdBcfBitmap &	operator= (const OdBcfBitmapData &val)

Protected Attributes
friend	OdBcfSession

Protected Attributes inherited from OdBcf::OdBcfBitmapData
OdString	m_bitmap

OdString	m_reference

OdBcfPointPtr	m_pLocation

OdBcfDirectionPtr	m_pNormal

OdBcfDirectionPtr	m_pUp

double	m_height

OdGUID	m_guid

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

static OdRxClass *	desc ()

Detailed Description

A class that implements storing and operating with a bitmap data type.

Definition at line 70 of file BcfBitmap.h.

Constructor & Destructor Documentation

◆ OdBcfBitmap()

OdBcf::OdBcfBitmap::OdBcfBitmap ( )

Creates a new bitmap object with default parameters.

Member Function Documentation

◆ getBitmap()

const OdString & OdBcf::OdBcfBitmap::getBitmap ( ) const

Retrieves the bitmap data.

Returns: A string that contains the bitmap data.

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

◆ getGuid()

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

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

Returns: An <exref target="https://docs.opendesign.com/tkernel/OdGUID.html">OdGUID</exref> object that contains the bitmap's GUID value.

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

◆ getHeight()

const double & OdBcf::OdBcfBitmap::getHeight ( ) const

Retrieves the bitmap's height.

Returns: A double value that contains the bitmap's height.

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

◆ getLocation()

const OdBcfPointPtr & OdBcf::OdBcfBitmap::getLocation ( ) const

Retrieves the bitmap's location.

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.

◆ getNormal()

const OdBcfDirectionPtr & OdBcf::OdBcfBitmap::getNormal ( ) const

Retrieves the bitmap's normal vector.

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

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

◆ getReference()

const OdString & OdBcf::OdBcfBitmap::getReference ( ) const

Retrieves the bitmap's reference.

Returns: A string that contains the bitmap's reference.

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

◆ getUp()

const OdBcfDirectionPtr & OdBcf::OdBcfBitmap::getUp ( ) const

Retrieves the bitmap's up-vector.

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

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

◆ inFields()

virtual OdResult OdBcf::OdBcfBitmap::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::OdBcfBitmap::isBitmapUnset ( ) const

Defines whether the bitmap object is not initialized.

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

◆ isGuidUnset()

bool OdBcf::OdBcfBitmap::isGuidUnset ( ) const

Defines whether the bitmap's global unique identifier (GUID) is not initialized.

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

◆ isHeightUnset()

bool OdBcf::OdBcfBitmap::isHeightUnset ( ) const

Defines whether the bitmap's height is not initialized.

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

◆ isLocationUnset()

bool OdBcf::OdBcfBitmap::isLocationUnset ( ) const

Defines whether the bitmap's location is not initialized.

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

◆ isNormalUnset()

bool OdBcf::OdBcfBitmap::isNormalUnset ( ) const

Defines whether the bitmap's normal vector is not initialized.

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

◆ isReferenceUnset()

bool OdBcf::OdBcfBitmap::isReferenceUnset ( ) const

Defines whether the bitmap's reference is not initialized.

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

◆ isUpUnset()

bool OdBcf::OdBcfBitmap::isUpUnset ( ) const

Defines whether the bitmap's up-vector is not initialized.

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

◆ ODRX_DECLARE_MEMBERS()

OdBcf::OdBcfBitmap::ODRX_DECLARE_MEMBERS ( OdBcfBitmap )

◆ operator=()

OdBcfBitmap & OdBcf::OdBcfBitmap::operator= ( const OdBcfBitmapData & val )

protected

An assignment operator for BCF bitmap objects.

Parameters

val	[in] Another bitmap object (right-hand operand of the assignment operation).

Returns: The BCF bitmap object after assignment operation is done.

◆ outFields()

virtual OdResult OdBcf::OdBcfBitmap::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::OdBcfBitmap::setGuid ( const OdGUID & guidValue )

protected

Sets a new Guid value.

Parameters

guidValue [in] A new value to set.

◆ validate()

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

virtual

Checks whether the bitmap 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::OdBcfBitmap::OdBcfSession

protected

Definition at line 217 of file BcfBitmap.h.

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

BcfBitmap.h

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ OdBcfBitmap()

Member Function Documentation

◆ getBitmap()

◆ getGuid()

◆ getHeight()

◆ getLocation()

◆ getNormal()

◆ getReference()

◆ getUp()

◆ inFields()

◆ isBitmapUnset()

◆ isGuidUnset()

◆ isHeightUnset()

◆ isLocationUnset()

◆ isNormalUnset()

◆ isReferenceUnset()

◆ isUpUnset()

◆ ODRX_DECLARE_MEMBERS()

◆ operator=()

◆ outFields()

◆ setGuid()

◆ validate()

Member Data Documentation

◆ OdBcfSession