OdPdfPublish::OdView Class Reference

#include <PdfPublishView.h>

Inheritance diagram for OdPdfPublish::OdView:

Public Member Functions
	ODRX_DECLARE_MEMBERS (OdView)
	ODRX_HEAP_OPERATORS ()
	OdView ()
virtual	~OdView ()
void	setInternalName (const OdString &name)
void	setExternalName (const OdString &name)
void	setCamera (const OdCameraPtr &camera)
void	setBackgroundColor (ODCOLORREF color)
void	setDefault (bool state)
void	setLighting (Lighting::Mode mode)
void	setRendering (Rendering::Mode mode)
void	getInternalName (OdString &name) const
void	getExternalName (OdString &name) const
void	getCamera (OdCameraPtr &camera) const
void	getDefault (bool &state) const
void	getBackgroundColor (ODCOLORREF &color) const
void	getLighting (Lighting::Mode &mode) const
void	getRendering (Rendering::Mode &mode) const
Public Member Functions inherited from OdPdfPublish::OdObject
	ODRX_DECLARE_MEMBERS (OdObject)
	ODRX_HEAP_OPERATORS ()
virtual	~OdObject ()
virtual bool	isEmpty () const
virtual bool	isValid () const
virtual void	clear ()
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

Additional Inherited Members
Static Public Member Functions inherited from OdRxObject
static OdRxObjectPtr	cast (const OdRxObject *pointer)
static OdRxClass *	desc ()
Protected Member Functions inherited from OdPdfPublish::OdObject
	OdObject (OdPublishObjectImpl *pImpl)

Detailed Description

This class implements a view entity for .pdf documents created with Teigha Publish.

Definition at line 45 of file PdfPublishView.h.

Constructor & Destructor Documentation

OdView()

OdPdfPublish::OdView::OdView

(

)

Creates a view object.

~OdView()

virtual OdPdfPublish::OdView::~OdView ( )

virtual

Destroys a view object.

Member Function Documentation

getBackgroundColor()

void OdPdfPublish::OdView::getBackgroundColor

(

ODCOLORREF &

color

)

const

Returns current view background color. The method fills a passed ODCOLORREF value and returns it to a calling subroutine.

Parameters

color

[out] A placeholder for the background color value.

getCamera()

void OdPdfPublish::OdView::getCamera

(

OdCameraPtr &

camera

)

const

Returns current view camera. The method fills a passed smart pointer to a camera object and returns it to a calling subroutine.

Parameters

camera

[out] A placeholder for the smart pointer to the camera object.

getDefault()

void OdPdfPublish::OdView::getDefault

(

bool &

state

)

const

Returns the current default flag value. The method fills a passed boolean value and returns it to a calling subroutine.

Parameters

state

[out] A placeholder for the default flag value.

Remarks

If the flag value is equal to true, the view is the default, otherwise it is not.

getExternalName()

void OdPdfPublish::OdView::getExternalName

(

OdString &

name

)

const

Returns current external name of the view. The method fills a passed string object and returns it to a calling subroutine.

Parameters

name	[out] A placeholder for the name value.

getInternalName()

void OdPdfPublish::OdView::getInternalName

(

OdString &

name

)

const

Returns current internal name of the view. The method fills a passed string object and returns it to a calling subroutine.

Parameters

name	[out] A placeholder for the name value.

getLighting()

void OdPdfPublish::OdView::getLighting

(

Lighting::Mode &

mode

)

const

Returns current view lighting mode. The method fills a passed lighting mode value and returns it to a calling subroutine.

Parameters

mode	[out] A placeholder for the lighting mode value.

See also

<link OdPdfPublish::Lighting::Mode, Lighting::Mode enumeration>.

getRendering()

void OdPdfPublish::OdView::getRendering

(

Rendering::Mode &

mode

)

const

Returns current view rendering mode. The method fills a passed rendering mode value and returns it to a calling subroutine.

Parameters

mode	[out] A placeholder for the rendering mode value.

See also

<link OdPdfPublish::Rendering::Mode, Rendering::Mode enumeration>.

ODRX_DECLARE_MEMBERS()

OdPdfPublish::OdView::ODRX_DECLARE_MEMBERS

(

OdView

)

ODRX_HEAP_OPERATORS()

OdPdfPublish::OdView::ODRX_HEAP_OPERATORS

(

)

setBackgroundColor()

void OdPdfPublish::OdView::setBackgroundColor

(

ODCOLORREF

color

)

Sets the view background color.

Parameters

color

[in] A background color value.

setCamera()

void OdPdfPublish::OdView::setCamera

(

const OdCameraPtr &

camera

)

Sets the view camera.

Parameters

camera

[in] A smart pointer to the camera object.

setDefault()

void OdPdfPublish::OdView::setDefault

(

bool

state

)

Sets a flag that determines whether the view is the default. If the flag value is equal to true, the view is the default, otherwise it is not.

Parameters

state

[in] A new default flag value.

setExternalName()

void OdPdfPublish::OdView::setExternalName

(

const OdString &

name

)

Sets an external name of the view.

Parameters

name	[in] A new name value.

setInternalName()

void OdPdfPublish::OdView::setInternalName

(

const OdString &

name

)

Sets an internal name of the view.

Parameters

name	[in] A new name value.

setLighting()

void OdPdfPublish::OdView::setLighting

(

Lighting::Mode

mode

)

Sets the view lighting mode.

Parameters

mode	[in] A new lighting mode value.

See also

<link OdPdfPublish::Lighting::Mode, Lighting::Mode enumeration>.

setRendering()

void OdPdfPublish::OdView::setRendering

(

Rendering::Mode

mode

)

Sets the view rendering mode.

Parameters

mode	[in] A new rendering mode value.

See also

<link OdPdfPublish::Rendering::Mode, Rendering::Mode enumeration>.

---

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

• PdfPublishView.h