GeometryLayer Class Reference

#include <Ample.h>

Inheritance diagram for GeometryLayer:

[legend]

Collaboration diagram for GeometryLayer:

[legend]

List of all members.

Public Types
enum	Stack { VERTEX, POLYGON }
typedef Observer < GeometryLayerObserver >	ObserverType
typedef std::vector < GeometryLayerObserver * >	ObserverList
Public Member Functions
void	destroy (void)
VLayerID	getID (void) const
Stack	getStack (void) const
VNRealFormat	getRealFormat (void) const
const std::string &	getName (void) const
void	setName (const std::string &name)
unsigned int	getSlotSize (void) const
VNGLayerType	getType (void) const
bool	getSlot (uint32 slotID, void *data) const
void	setSlot (uint32 slotID, const void *data)
uint32	getDefaultInt (void) const
real64	getDefaultReal (void) const
GeometryNode &	getNode (void) const
unsigned int	getDataVersion (void) const
unsigned int	getStructureVersion (void) const
void	addObserver (GeometryLayerObserver &observer)
void	removeObserver (GeometryLayerObserver &observer)
void	removeObserver (Observer< GeometryLayerObserver > &observer)
const ObserverList &	getObservers (void) const
Friends
class	GeometryNode

---

Detailed Description

Geometry node layer class. Represents a single layer in a geometry node.

---

Member Typedef Documentation

typedef std::vector<GeometryLayerObserver *> ObserverList [inherited]

typedef Observer<GeometryLayerObserver > ObserverType [inherited]

---

Member Enumeration Documentation

enum Stack

Geometry stack enumeration.

Enumerator:

VERTEX	The geometry layer is a member of the vertex stack.
POLYGON	The geometry layer is a member of the polygon stack.

---

Member Function Documentation

void addObserver

(

GeometryLayerObserver &

observer

)

[inline, inherited]

Adds the specified observer to this object.

Parameters:

observer

The observer to add.

Remarks:

An observer can only be added once. Additional additions are ignored.

void destroy

(

void

)

Destroys this geometry layer.

Remarks:

This call is asynchronous. It will not take effect until, at the earliest, after the first subsequent call to Session::update.

unsigned int getDataVersion

(

void

)

const [inherited]

Returns:

The current version of the internal state.

Remarks:

This value is updated for any kind of change.

uint32 getDefaultInt

(

void

)

const

Returns:

the default value for uninitialized integer slots.

real64 getDefaultReal

(

void

)

const

Returns:

the default value for uninitialized real slots.

VLayerID getID

(

void

)

const

Returns:

The ID of this geometry layer.

const std::string& getName

(

void

)

const

Returns:

The name of this geometry layer.

GeometryNode& getNode

(

void

)

const

Returns:

The node containing this geometry layer.

const ObserverList& getObservers

(

void

)

const [inline, inherited]

Returns:

The list of observers attached to this object.

VNRealFormat getRealFormat

(

void

)

const

Returns:

The quality of real value geometry layers.

bool getSlot	(	uint32	slotID,
		void *	data
	)			const

Retrieves the specified slot from this geometry layer.

Parameters:

	slotID	The index of the desired slot.
	data	The location to store the slot data.

Returns:

true if the slot exists, otherwise false.

unsigned int getSlotSize

(

void

)

const

Returns:

The size, in bytes, of a slot in this geometry layer.

Stack getStack

(

void

)

const

Returns:

The stack in which this layer exists.

unsigned int getStructureVersion

(

void

)

const [inherited]

Returns:

The current version of the internal structure.

Remarks:

This value is only updated when the internal structure changes.

VNGLayerType getType

(

void

)

const

Returns:

The type of the slots in this geometry layer.

void removeObserver

(

Observer< GeometryLayerObserver > &

observer

)

[inline, inherited]

Removes the specified observer from this object.

Parameters:

observer

The observer to remove.

void removeObserver

(

GeometryLayerObserver &

observer

)

[inline, inherited]

Removes the specified observer from this object.

Parameters:

observer

The observer to remove.

void setName

(

const std::string &

name

)

Changes the name of this geometry layer.

Parameters:

name

The desired name.

Remarks:

This call is asynchronous. It will not take effect until, at the earliest, after the first subsequent call to Session::update.

void setSlot	(	uint32	slotID,
		const void *	data
	)

Changes the specified slot in this geometry layer.

Parameters:

	slotID	The index of the desired slot.
	data	The location to retrieve the slot data from.

Remarks:

This call is asynchronous. It will not take effect until, at the earliest, after the first subsequent call to Session::update.

---

Friends And Related Function Documentation

friend class GeometryNode [friend]

Reimplemented from Versioned.