MirrorConfiguration Struct Reference

#include <brush.h>

Class Description

The structure contains information about mirroring of the operation.

Definition at line 100 of file brush.h.

Public Member Functions
	MirrorConfiguration (void)
	Constructor. More...
	MirrorConfiguration (const MirrorConfiguration &v)
enum MirrorMode	MirrorMode (void) const
	Returns if the mirror is on an axis or tangent. More...
void	SetMirrorMode (enum MirrorMode mode)
	Sets the mirroring planes. More...
const Store< mudbox::Vector > &	MirrorPlaneNormals (void) const
	Returns the mirror plane normals. More...
const Store< mudbox::Vector > &	MirrorPlanePositions (void) const
	Returns the mirror plane positions. More...
bool	IsMirrorLocal (void) const
	Returns if the mirroring is local. More...
int	MirrorPlanes (void) const
	Returns the number of mirroring planes. More...
Matrix	TransformationMatrix (const SurfacePoint *pSourceLocation, bool bNormalizeLocalFrame=false) const
	Returns a matrix which transforms positions w.r.t the current mirror mode. More...
Vector	Transform (const Vector &cSource, float fW, const SurfacePoint *pSourceLocation ) const
	Transforms a vector using the current mirror parameters in object space. More...
bool	operator== (const MirrorConfiguration &) const throw ()
bool	operator!= (const MirrorConfiguration &v) const throw ()
virtual void	Serialize (Stream &s)
	Serializes the configuration to the given stream. More...

Friends
class	BrushOperation

Constructor & Destructor Documentation

MirrorConfiguration

(

void

)

Constructor.

MirrorConfiguration

(

const MirrorConfiguration &

v

)

Member Function Documentation

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

inline

Returns the mirror plane normals.

Definition at line 110 of file brush.h.

{ return m_aMirrorPlaneNormals; };

const Store<mudbox::Vector>& MirrorPlanePositions ( void  ) const

inline

Returns the mirror plane positions.

Definition at line 112 of file brush.h.

{ return m_aMirrorPlanePositions; };

bool IsMirrorLocal ( void  ) const

inline

Returns if the mirroring is local.

Definition at line 114 of file brush.h.

{ return m_bMirrorLocal; };

int MirrorPlanes ( void  ) const

inline

Returns the number of mirroring planes.

Definition at line 116 of file brush.h.

{ return m_iMirrorPlanes; };

Matrix TransformationMatrix	(	const SurfacePoint *	pSourceLocation,
		bool	bNormalizeLocalFrame = false
	)		const

Returns a matrix which transforms positions w.r.t the current mirror mode.

Movement along two sides are scaled by the unnormalized local frames for tangent mirror mode if bNormalizeLocalFrame is false. The effect is as if the mirrored point is moving in object space.

Parameters

[in]	pSourceLocation	Location of a point on the surface which should be used as a reference. This point is usually
	bNormalizeLocalFrame	close to the point which should be transformed. 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. [in] Controls if the local frames used for the tangent mirror mode is normalized

Vector Transform	(	const Vector &	cSource,
		float	fW,
		const SurfacePoint *	pSourceLocation
	)		const

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

For tangent mirror mode, the result will be scaled by the unnormalized local frame on the mirror side.

Parameters

[in]	cSource	Vector in object space which should be transformed
[in]	fW	Fourth dimension of the vector. This is usually 0 when tranforming directions (to skip translations), and 1 otherwise
[in]	pSourceLocation	Location of a point on the surface which should be used as a reference. This point is usually close to the point which should be transformed. 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 operator== ( const MirrorConfiguration &  ) const throw ( )

inline

Definition at line 136 of file brush.h.

{ return false; };

bool operator!= ( const MirrorConfiguration &  v ) const throw ( )

inline

Definition at line 137 of file brush.h.

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

virtual void Serialize ( Stream &  s )

virtual

Serializes the configuration to the given stream.

Friends And Related Function Documentation

friend class BrushOperation

friend

Definition at line 164 of file brush.h.

---

The documentation for this struct was generated from the following file:

• Mudbox/brush.h