Detailed Description

This class is an interface used to store user-specified normals (such as those created in the Edit Normals modifier).

These normals have very limited pipeline support. They are used for viewport display, but not for rendering.

The MeshNormalSpec contains three types of normals:

Unspecified - these are the usual normals that are computed from smoothing groups. All normals are unspecified by default.

Specified - these are normals that are intended for use by particular corners of particular faces, without regard to smoothing groups. For instance, you can create a box, apply Edit Normals, select a group of normals at a particular vertex, and click "Unify". Now those three faces are told to specifically use that one unified normal, and they ignore their smoothing groups at that vertex (which would normally tell them they should each have their own normal).

Explicit - these are normals that are set to particular values. For instance, if the user wants to use the Edit Normals Move or Rotate commands to set a normal to something other than its default value, it has to be made explicit, so it won't be recomputed based on the face normals. All explicit normals are also considered to be specified..

Remarks:: This class is available in release 6.0 and later only.

#include <MeshNormalSpec.h>

Inheritance diagram for MeshNormalSpec:

[legend]

List of all members.

Public Member Functions
	MeshNormalSpec ()
	~MeshNormalSpec ()
void	SetFlag (DWORD fl, bool val=true)
	Sets flags in the MeshNormalSpec.
void	ClearFlag (DWORD fl)
	Clears the flags given. See GetFlag for more details on MeshNormalSpec flags.
bool	GetFlag (DWORD fl) const
	Gets flags in the MeshNormalSpec.
DllExport void	Initialize ()
	Initializes all data members - do not use if already allocated!
DllExport bool	NAlloc (int num, bool keep=TRUE)
DllExport void	NShrink ()
	shrinks allocation down to actual number of normals.
DllExport bool	FAlloc (int num, bool keep=TRUE)
DllExport void	FShrink ()
DllExport void	Clear ()
	Deletes everything.
DllExport void	ClearAndFree ()
	Deletes everything, frees all memory.
int	GetNumFaces () const
DllExport bool	SetNumFaces (int numFaces)
int	GetNumNormals () const
DllExport bool	SetNumNormals (int numNormals)
Point3 &	Normal (int normID) const
Point3 *	GetNormalArray () const
bool	GetNormalExplicit (int normID) const
void	SetNormalExplicit (int normID, bool value)
void	SetAllExplicit (bool value=true)
	Set all normals to be explicit.
MeshNormalFace &	Face (int faceID) const
MeshNormalFace *	GetFaceArray () const
void	SetParent (Mesh *pMesh)
DllExport Point3 &	GetNormal (int face, int corner)
DllExport void	SetNormal (int face, int corner, Point3 &normal)
DllExport int	GetNormalIndex (int face, int corner)
DllExport void	SetNormalIndex (int face, int corner, int normalIndex)
DllExport int	NewNormal (Point3 normal, bool explic=true)
DllExport void	SetSelection (BitArray &newSelection)
BitArray &	GetSelection ()
void	SetDisplayLength (float displayLength)
float	GetDisplayLength ()
DllExport void	Display (GraphicsWindow *gw, bool showSel)
DllExport bool	HitTest (GraphicsWindow gw, HitRegion hr, DWORD flags, SubObjHitList &hitList)
DllExport Box3	GetBoundingBox (Matrix3 *tm=NULL, bool selectedOnly=false)
DllExport void	ClearNormals ()
	This method dumps all unspecified normals. Best to use only from within CheckNormals.
DllExport void	BuildNormals ()
	Fills in the mpSpecNormal data by building all the unspecified normals, and computing non-explicit ones.
DllExport void	ComputeNormals ()
	This method just recomputes the directions of non-explicit normals, without rebuilding the normal list.
DllExport void	CheckNormals ()
	This checks our flags and calls BuildNormals, ComputeNormals as needed.
DllExport MeshNormalSpec &	operator= (const MeshNormalSpec &from)
DllExport void	CopySpecified (const MeshNormalSpec &from)
DllExport MeshNormalSpec &	operator+= (const MeshNormalSpec &from)
DllExport void	MyDebugPrint (bool printAll=false)
DllExport bool	CheckAllData (int numParentFaces)
DllExport IOResult	Save (ISave *isave)
DllExport IOResult	Load (ILoad *iload)
Interface_ID	GetID ()
DllExport void	DeleteInterface ()
DllExport BaseInterface *	GetInterface (Interface_ID id)
DllExport BaseInterface *	CloneInterface (void *remapDir=NULL)
DllExport void	ShallowCopy (IPipelineClient *from, ChannelMask channels)
DllExport void	DeepCopy (IPipelineClient *from, ChannelMask channels)
DllExport void	NewAndCopyChannels (ChannelMask channels)
DllExport void	FreeChannels (ChannelMask channels, int zeroOthers=1)
DllExport void	ZeroChannels (ChannelMask channels)
DllExport void	AppendAllChannels (IPipelineClient *from)
DllExport bool	Transform (Matrix3 &xfm, BOOL useSel=false, BitArray *normalSelection=NULL)
DllExport bool	Translate (Point3 &translate, BOOL useSel=true, BitArray *normalSelection=NULL)
DllExport bool	BreakNormals (BOOL useSel=true, BitArray *normalSelection=NULL, BOOL toAverage=false)
DllExport bool	UnifyNormals (BOOL useSel=true, BitArray *normalSelection=NULL, BOOL toAverage=false)
DllExport bool	AverageNormals (BOOL useThresh=false, float threshold=0.0f, BOOL useSel=true, BitArray *normalSelection=NULL)
DllExport bool	SpecifyNormals (BOOL useSel=true, BitArray *normalSelection=NULL)
DllExport bool	MakeNormalsExplicit (BOOL useSel=true, BitArray *normalSelection=NULL, bool value=true)
DllExport bool	ResetNormals (BOOL useSel=true, BitArray *normalSelection=NULL)

Constructor & Destructor Documentation

MeshNormalSpec ( ) [inline]

                      : mpFace(NULL), mpNormal(NULL), mNumNormalAlloc(0),
        mNumFaceAlloc(0), mNumNormals(0), mNumFaces(0), mpParent(NULL), mFlags(0),
        mDisplayLength(MESH_NORMAL_LENGTH_DEFAULT) { }

~MeshNormalSpec ( ) [inline]

{ ClearAndFree (); }

Member Function Documentation

void SetFlag	(	DWORD	fl,
		bool	val = `true`
	)		`[inline]`

Search for all occurrences

Sets flags in the MeshNormalSpec.

Generally, the only flag that clients should set is the MESH_NORMAL_MODIFIER_SUPPORT flag. See GetFlag for more details.

{ if (val) mFlags |= fl; else mFlags &= ~fl; }

void ClearFlag ( DWORD fl ) [inline]

Search for all occurrences

Clears the flags given. See GetFlag for more details on MeshNormalSpec flags.

{ mFlags &= ~fl; }

bool GetFlag ( DWORD fl ) const [inline]

Search for all occurrences

Gets flags in the MeshNormalSpec.

Remarks:: MeshNormalSpec supports the following flags: MESH_NORMAL_NORMALS_BUILT Indicates that non-specified normals have been constructed using smoothing groups. If not set, non-specified normals may be invalid. MESH_NORMAL_NORMALS_COMPUTED Indicates that non-explicit normals have been computed using geometrically computed face normals. (If not set, only explicit normals may be assumed to be pointing the right direction.) MESH_NORMAL_MODIFIER_SUPPORT This flag should be set by modifiers that want to support the edited normals. See class TriObjectNormalModifier for more details. If this flag is not specifically set in a modifier that alters PART_GEOM or PART_TOPO of a TriObject, any specified normals will be cleared after the modifier is evaluated.

{ return (mFlags & fl) ? true : false; }

DllExport void Initialize ( )

Search for all occurrences

Initializes all data members - do not use if already allocated!

DllExport bool NAlloc	(	int	num,
		bool	keep = `TRUE`
	)

Search for all occurrences

DllExport void NShrink ( )

Search for all occurrences

shrinks allocation down to actual number of normals.

DllExport bool FAlloc	(	int	num,
		bool	keep = `TRUE`
	)

Search for all occurrences

DllExport void FShrink ( )

Search for all occurrences

DllExport void Clear ( )

Search for all occurrences

Deletes everything.

DllExport void ClearAndFree ( )

Search for all occurrences

Deletes everything, frees all memory.

int GetNumFaces ( ) const [inline]

Search for all occurrences

{ return mNumFaces; }

DllExport bool SetNumFaces ( int numFaces )

Search for all occurrences

int GetNumNormals ( ) const [inline]

Search for all occurrences

{ return mNumNormals; }

DllExport bool SetNumNormals ( int numNormals )

Search for all occurrences

Point3& Normal ( int normID ) const [inline]

Search for all occurrences

{ return mpNormal[normID]; }

Point3* GetNormalArray ( ) const [inline]

Search for all occurrences

{ return mpNormal; }

bool GetNormalExplicit ( int normID ) const [inline]

Search for all occurrences

{ return mNormalExplicit[normID] ? true : false; }

void SetNormalExplicit	(	int	normID,
		bool	value
	)		`[inline]`

Search for all occurrences

{ mNormalExplicit.Set (normID, value); }

void SetAllExplicit ( bool value = true ) [inline]

Search for all occurrences

Set all normals to be explicit.

Parameters:

value - If true, all normals will be set to explicit. If false, all normals will be set to non-explicit

{ if (value) mNormalExplicit.SetAll(); else mNormalExplicit.ClearAll (); }

MeshNormalFace& Face ( int faceID ) const [inline]

Search for all occurrences

{ return mpFace[faceID]; }

MeshNormalFace* GetFaceArray ( ) const [inline]

Search for all occurrences

{ return mpFace; }

void SetParent ( Mesh * pMesh ) [inline]

Search for all occurrences

{ mpParent = pMesh; }

DllExport Point3& GetNormal	(	int	face,
		int	corner
	)

Search for all occurrences

DllExport void SetNormal	(	int	face,
		int	corner,
		Point3 &	normal
	)

Search for all occurrences

DllExport int GetNormalIndex	(	int	face,
		int	corner
	)

Search for all occurrences

DllExport void SetNormalIndex	(	int	face,
		int	corner,
		int	normalIndex
	)

Search for all occurrences

DllExport int NewNormal	(	Point3	normal,
		bool	explic = `true`
	)

Search for all occurrences

DllExport void SetSelection ( BitArray & newSelection )

Search for all occurrences

BitArray& GetSelection ( ) [inline]

Search for all occurrences

{ return mNormalSel; }

void SetDisplayLength ( float displayLength ) [inline]

Search for all occurrences

{ mDisplayLength = displayLength; }

float GetDisplayLength ( ) [inline]

Search for all occurrences

{ return mDisplayLength; }

DllExport void Display	(	GraphicsWindow *	gw,
		bool	showSel
	)

Search for all occurrences

DllExport bool HitTest	(	GraphicsWindow *	gw,
		HitRegion *	hr,
		DWORD	flags,
		SubObjHitList &	hitList
	)

Search for all occurrences

DllExport Box3 GetBoundingBox	(	Matrix3 *	tm = `NULL`,
		bool	selectedOnly = `false`
	)

Search for all occurrences

DllExport void ClearNormals ( )

Search for all occurrences

This method dumps all unspecified normals. Best to use only from within CheckNormals.

DllExport void BuildNormals ( )

Search for all occurrences

Fills in the mpSpecNormal data by building all the unspecified normals, and computing non-explicit ones.

Remarks:: Does nothing if normal faces not allocated yet!

Requires an accurate mpParent pointer.

DllExport void ComputeNormals ( )

Search for all occurrences

This method just recomputes the directions of non-explicit normals, without rebuilding the normal list.

Remarks:: Requires an accurate mpParent pointer.

DllExport void CheckNormals ( )

Search for all occurrences

This checks our flags and calls BuildNormals, ComputeNormals as needed.

Remarks:: Requires an accurate mpParent pointer.

DllExport MeshNormalSpec& operator= ( const MeshNormalSpec & from )

DllExport void CopySpecified ( const MeshNormalSpec & from )

Search for all occurrences

DllExport MeshNormalSpec& operator+= ( const MeshNormalSpec & from )

DllExport void MyDebugPrint ( bool printAll = false )

Search for all occurrences

DllExport bool CheckAllData ( int numParentFaces )

Search for all occurrences

DllExport IOResult Save ( ISave * isave )

Search for all occurrences

DllExport IOResult Load ( ILoad * iload )

Search for all occurrences

Interface_ID GetID ( ) [inline, virtual]

Search for all occurrences

Remarks:: This method returns the unique interface ID.

Reimplemented from IPipelineClient.

{return MESH_NORMAL_SPEC_INTERFACE;}

DllExport void DeleteInterface ( ) [virtual]

Search for all occurrences

Remarks:: This method can be used as a direct interface delete request.

Default Implementation:: { }

Reimplemented from BaseInterface.

DllExport BaseInterface* GetInterface ( Interface_ID id ) [virtual]

Search for all occurrences

Remarks:: Returns a pointer to the interface whose ID is specified.

Parameters:: Interface_ID id

The ID of the interface to return.

Default Implementation:: { return NULL; }

Reimplemented from BaseInterface.

DllExport BaseInterface* CloneInterface ( void * remapDir = NULL ) [virtual]

Search for all occurrences

Remarks:: This method allows you to clone the base interface.

Parameters:: void* remapDir

The RemapDir passed to the clone method.

Default Implementation:: { return NULL; }

Reimplemented from BaseInterface.

DllExport void ShallowCopy	(	IPipelineClient *	from,
		ChannelMask	channels
	)		`[virtual]`

Search for all occurrences

Implements IPipelineClient.

DllExport void DeepCopy	(	IPipelineClient *	from,
		ChannelMask	channels
	)		`[virtual]`

Search for all occurrences

Implements IPipelineClient.

DllExport void NewAndCopyChannels ( ChannelMask channels ) [virtual]

Search for all occurrences

Implements IPipelineClient.

DllExport void FreeChannels	(	ChannelMask	channels,
		int	zeroOthers = `1`
	)		`[virtual]`

Search for all occurrences

Implements IPipelineClient.

DllExport void ZeroChannels ( ChannelMask channels ) [virtual]

Search for all occurrences

Implements IPipelineClient.

DllExport void AppendAllChannels ( IPipelineClient * from ) [virtual]

Search for all occurrences

Implements IPipelineClient.

DllExport bool Transform	(	Matrix3 &	xfm,
		BOOL	useSel = `false`,
		BitArray *	normalSelection = `NULL`
	)

Search for all occurrences

DllExport bool Translate	(	Point3 &	translate,
		BOOL	useSel = `true`,
		BitArray *	normalSelection = `NULL`
	)

Search for all occurrences

DllExport bool BreakNormals	(	BOOL	useSel = `true`,
		BitArray *	normalSelection = `NULL`,
		BOOL	toAverage = `false`
	)

Search for all occurrences

DllExport bool UnifyNormals	(	BOOL	useSel = `true`,
		BitArray *	normalSelection = `NULL`,
		BOOL	toAverage = `false`
	)

Search for all occurrences

DllExport bool AverageNormals	(	BOOL	useThresh = `false`,
		float	threshold = `0.0f`,
		BOOL	useSel = `true`,
		BitArray *	normalSelection = `NULL`
	)

Search for all occurrences

DllExport bool SpecifyNormals	(	BOOL	useSel = `true`,
		BitArray *	normalSelection = `NULL`
	)

Search for all occurrences

DllExport bool MakeNormalsExplicit	(	BOOL	useSel = `true`,
		BitArray *	normalSelection = `NULL`,
		bool	value = `true`
	)

Search for all occurrences

DllExport bool ResetNormals	(	BOOL	useSel = `true`,
		BitArray *	normalSelection = `NULL`
	)

Search for all occurrences

MeshNormalSpec Class Reference

Detailed Description

Public Member Functions

Constructor & Destructor Documentation

Member Function Documentation