meshadj.h File Reference

#include <WTypes.h>
#include "maxheap.h"
#include "export.h"
#include "point3.h"
#include "TabTypes.h"
#include "mesh.h"

Classes
class	MEdge
class	AdjEdgeList
class	AdjFace
class	AdjFaceList
class	FaceElementList
class	FaceClusterList
class	EdgeClusterList
class	MeshChamferData
class	MeshTempData
class	MeshSelectionConverter

Macros
#define	UNDEFINED   0xffffffff
#define	MESH_EXTRUDE_CLUSTER   1
#define	MESH_EXTRUDE_LOCAL   2
#define	SOFTSEL_MIN_FALLOFF   0.0f
#define	SOFTSEL_MAX_FALLOFF   999999.0f
#define	SOFTSEL_DEFAULT_FALLOFF   20.0f
#define	SOFTSEL_MIN_PINCH   -1000.0f
#define	SOFTSEL_MAX_PINCH   1000.0f
#define	SOFTSEL_DEFAULT_PINCH   0.0f
#define	SOFTSEL_MIN_BUBBLE   -1000.0f
#define	SOFTSEL_MAX_BUBBLE   1000.0f
#define	SOFTSEL_DEFAULT_BUBBLE   0.0f
#define	MESHSELECTCONVERT_INTERFACE   Interface_ID(0x3da7dd5, 0x7ecf0391)
#define	MESH_SELCONV_REQUIRE_ALL   0x01

Functions
DllExport void	MeshChamferDataDebugPrint (MeshChamferData &mcd, int mapNum)
DllExport float	AffectRegionFunction (float dist, float falloff, float pinch, float bubble)
DllExport Point3	SoftSelectionColor (float selAmount)
DllExport void	MatrixFromNormal (Point3 &normal, Matrix3 &mat)
DllExport void	AverageVertexNormals (Mesh &mesh, Tab< Point3 > &vnormals)
DllExport Point3	AverageSelVertNormal (Mesh &mesh)
DllExport Point3	AverageSelVertCenter (Mesh &mesh)
DllExport void	DeselectHiddenFaces (Mesh &mesh)
DllExport void	DeselectHiddenEdges (Mesh &mesh)
DllExport void	HiddenFacesToVerts (Mesh &mesh, BitArray alsoHide)
DllExport void	SelectionDistance (const Point3 *vertArray, int vertNum, int vertStep, const BitArray &selMask, float *selDist, float falloffLimit=-1.0f)
DllExport void	SelectionDistance (Mesh &mesh, float *selDist, int iters, AdjEdgeList *ae=NULL)
DllExport void	ClustDistances (Mesh &mesh, DWORD numClusts, DWORD *vclust, Tab< float > **clustDist)
DllExport void	ClustDistances (Mesh &mesh, DWORD numClusts, DWORD *vclust, Tab< float > **clustDist, int iters, AdjEdgeList *ae=NULL)

Macro Definition Documentation

UNDEFINED

#define UNDEFINED   0xffffffff

MESH_EXTRUDE_CLUSTER

#define MESH_EXTRUDE_CLUSTER   1

MESH_EXTRUDE_LOCAL

#define MESH_EXTRUDE_LOCAL   2

SOFTSEL_MIN_FALLOFF

#define SOFTSEL_MIN_FALLOFF   0.0f

SOFTSEL_MAX_FALLOFF

#define SOFTSEL_MAX_FALLOFF   999999.0f

SOFTSEL_DEFAULT_FALLOFF

#define SOFTSEL_DEFAULT_FALLOFF   20.0f

SOFTSEL_MIN_PINCH

#define SOFTSEL_MIN_PINCH   -1000.0f

SOFTSEL_MAX_PINCH

#define SOFTSEL_MAX_PINCH   1000.0f

SOFTSEL_DEFAULT_PINCH

#define SOFTSEL_DEFAULT_PINCH   0.0f

SOFTSEL_MIN_BUBBLE

#define SOFTSEL_MIN_BUBBLE   -1000.0f

SOFTSEL_MAX_BUBBLE

#define SOFTSEL_MAX_BUBBLE   1000.0f

SOFTSEL_DEFAULT_BUBBLE

#define SOFTSEL_DEFAULT_BUBBLE   0.0f

MESHSELECTCONVERT_INTERFACE

#define MESHSELECTCONVERT_INTERFACE   Interface_ID(0x3da7dd5, 0x7ecf0391)

MESH_SELCONV_REQUIRE_ALL

#define MESH_SELCONV_REQUIRE_ALL   0x01

Function Documentation

MeshChamferDataDebugPrint()

DllExport void MeshChamferDataDebugPrint	(	MeshChamferData &	mcd,
		int	mapNum
	)

Remarks

This function uses calls to DebugPrint() to output all the data in the specified MeshChamferData to the DebugPrint buffer during debug runs. It is available for programmers' use, providing easy access to MeshChamferData during development. It ought to be removed for release builds.

Parameters:

MeshChamferData & mcd

The MeshChamferData we want to investigate.

int mapNum

The number of map channels in the Mesh associated with this MeshChamferData. (For historical reasons, this information is not kept in the MeshChamferData class.) Generally this is retrieved with a call to Mesh::getNumMaps().

AffectRegionFunction()

DllExport float AffectRegionFunction	(	float	dist,
		float	falloff,
		float	pinch,
		float	bubble
	)

Remarks

This function is available in release 3.0 and later only.

This is the standard affect region function, based on a distance and the three affect region parameters (same as the editable mesh).

This function is a cubic curve which returns 1 at distance 0, 0 if distance is greater than falloff, and other values for distance between 0 and falloff. To "see" this function graphed, look at the curve in the Soft Selection parameters in Edit Mesh, Editable Mesh, Mesh Select, or Volume Select. This function currently is constructed as follows:

float u = ((falloff - dist)/falloff);
float u2 = u*u, s = 1.0f-u;
return (3*u*bubble*s + 3*u2*(1.0f-pinch))*s + u*u2;"

Parameters:

float dist

The distance to the selection. The method for computing this distance is up to the developer; for example in Mesh Select, it's the distance to the nearest selected vertex, while in Volume Select (with a box or sphere selection region) it's the distance to the selection volume.

float falloff

The limit distance of the effect. If distance > falloff, the function will always return 0.

float pinch

Use this to affect the tangency of the curve near distance=0. Positive values produce a pointed tip, with a negative slope at 0, while negative values produce a dimple, with positive slope.

float bubble

Use this to change the curvature of the function. A value of 1.0 produces a half-dome. As you reduce this value, the sides of the dome slope more steeply. Negative values lower the base of the curve below 0.

Returns

Returns the strength of the Affect Region function at the given distance. (In selection modifiers, this is the "soft selection" amount, the amount it's considered selected. A vertex at a distance with a return value of .25, for instance, will be affected 1/4 as strongly in a deformation as a fully selected vertex.)

SoftSelectionColor()

DllExport Point3 SoftSelectionColor

(

float

selAmount

)

MatrixFromNormal()

DllExport void MatrixFromNormal	(	Point3 &	normal,
		Matrix3 &	mat
	)

Remarks

This function is available in release 3.0 and later only.

This function creates a matrix with the normal as a Z-axis. The X and Y axes are chosen arbitrarily.

Parameters:

Point3& normal

The input normal is specified here.

Matrix3& mat

The output matrix.

AverageVertexNormals()

DllExport void AverageVertexNormals	(	Mesh &	mesh,
		Tab< Point3 > &	vnormals
	)

Remarks

This function is available in release 3.0 and later only.

This function creates vertex normals that are weighted averages of faces using each vertexSmoothing groups are not used in these computations – the normals are those you would expect with a totally smooth mesh.

Parameters:

Mesh & mesh

The mesh whose average vertex normals are computed.

Tab<Point3> & vnormals

The output vertex normals. . This will be set to size mesh.numVerts.

AverageSelVertNormal()

DllExport Point3 AverageSelVertNormal

(

Mesh &

mesh

)

Remarks

This function is available in release 3.0 and later only.

This function computes and returns the average normal of a group of selected vertices.

Parameters:

Mesh& mesh

The mesh to check. The function uses mesh.vertSel to check for selected verts.

AverageSelVertCenter()

DllExport Point3 AverageSelVertCenter

(

Mesh &

mesh

)

Remarks

This function is available in release 3.0 and later only.

This function computes and returns the average center of a group of selected vertices.

Parameters:

Mesh& mesh

The mesh to check. The function uses mesh.vertSel to check for selected verts.

DeselectHiddenFaces()

DllExport void DeselectHiddenFaces

(

Mesh &

mesh

)

Remarks

This function is available in release 3.0 and later only.

Removes hidden faces from the mesh.faceSel selection array.

Parameters:

Mesh& mesh

The mesh to check.

DeselectHiddenEdges()

DllExport void DeselectHiddenEdges

(

Mesh &

mesh

)

Remarks

This function is available in release 3.0 and later only.

This function removes edges on hidden faces from the mesh.edgeSel selection array.

Parameters:

Mesh& mesh

The mesh to check.

HiddenFacesToVerts()

DllExport void HiddenFacesToVerts	(	Mesh &	mesh,
		BitArray	alsoHide
	)

Remarks

This function is available in release 3.0 and later only.

This function hides vertices that are only used by hidden faces. If alsoHide has size mesh.numVerts, it is used to indicate other vertices that should also be hidden. Note that passing mesh.vertHide as alsoHide will NOT WORK, as mesh.vertHide is overwritten before alsoHide is read.

Parameters:

Mesh &mesh

The mesh to check.

BitArray &alsoHide

If specified, this is used to indicates other vertices that should also be hidden.

SelectionDistance() [1/2]

DllExport void SelectionDistance	(	const Point3 *	vertArray,
		int	vertNum,
		int	vertStep,
		const BitArray &	selMask,
		float *	selDist,
		float	falloffLimit = -1.0f
	)

Remarks

This function is available in release 3.0 and later only.

This function computes distances from selected vertices (as indicated by selMask) to non-selected ones.

NOTE: This function leverages interal space accelerating structure to compute the nearest distance to the selected vertices. Under the worst condition the algorithm complexity is log(n)*n, in practice the algoirthm is nearly linear complexity.

Parameters:

const Point3* & vertArray

The pointer to the first Point3 vertex to check.

int & *vertStep

The vertex memory step in bytes when stepping to next vertex. const BitArray& & selMask

This is the mask indicating the selected vertices, usually it is computed from mesh.VertexTempSel(). float *selDist

This is assumed to be a float array of size mesh.numVerts. It is set to -1 for all verts if there is no selection. Otherwise, selected vertices have a value of 0, and nonselected vertices have the distance to the nearest selected vertex.

SelectionDistance() [2/2]

DllExport void SelectionDistance	(	Mesh &	mesh,
		float *	selDist,
		int	iters,
		AdjEdgeList *	ae = NULL
	)

Remarks

This function is available in release 3.0 and later only.

This function computes distances from selected vertices (as indicated by mesh.VertexTempSel()) to non-selected ones along edge paths. selDist is assumed to be a float array of size mesh.numVerts. selDist is set to -1 for all verts if there is no selection. Otherwise, selected vertices have selDist value 0; non-selected vertices that are "iters" or fewer edges away from a selected vertex are assigned the shortest edge-path distance to a selected vertex; and non-selected vertices that are more than iters edges away are set to -1. The AdjEdgeList is computed by the algorithm if the one passed is NULL; otherwise you can save time by passing a cached one in.

This is NOT an n-squared algorithm like the one above. It's more a sort of order-of-n-times-(iters-squared).

Parameters:

Mesh & mesh

The mesh to check.

float *selDist

An array of floats of size mesh.numVerts.

int iters

If 0, Selection Distance is computed from each vertex to the nearest selected vertex, regardless of topology. This is a VERY EXPENSIVE ALGORITHM, which takes almost 4 times as long for twice as many vertices. If iters is non-zero, it represents the number of edges one should "travel" in trying to find the nearest selected vertex – this means that it only takes twice as long for twice as many verts. (This is like the Edge Distance parameter in EMesh's Soft Selection dialog.) If iters is 0, ae is irrelevant and may be left as NULL. If iters is nonzero, an Adjacent Edge List is required, and will be computed internally from the mesh if ae is NULL. (If you've got an AdjEdgeList for this mesh handy, pass it in, otherwise don't worry about it.)

Note also that if iters is nonzero, the distance is computed along the edges, not directly through space. If there is no selected vertex within an iters-length path, a vertex is assigned a 0 selection value.

AdjEdgeList *ae=NULL

The optional adjacent edge list.

ClustDistances() [1/2]

DllExport void ClustDistances	(	Mesh &	mesh,
		DWORD	numClusts,
		DWORD *	vclust,
		Tab< float > **	clustDist
	)

Remarks

This function is available in release 3.0 and later only.

Computes distances from nonselected vertices in the mesh to each of the vertex clusters. This is a VERY EXPENSIVE ALGORITHM, which takes almost 4 times as long for twice as many vertices.

Preparation for this method would typically look like:

// given Mesh msh, FaceClusterList fclust:

Tab<DWORD> vclust;

fclust.MakeVertCluster (msh, vclust);

Tab<float> ** clustDist;

clustDist = new (Tab<float> *)[fclust.count];

for (int i=0; i<fclust.count; i++) clustDist[i] = new Tab<float>;

ClustDistances (mesh, fclust.count, vclust.Addr(0), clustDist);

Then (*clustDist[c])[v] would give the distance from vertex v in the mesh to the vertices of cluster c.

Parameters:

Mesh &mesh

The mesh the clusters are based on.

DWORD numClusts

The number of clusters in this mesh.

DWORD *vclust

A pointer to an array of vertex cluster IDs. Typically this is a pointer to the data in the table created by EdgeClusterList::GetVertClusters or FaceClusterList::GetVertClusters.

Tab<float> **clustDist

This is an array of <numClusts> pointers to tables that will be used to store distances from various clusters. Each table will be set to the ize of mesh.numVerts and filled with distances to the cluster that table represents.

ClustDistances() [2/2]

DllExport void ClustDistances	(	Mesh &	mesh,
		DWORD	numClusts,
		DWORD *	vclust,
		Tab< float > **	clustDist,
		int	iters,
		AdjEdgeList *	ae = NULL
	)

Remarks

This function is available in release 3.0 and later only.

Computes distances from nonselected vertices in the mesh to each of the vertex clusters. Unlike the other version which doesn't have an iters or ae parameter, this is a linear algorithm which computes distance along a finite number of edges.

Preparation for this method would typically look like:

// given Mesh msh, FaceClusterList fclust:

Tab<DWORD> vclust;

fclust.MakeVertCluster (msh, vclust);

Tab<float> ** clustDist;

clustDist = new (Tab<float> *)[fclust.count];

for (int i=0; i<fclust.count; i++) clustDist[i] = new Tab<float>;

ClustDistances(mesh, fclust.count, vclust.Addr(0), clustDist);

Then (*clustDist[c])[v] would give the distance from vertex v in the mesh to the vertices of cluster c.

Parameters:

Mesh & mesh

The mesh the clusters are based on.

DWORD numClusts

The number of clusters in this mesh.

DWORD *vclust

A pointer to an array of vertex cluster IDs. Typically this is a pointer to the data in the table created by EdgeClusterList::GetVertClusters or FaceClusterList::GetVertClusters.

Tab<float> **clustDist

This is an array of <numClusts> pointers to tables that will be used to store distances from various clusters. Each table will be set to the ize of mesh.numVerts and filled with distances to the cluster that table represents.

int iters

The maximum number of edges to travel along looking for a vertex in the given cluster.

AdjEdgeList *ae=NULL

Edge length computations require an adjacent edge list. If you don't pass one in this parameter, it'll have to construct its own from the mesh.