mudbox::BrushMask Struct Reference

#include <brushmask.h>

Inheritance diagram for mudbox::BrushMask:

[legend] List of all members.

---

Detailed Description

This class can be used for masking out areas from the brush effect.

Public Member Functions
virtual const mudbox::ClassDesc *	RuntimeClass (void) const
	BrushMask (void)
	Constructor.
	~BrushMask (void)
	Destructir.
void	SetState (bool b)
	Sets the enabled state.
bool	State (void)
	Returns the state.
float	Factor (void)
	Sets the effect multiplier factor.
void	SetFactor (float f)
	Returns the effect multiplier factor.
virtual void	SetTransformation (const Matrix &mTransformation)
	Sets the transformation matrix.
Matrix	Transformation (void)
	Returns the transformation matrix.
Image *	Image (void)
	Returns the mask image.
void	SetImage (class Image *pImage)
	Changes the mask image.
void	Clear (void)
	Clear the mask.
void	SetFileName (const QString &sFileName)
	Sets the filename and attemts to load from the file to an Image.
virtual void	CreateTextures (void)
	Creates Texture objects from the in-memory Image.
Static Public Member Functions
const mudbox::ClassDesc *	StaticClass (void)
mudbox::Node *	CreateInstances (unsigned int iCount=1)
Protected Attributes
Matrix	m_mTransformation
float	m_fAspectRatio
Image *	m_pImage
Texture *	m_pLuminanceTexture
abool	m_bState
afloatr	m_fFactor
astring	m_sFileName

---

Constructor & Destructor Documentation

mudbox::BrushMask::BrushMask (  void   )

Constructor.

mudbox::BrushMask::~BrushMask (  void   )

Destructir.

---

Member Function Documentation

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

Reimplemented from mudbox::TreeNode. Reimplemented in mudbox::BrushStamp, and mudbox::BrushStencil. 00059 : Matrix m_mTransformation;

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

Reimplemented from mudbox::TreeNode. Reimplemented in mudbox::BrushStamp, and mudbox::BrushStencil.

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

Reimplemented from mudbox::TreeNode. Reimplemented in mudbox::BrushStamp, and mudbox::BrushStencil.

void mudbox::BrushMask::SetState (  bool  b  )

Sets the enabled state.

bool mudbox::BrushMask::State (  void   )

Returns the state.

float mudbox::BrushMask::Factor (  void   )

Sets the effect multiplier factor.

void mudbox::BrushMask::SetFactor (  float  f  )

Returns the effect multiplier factor.

virtual void mudbox::BrushMask::SetTransformation (  const Matrix &  mTransformation  )  [virtual]

Sets the transformation matrix. Reimplemented in mudbox::BrushStencil.

Matrix mudbox::BrushMask::Transformation (  void   )

Returns the transformation matrix.

class Image* mudbox::BrushMask::Image (  void   )

Returns the mask image.

void mudbox::BrushMask::SetImage (  class Image *  pImage  )

Changes the mask image.

void mudbox::BrushMask::Clear (  void   )

Clear the mask.

void mudbox::BrushMask::SetFileName (  const QString &  sFileName  )

Sets the filename and attemts to load from the file to an Image.

virtual void mudbox::BrushMask::CreateTextures (  void   )  [virtual]

Creates Texture objects from the in-memory Image. Reimplemented in mudbox::BrushStencil.

---

Member Data Documentation

Matrix mudbox::BrushMask::m_mTransformation [protected]

float mudbox::BrushMask::m_fAspectRatio [protected]

class Image* mudbox::BrushMask::m_pImage [protected]

Texture* mudbox::BrushMask::m_pLuminanceTexture [protected]

abool mudbox::BrushMask::m_bState [protected]

afloatr mudbox::BrushMask::m_fFactor [protected]

astring mudbox::BrushMask::m_sFileName [protected]

---