mudbox::MirrorConfiguration Struct Reference

#include <brush.h>

Detailed Description

The structure contains information about mirroring of the operation.


Public Member Functions
	MirrorConfiguration (void)
	Constructor.
enum MirrorMode	MirrorMode (void) const
	Returns if the mirror is on an axis or tangent.
void	SetMirrorMode (enum MirrorMode mode)
	Sets the mirroring planes.
const Store< mudbox::Vector > &	MirrorPlaneNormals (void) const
	Returns the mirror plane normals.
const Store< mudbox::Vector > &	MirrorPlanePositions (void) const
	Returns the mirror plane positions.
bool	IsMirrorLocal (void) const
	Returns if the mirroring is local.
int	MirrorPlanes (void) const
	Returns the number of mirroring planes.
Vector	Transform (const Vector &cSource, float fW, const SurfacePoint *pTargetLocation) const
	Transforms a vector using the current mirror parameters in object space.
bool	operator== (const MirrorConfiguration &) const throw ()
bool	operator!= (const MirrorConfiguration &v) const throw ()
Friends
class	BrushOperation

mudbox::MirrorConfiguration::MirrorConfiguration

(

void

)

Constructor.

enum MirrorMode mudbox::MirrorConfiguration::MirrorMode

(

void

)

const

Returns if the mirror is on an axis or tangent.

void mudbox::MirrorConfiguration::SetMirrorMode

(

enum MirrorMode

mode

)

Sets the mirroring planes.

const Store<mudbox::Vector>& mudbox::MirrorConfiguration::MirrorPlaneNormals ( void ) const [inline]

Returns the mirror plane normals.

00081 { return m_aMirrorPlaneNormals; };

const Store<mudbox::Vector>& mudbox::MirrorConfiguration::MirrorPlanePositions ( void ) const [inline]

Returns the mirror plane positions.

00083 { return m_aMirrorPlanePositions; };

bool mudbox::MirrorConfiguration::IsMirrorLocal ( void ) const [inline]

Returns if the mirroring is local.

00085 { return m_bMirrorLocal; };

int mudbox::MirrorConfiguration::MirrorPlanes ( void ) const [inline]

Returns the number of mirroring planes.

00087 { return m_iMirrorPlanes; };

Vector mudbox::MirrorConfiguration::Transform	(	const Vector &	cSource,
		float	fW,
		const SurfacePoint *	pTargetLocation
	)	const

Transforms a vector using the current mirror parameters in object space.

Parameters:

cSource	[in] Vector in object space which should be transformed
fW	[in] Fourth dimension of the vector. This is usually 0 when tranforming directions (to skip translations), and 1 otherwise
pTargetLocation	[in] Location of a point on the surface which indicates where the result is expected. This parameter can be NULL, but in some cases (like for tangent space mirroring) the result will only be correct if this parameter is specified.

bool mudbox::MirrorConfiguration::operator== ( const MirrorConfiguration & ) const throw () [inline]

00097 { return false; };

bool mudbox::MirrorConfiguration::operator!= ( const MirrorConfiguration & v ) const throw () [inline]

00098 { return !operator ==( v ); };

friend class BrushOperation [friend]