mudbox::Layer Class Reference

#include <layer.h>

Inheritance diagram for mudbox::Layer:

Detailed Description

This is the base class for anything which is an element of a list with a fixed order and a transparency value assigned to each element.

Examples of derived classes are Mudbox's sculpt layers, paint layers, and viewport filters.


Public Member Functions
virtual const mudbox::ClassDesc *	RuntimeClass (void) const
virtual float	Transparency (void) const
	Returns the current transparency of the layer. 0 is fully transparent, 1 is opaque.
virtual void	SetTransparency (float fTransparency)
	Sets the transparency of the layer.
virtual Layer *	Children (void) const
	Returns a pointer to first child of this item, or NULL if this item has no children.
virtual Layer *	Next (void) const
	Returns a pointer to the next item with the same parent as this one.
virtual Layer *	Prev (void) const
	Returns a pointer to the previous item with the same parent as this one.
virtual class LayerContainer *	Container (void) const
	Returns a pointer to the object containing this layer.
Static Public Member Functions
const mudbox::ClassDesc *	StaticClass (void)
mudbox::Node *	CreateInstances (unsigned int iCount=1)

virtual const mudbox::ClassDesc* mudbox::Layer::RuntimeClass ( void ) const [inline, virtual]

Reimplemented from mudbox::TreeNode.

00027 :

const mudbox::ClassDesc* mudbox::Layer::StaticClass ( void ) [static]

Reimplemented from mudbox::TreeNode.

mudbox::Node* mudbox::Layer::CreateInstances ( unsigned int iCount = 1 ) [static]

Reimplemented from mudbox::TreeNode.

virtual float mudbox::Layer::Transparency ( void ) const [virtual]

Returns the current transparency of the layer. 0 is fully transparent, 1 is opaque.

virtual void mudbox::Layer::SetTransparency ( float fTransparency ) [virtual]

Sets the transparency of the layer.

Parameters:

fTransparency

[in] Transparency value, between 0 and 1. 0 is fully transparent, 1 is opaque.

virtual Layer* mudbox::Layer::Children ( void ) const [virtual]

Returns a pointer to first child of this item, or NULL if this item has no children.

virtual Layer* mudbox::Layer::Next ( void ) const [virtual]

Returns a pointer to the next item with the same parent as this one.

Reimplemented from mudbox::Node.

virtual Layer* mudbox::Layer::Prev ( void ) const [virtual]

Returns a pointer to the previous item with the same parent as this one.

virtual class LayerContainer* mudbox::Layer::Container ( void ) const [virtual]

Returns a pointer to the object containing this layer.