This reference page is linked to from the following overview topics: Hit Regions.

Detailed Description

See also:: Class MNMESH , Class MNNormalFace

Description:

This class is available in release 5.0 and later only.

This class is an interface used to store user-specified normals

(as created in the Edit Normals modifier). These normals have very

limited pipeline support. They are used for viewport display, but not

for rendering.

The MNNormalSpec 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..

Flags:: MNNORMAL_NORMALS_BUILT

Indicates that non-specified normals have been constructed using

smoothing groups. If not set, non-specified normals may be invalid.

MNNORMAL_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.)

Data Members:: All data members are private.

int mNumNormalAlloc, mNumFaceAlloc;

The current allocation length of the mpNormal and mpFace arrays.

int mNumNormals, mNumFaces;

The number of normals and faces in the mpNormal and mpFace arrays.

(May be less than the actual allocation above.)

MNNormalFace *mpFace;

The array of normal faces.

Point3 *mpNormal;

The array of normals, all of which should be either length 1 or (occasionally) 0.

BitArray mNormalExplicit;

Indicates whether mpNormal[i] is explicit or computed from face normals.

BitArray mNormalSel;

Current normal selection.

float mDisplayLength;

The length to use when displaying, hit testing, or moving normals.

MNMesh *mpParent;

A pointer to the "parent" MNMesh that owns this MNNormalSpec. This parent

information is required for some operations, such as display. (Such

operations should indicate below where parent information is required.) :

#include <MNNormalSpec.h>

Inheritance diagram for MNNormalSpec:

[legend]

List of all members.

Public Member Functions
	MNNormalSpec ()
	~MNNormalSpec ()
DllExport void	Initialize ()
DllExport bool	NAlloc (int num, bool keep=TRUE)
DllExport void	NShrink ()
DllExport bool	FAlloc (int num, bool keep=TRUE)
DllExport void	FShrink ()
DllExport void	Clear ()
DllExport void	ClearAndFree ()
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 in this MNNormalSpec to be explicit.
MNNormalFace &	Face (int faceID) const
MNNormalFace *	GetFaceArray () const
void	SetParent (MNMesh *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	CollapseDeadFaces ()
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 ()
DllExport void	BuildNormals ()
DllExport void	ComputeNormals ()
DllExport void	CheckNormals ()
DllExport MNNormalSpec &	operator= (const MNNormalSpec &from)
DllExport void	CopySpecified (const MNNormalSpec &from)
DllExport MNNormalSpec &	operator+= (const MNNormalSpec &from)
DllExport void	MNDebugPrint (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

MNNormalSpec ( ) [inline]

Remarks:: Constructor. Initializes all data members.

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

~MNNormalSpec ( ) [inline]

Remarks:: Destructor. Calls ClearAndFree().

{ ClearAndFree (); }

Member Function Documentation

DllExport void Initialize ( )

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

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

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

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

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

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

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

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

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`
	)

MNNormalSpec Class Reference

Detailed Description

Public Member Functions

Constructor & Destructor Documentation

Member Function Documentation