mapextraction Namespace Reference

Classes
class	AmbientOcclusionSampler
	This class represents the ambient occlusion sampler. More...
class	DisplacementSampler
	This class represents the displacement sampler. More...
class	Extractor
	This class represents the central module of the extraction. More...
class	NormalSampler
	This class represents the normal vector sampler. More...
class	PaintLayerSampler
	This class represents the paint layer sampler. This sampler simply samples a paint layer over the source surface. More...
class	Sampler
	This class represents a sampler in map extraction, like Displacement, Ambient occlusion, etc... More...
class	SculptLayerSampler
	This class represents the sculpt layer sampler. This sampler samples a sculpt layer at the given point on the source mesh. More...
class	VectorDisplacementSampler
	This sampler represents the vector displacement sampler. More...

Enumerations
enum	UtilizerType { utilTexture, utilPtex, utilVertex, utilUnknown }
	This is the type of the final result for map extaction. This controls where the reference points are located on the target mesh. More...
enum	LocateMethod { locRaycast, locSubdivision, locCustom, locUnknown }
	This is the method Mudbox uses to pair sourface points on the target mesh to surface points on the source mesh. More...
enum	Space {   spaceWorld, spaceObject, spaceTangent, spaceRawTangent,   spaceNormal, spaceUnknown }
	Coordinate space used in varoius places during extraction. More...
enum	VertexAction {   vaVertexColor, vaMove, vaDisplace, vaFreeze,   vaSculptLayer, vaSculptLayerMask, vaUnknown }
	This is the action which happens with each vertex after extraction. This is only valid if the utilizer type is set to vertex. More...
enum	Antialiasing {   aaOff, aa2X, aa4X, aa6X,   aa8X, aaUnknown }
	Type of the antialiasing applied to extracted textures. This is only valid if utilizer type is set to texture. More...
enum	Sampling { sampleFurthestOutside, sampleFurthestInside, sampleClosesToTarget, sampleUnknown }
	How the intersection point is chosen when there are multiple candidates. This is only valid if locate method is set to raycast. More...
enum	Quality {   qualFastest, qualFast, qualNormal, qualGood,   qualBest, qualUnknown }
	Quality of ambient occlusion extraction. More...
enum	Resolution {   res256, res512, res1024, res2048,   res4096, resUnknown }
	Resolution of a texture map. This is always square. More...
enum	Compatibility { compMaya, compMax, compUnknown }
	Compatibility of the extracted normal map. More...

Functions
MEADLL class Extractor	CreateNewOperation (void)
	Creates a new extractor node. More...
MEADLL int	OperationCount (void)
	Returns the number of extractor nodes in the scene. More...
MEADLL class Extractor	OperationByIndex (int iIndex)
	Returns a given existing extractor node. More...

Enumeration Type Documentation

enum UtilizerType

This is the type of the final result for map extaction. This controls where the reference points are located on the target mesh.

Enumerator
utilTexture
utilPtex	Traditional textures, which are saved as plain image files (jpg, png, etc..), one for each tile. Target mesh needs texture coordinates.
utilVertex	Extracting to a ptex file.
utilUnknown	Extracting data to vertices of the target mesh. In this case the result is not a file, but some kind of operation on the target mesh, based on the result of the extraction. This is not exposed on the UI currently, but can be used programmatically.

Definition at line 28 of file MapExtractorAPI.h.

    {
        utilTexture,    
        utilPtex,           
        utilVertex,     
        utilUnknown
    };

enum LocateMethod

This is the method Mudbox uses to pair sourface points on the target mesh to surface points on the source mesh.

Enumerator
locRaycast
locSubdivision	With this method, mudbox fires a ray which crosses the target mesh in the desired point, and the direction is the same as the opposite of the. surface normal. Mudbox then finds the intersection of this ray, and the source mesh.
locCustom	This method can only be used, if the target mesh and the source mesh are subdivision levels of the same object (or they have the. matching topology). Mudbox calculates the point pairs based on this subdivision relationship.
locUnknown	This method can only be used, when there is a precalculated relationship between the source and target mesh. This is the case for example, after retopology, the new mesh can be used as target, the old mesh can be used as source.

Definition at line 38 of file MapExtractorAPI.h.

    {
        locRaycast, 
        locSubdivision, 
        locCustom,  
        locUnknown
    };

enum Space

Coordinate space used in varoius places during extraction.

Enumerator
spaceWorld
spaceObject	World space (or global space).
spaceTangent	Object space, which is always related to some mesh in the scene.
spaceRawTangent	This is a special space, which is changing over the mesh, so it also depends on a location. For more details, look for various tangent space documentation on the internet, like: Lengyel, Eric. Computing Tangent Space Basis Vectors for an Arbitrary Mesh. Terathon Software 3D Graphics Library, 2001. http://www.terathon.com/code/tangent.html
spaceNormal	Same as above, but the tangent and bitangent remains unnormalized and their direction is not aligned to the surface normal. The length of the surface normal is changed to the geometric average of the length of the tangent and bitangent vectors.
spaceUnknown	This is a special space used in displacement map extraction. Used only internally.

Examples:

Definition at line 50 of file MapExtractorAPI.h.

    {
        spaceWorld,         
        spaceObject,            
        spaceTangent,       
        spaceRawTangent,    
        spaceNormal,            
        spaceUnknown        
    };

enum VertexAction

This is the action which happens with each vertex after extraction. This is only valid if the utilizer type is set to vertex.

Enumerator
vaVertexColor
vaMove	Each vertex gets a new vertex color asigned, based on the calculated data.
vaDisplace	The vertex position is modified based on the extracted data (the data as a vector is added to the current vertex position).
vaFreeze	Move the vertex along the surface normal.
vaSculptLayer	Change the vertex freeze value based on the extracted data.
vaSculptLayerMask	Create a new sculpt layer, and put vectors there, without changing the actual vertex positions.
vaUnknown	Change the mask for the given sculpt layer based on the extracted data.

Definition at line 64 of file MapExtractorAPI.h.

    {
        vaVertexColor,      
        vaMove,             
        vaDisplace,         
        vaFreeze,           
        vaSculptLayer,      
        vaSculptLayerMask,  
        vaUnknown
    };

enum Antialiasing

Type of the antialiasing applied to extracted textures. This is only valid if utilizer type is set to texture.

Enumerator
aaOff
aa2X
aa4X
aa6X
aa8X
aaUnknown

Definition at line 76 of file MapExtractorAPI.h.

    {
        aaOff,
        aa2X,
        aa4X,
        aa6X,
        aa8X,
        aaUnknown
    };

enum Sampling

How the intersection point is chosen when there are multiple candidates. This is only valid if locate method is set to raycast.

Enumerator
sampleFurthestOutside
sampleFurthestInside	The furthest is chosen, outside of the target mesh.
sampleClosesToTarget	The furthest is chosen, inside the target mesh.
sampleUnknown	The closest to the target mesh is chosen.

Definition at line 87 of file MapExtractorAPI.h.

    {
        sampleFurthestOutside,  
        sampleFurthestInside,       
        sampleClosesToTarget,   
        sampleUnknown
    };

enum Quality

Quality of ambient occlusion extraction.

Enumerator
qualFastest
qualFast
qualNormal
qualGood
qualBest
qualUnknown

Definition at line 96 of file MapExtractorAPI.h.

    {
        qualFastest,
        qualFast,
        qualNormal,
        qualGood,
        qualBest,
        qualUnknown
    };

enum Resolution

Resolution of a texture map. This is always square.

Enumerator
res256
res512
res1024
res2048
res4096
resUnknown

Definition at line 107 of file MapExtractorAPI.h.

    {
        res256,
        res512,
        res1024,
        res2048,
        res4096,
        resUnknown
    };

enum Compatibility

Compatibility of the extracted normal map.

Enumerator
compMaya
compMax
compUnknown

Definition at line 118 of file MapExtractorAPI.h.

    {
        compMaya,
        compMax,
        compUnknown
    };

Function Documentation

MEADLL class Extractor mapextraction::CreateNewOperation

(

void

)

Creates a new extractor node.

Examples:

MEADLL int mapextraction::OperationCount

(

void

)

Returns the number of extractor nodes in the scene.

MEADLL class Extractor mapextraction::OperationByIndex

(

int

iIndex

)

Returns a given existing extractor node.