OdAveScene Class Reference

#include <AveScene.h>

Inheritance diagram for OdAveScene:

Public Member Functions
	ODRX_DECLARE_MEMBERS (OdAveScene)
OdResult	writeScene (OdDbDatabase *pDb=0)
OdString	name () const
void	setName (const OdString &name)
OdDbObjectId	view () const
void	setView (const OdDbObjectId &viewId)
void	lights (OdDbObjectIdArray &blockRefIds) const
void	setLights (const OdDbObjectIdArray &blockRefIds)
void	addLight (const OdDbObjectId &blockRefId)
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 OdAveScenePtr	getScene (const OdDbObjectId &blockRefId)
static void	getSceneName (const OdDbObjectId &blockRefId, OdString &name)
Static Public Member Functions inherited from OdRxObject
static OdRxObjectPtr	cast (const OdRxObject *pointer)
static OdRxClass *	desc ()

Protected Member Functions
	OdAveScene ()
	OdAveScene (OdAveSceneImpl *pImpl)

Protected Attributes
OdAveSceneImpl *	m_pImpl

Detailed Description

This class represents AVE Scene properties.

Remarks

Each AVE Scenes consist of a view and zero or more lights.

Corresponding C++ library: TD_Ave <group OdAve_Classes>

Definition at line 52 of file AveScene.h.

Constructor & Destructor Documentation

OdAveScene() [1/2]

OdAveScene::OdAveScene ( )

protected

OdAveScene() [2/2]

OdAveScene::OdAveScene ( OdAveSceneImpl *  pImpl )

protected

Member Function Documentation

addLight()

void OdAveScene::addLight

(

const OdDbObjectId &

blockRefId

)

Adds the specified light to the array of lights associated with this Scene object.

Parameters

blockRefId

[in] Object ID of the block reference associated with the light.

getScene()

static OdAveScenePtr OdAveScene::getScene ( const OdDbObjectId &  blockRefId )

static

Creates a Scene object from the specified OdDbBlockReference.

Parameters

blockRefId

[in] Object ID of the block reference.

Remarks

The new Scene object is attached to the specified block reference.

Returns a SmartPointer to the new Scene object.

getSceneName()

static void OdAveScene::getSceneName ( const OdDbObjectId &  blockRefId, OdString &  name  )

static

Returns the Scene name from the specified OdDbBlockReference.

Parameters

blockRefId	[in] Object ID of the block reference.
name	[out] Receives the Scene name.

lights()

void OdAveScene::lights

(

OdDbObjectIdArray &

blockRefIds

)

const

Returns the array of lights associated with this Scene object.

Parameters

blockRefIds

[out] Receives the array of object IDs of the block references associated with the lights.

name()

OdString OdAveScene::name

(

)

const

Returns the name of this Scene object.

ODRX_DECLARE_MEMBERS()

OdAveScene::ODRX_DECLARE_MEMBERS

(

OdAveScene

)

setLights()

void OdAveScene::setLights

(

const OdDbObjectIdArray &

blockRefIds

)

Sets the array of lights associated with this Scene object.

Parameters

blockRefIds

[in] Array of the object IDs of the block references associated with the lights.

setName()

void OdAveScene::setName

(

const OdString &

name

)

Sets the name of this Scene object.

Parameters

name	[in] Name.

Remarks

Names are truncated to 8 characters.

setView()

void OdAveScene::setView

(

const OdDbObjectId &

viewId

)

Sets the OdDbViewTableRecord associated with this Scene object.

Parameters

viewId

[in] Object ID of the View Table Record.

view()

OdDbObjectId OdAveScene::view

(

)

const

Returns the OdDbViewTableRecord associated with this Scene object.

writeScene()

OdResult OdAveScene::writeScene

(

OdDbDatabase *

pDb = 0

)

Saves the Scene properties to the OdDbBlockReference to which this Scene object is attached.

Parameters

pDb	[in] Pointer to the database.

Remarks

If pDb is null, the database containing this Light object is used.

Member Data Documentation

m_pImpl

OdAveSceneImpl* OdAveScene::m_pImpl

protected

Definition at line 128 of file AveScene.h.

---

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

• AveScene.h