mudbox::BrushStencil Struct Reference

#include <brushmask.h>

Inheritance diagram for mudbox::BrushStencil:

[legend] List of all members.

---

Detailed Description

A masking image attached to a camera.

Public Types
enum	{ eColorModeUndefined = -1, eColorModeLuminance, eColorModeColored }
Public Member Functions
virtual const mudbox::ClassDesc *	RuntimeClass (void) const
	BrushStencil (void)
	Constructor.
	~BrushStencil (void)
	Destructor.
void	SetVisibility (float f)
	Sets the visibility.
float	Visibility (void)
	Returns the visibility.
void	SetUIEnabled (bool b)
	Sets if the object can interact with the user.
void	SetColorMode (unsigned int mode)
	Sets the color mode.
unsigned int	ColorMode (void)
	Returns the color mode.
void	SetTransformation (const Matrix &mTransformation)
	Sets the transformation matrix.
void	UpdateMatrix (void)
	Updates the projection matrix.
const Matrix &	Final (void) const
	Returns the final matrix.
Matrix	MirroredFinal (void) const
	Returns the matrix mirrored to the active mirror axis.
bool	IsMirrored (void) const
	Returns if the stencil uses mirroring.
void	SetInverted (bool inv)
	Sets the stencil inverted state.
bool	IsInverted (void) const
	Returns if the stencil is inverted.
bool	Activate (void)
	Sets the stencil texture as current. Returns true if successful.
bool	Deactivate (void)
	Sets the stencil texture as not current. Returns true if successful.
void	SetFromImage (int iWidth, int iHeight, const unsigned int *pData)
	Creates the stencil from an exisiting in-memory image data.
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
bool	m_bUIEnabled
unsigned int	m_iColorMode
Matrix	m_mProjector
Matrix	m_mFinal
Texture *	m_pColorTexture
afloatr	m_fVisibility
abool	m_bInvert
abool	m_bUseTiles
abool	m_bShowTiles
afloatr	m_fOffset
abool	m_bAutoHide
abool	m_bMirror
abool	m_bFlipX
abool	m_bFlipY
aevent	m_cImport
aevent	m_cExport

---

Member Enumeration Documentation

anonymous enum

Enumeration values: eColorModeUndefined  eColorModeLuminance  eColorModeColored  { eColorModeUndefined = -1, eColorModeLuminance, eColorModeColored };

---

Constructor & Destructor Documentation

mudbox::BrushStencil::BrushStencil (  void   )

Constructor.

mudbox::BrushStencil::~BrushStencil (  void   )

Destructor.

---

Member Function Documentation

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

Reimplemented from mudbox::BrushMask. { m_bInvert.SetValue(inv); }

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

Reimplemented from mudbox::BrushMask.

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

Reimplemented from mudbox::BrushMask.

void mudbox::BrushStencil::SetVisibility (  float  f  )

Sets the visibility.

float mudbox::BrushStencil::Visibility (  void   )

Returns the visibility.

void mudbox::BrushStencil::SetUIEnabled (  bool  b  )

Sets if the object can interact with the user.

void mudbox::BrushStencil::SetColorMode (  unsigned int  mode  )

Sets the color mode.

unsigned int mudbox::BrushStencil::ColorMode (  void   )

Returns the color mode.

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

Sets the transformation matrix. Reimplemented from mudbox::BrushMask.

void mudbox::BrushStencil::UpdateMatrix (  void   )

Updates the projection matrix.

const Matrix& mudbox::BrushStencil::Final (  void   )  const

Returns the final matrix.

Matrix mudbox::BrushStencil::MirroredFinal (  void   )  const

Returns the matrix mirrored to the active mirror axis.

bool mudbox::BrushStencil::IsMirrored (  void   )  const

Returns if the stencil uses mirroring.

void mudbox::BrushStencil::SetInverted (  bool  inv  )  [inline]

Sets the stencil inverted state. { m_bInvert.SetValue(inv); }

bool mudbox::BrushStencil::IsInverted (  void   )  const

Returns if the stencil is inverted.

bool mudbox::BrushStencil::Activate (  void   )

Sets the stencil texture as current. Returns true if successful.

bool mudbox::BrushStencil::Deactivate (  void   )

Sets the stencil texture as not current. Returns true if successful.

void mudbox::BrushStencil::SetFromImage (  int  iWidth, int  iHeight, const unsigned int *  pData )

Creates the stencil from an exisiting in-memory image data.

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

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

---

Member Data Documentation

bool mudbox::BrushStencil::m_bUIEnabled [protected]

unsigned int mudbox::BrushStencil::m_iColorMode [protected]

Matrix mudbox::BrushStencil::m_mProjector [protected]

Matrix mudbox::BrushStencil::m_mFinal [protected]

Texture* mudbox::BrushStencil::m_pColorTexture [protected]

afloatr mudbox::BrushStencil::m_fVisibility [protected]

abool mudbox::BrushStencil::m_bInvert [protected]

abool mudbox::BrushStencil::m_bUseTiles [protected]

abool mudbox::BrushStencil::m_bShowTiles [protected]

afloatr mudbox::BrushStencil::m_fOffset [protected]

abool mudbox::BrushStencil::m_bAutoHide [protected]

abool mudbox::BrushStencil::m_bMirror [protected]

abool mudbox::BrushStencil::m_bFlipX [protected]

abool mudbox::BrushStencil::m_bFlipY [protected]

aevent mudbox::BrushStencil::m_cImport [protected]

aevent mudbox::BrushStencil::m_cExport [protected]

---