Extractor Class Reference

#include <MapExtractorAPI.h>

Class Description

This class represents the central module of the extraction.

This interface should be used when you want to automate map extraction. If you want to extend the current extraction possibilities by creating a custom module, you should use the MapExtractor class and related classes.

Examples:

Definition at line 299 of file MapExtractorAPI.h.

Public Member Functions
	Extractor (mapextractionmodules::MapExtractor *pExtractor)
	~Extractor (void)
mapextractionmodules::MapExtractor *	ExtractorObject (void)
	Returns a pointer to the underlying map extractor object. More...
int	SourceCount (void) const
	Returns the number of source meshes. More...
mudbox::SubdivisionLevel *	Source (int iIndex) const
	Returns the address of a source mesh for a given slot. More...
void	SetSourceCount (int iCount)
	Sets the number of source meshes. More...
void	SetSource (int iIndex, mudbox::SubdivisionLevel *pSource)
	Assigns a pointer to a source slot. More...
bool	SourceSmoothing (void) const
	Returns true, if the limit surface of the source meshes should be used. More...
void	SetSourceSmoothing (bool bSourceSmoothing)
	Sets smoothing on/off for source meshes. More...
int	TargetCount (void) const
	Returns the number of target meshes. More...
mudbox::SubdivisionLevel *	Target (int iIndex) const
	Retuns a pointer to a target mesh for a given slot. More...
void	SetTargetCount (int iCount)
	Sets the number of target meshes. More...
void	SetTarget (int iIndex, mudbox::SubdivisionLevel *pTarget)
	Assigns a mesh pointer to a target mesh slot. More...
bool	TargetSmoothing (void) const
	Returns true, if the limit surface of the target meshes should be used. More...
void	SetTargetSmoothing (bool bTargetSmoothing)
	Turns limit surface on/off for target meshes. More...
bool	TargetUVSmoothing (void) const
	Returns true if UV of the target meshes should be smoothed. More...
void	SetTargetUVSmoothing (bool bSmoothUV)
	Turns UV smoothing on for the target meshes. More...
bool	TargetCreases (void) const
	Returns true if creasing should be used for the target meshes. More...
void	SetTargetCreases (bool bUse)
	Turns creasing on/off for the target meshes. More...
void	SetTangentGenerator (mudbox::TangentGenerator *pTG)
	Sets a tangent generator, which will be used during extraction. More...
enum UtilizerType	UtilizerType (void) const
	Returns the current utilizer type. This controls what the final result of the extraction will be, default is textures. More...
void	SetUtilizerType (enum UtilizerType eUtilizerType)
	Sets the utilizer type. This controls what the final result of the extraction will be, default is textures. More...
int	MapWidth (void) const
	Returns the width of the generated textures. This is only valid when utilizer type is set to texture. More...
int	MapHeight (void) const
	Returns the height of the generated textures. This is only valid when utilizer type is set to texture. More...
void	SetMapWidth (int iWidth)
	Sets the width of the generated textures. This is only valid when utilizer type is set to texture. More...
void	SetMapHeight (int iHeight)
	Sets the height of the generated textures. This is only valid when utilizer type is set to texture. More...
enum Antialiasing	Antialiasing (void) const
	Returns the current anti-aliasing settings. Only valid when utilizer type is set to texture. More...
void	SetAntialiasing (enum Antialiasing eAntialiasing)
	Sets the current anti-aliasing settings. Only valid when utilizer type is set to texture. More...
int	EdgeBleeding (void) const
	Returns the number of pixels used for edge bleeding. -1 means the bleed value set for texture painting is used. More...
void	SetEdgeBleeding (int iPixels)
	Sets the width of the bleed area in pixels. More...
class DisplacementSampler	DisplacementSampler (int iIndex=0)
	Returns the displacement sampler. More...
class VectorDisplacementSampler	VectorDisplacementSampler (int iIndex=0)
	Returns the vector dispalcement sampler. More...
class NormalSampler	NormalSampler (int iIndex=0)
	Returns the normal vector sampler. More...
class AmbientOcclusionSampler	AmbientOcclusionSampler (int iIndex=0)
	Returns the ambient occlusion sampler. More...
class PaintLayerSampler	PaintLayerSampler (int iIndex=0)
	Returns the paint layer sampler. This is not exposed on the UI currently, but can be used programmatically. More...
class SculptLayerSampler	SculptLayerSampler (int iIndex=0)
	Returns the sculpt layer sampler. This is not exposed on the UI currently, but can be used programmatically. More...
class Sampler	DummySampler (int iIndex=0)
	Returns an empty sampler, which only outputs black color. This is not exposed on the UI currently, but can be used programmatically. More...
enum LocateMethod	LocateMethod (int iIndex=0) const
	Returns the current locate method. More...
void	SetLocateMethod (enum LocateMethod eLocateMethod, int iIndex=0)
	Sets the current locate method. This controls how target surface points gets paired with source surface points. More...
void	SetLocateMeshes (QVector< mudbox::SubdivisionLevel * > aInputs, QVector< mudbox::SubdivisionLevel * > aOutputs, int iIndex=0)
	Sets the input and output meshes for a locator. This should be called only if there mare more than one locators. More...
enum Sampling	Sampling (int iIndex=0) const
	Returns how the final intersection point is chosen, if there are multiple candidates. This is only valid if locate method is set to raycast. More...
void	SetSampling (enum Sampling, int iIndex=0)
	Sets how the final intersection point is chosen, if there are multiple candidates. This is only valid if locate method is set to raycast. More...
float	SearchDistance (int iIndex=0) const
	Returns the distance from the target mesh where the ray starts and ends. More...
void	SetSearchDistance (float fSearchDistance, int iIndex=0)
	Sets the distance from the target mesh where the ray should start and end. More...
bool	TestBothSides (int iIndex=0) const
	Returns true, if the ray-surface intersection should also check the back of the surface, not only the front. This is only valid if locate method is set to raycast. More...
void	SetTestBothSides (bool bBothSides, int iIndex=0)
	If bBothSides is true, turns checking of the back of the source surface on, when calculating the ray-surface intersection. This is only valid if locate method is set to raycast. More...
bool	PickLowestLevel (int iIndex=0) const
	Returns true, if the lowest level of the source sourfaces should be used for finding the ray-surface intersection point. More...
void	SetPickLowestLevel (bool bPickLowest, int iIndex=0)
	Turns picking the lowest level on or off. For more details, see PickLowestLevel(). More...
float	Tolerance (int iIndex=0) const
	Returns the current tolerance used when ray misses the surface near an open border. -1 means the tolerance is auto calculated from the mesh size. More...
void	SetTolerance (float fTolerance, int iIndex=0)
	Setss the tolerance used when ray misses the surface near an open border. More...
bool	Execute (bool bInterface=true)
	Executes the extraction. When bInterface is false, no gui will be displayed during the process, only the progress bar in the lower left corner. More...

Friends
MEADLL Extractor	CreateNewOperation (void)
	Creates a new extractor node. More...
MEADLL Extractor	OperationByIndex (int)
	Returns a given existing extractor node. More...

Constructor & Destructor Documentation

Extractor

(

mapextractionmodules::MapExtractor *

pExtractor

)

~Extractor

(

void

)

Member Function Documentation

mapextractionmodules::MapExtractor* ExtractorObject ( void  )

inline

Returns a pointer to the underlying map extractor object.

Definition at line 308 of file MapExtractorAPI.h.

{ return m_pMapExtractor; };

int SourceCount

(

void

)

const

Returns the number of source meshes.

mudbox::SubdivisionLevel* Source

(

int

iIndex

)

const

Returns the address of a source mesh for a given slot.

void SetSourceCount

(

int

iCount

)

Sets the number of source meshes.

Examples:

void SetSource	(	int	iIndex,
		mudbox::SubdivisionLevel *	pSource
	)

Assigns a pointer to a source slot.

Examples:

bool SourceSmoothing

(

void

)

const

Returns true, if the limit surface of the source meshes should be used.

void SetSourceSmoothing

(

bool

bSourceSmoothing

)

Sets smoothing on/off for source meshes.

Examples:

int TargetCount

(

void

)

const

Returns the number of target meshes.

mudbox::SubdivisionLevel* Target

(

int

iIndex

)

const

Retuns a pointer to a target mesh for a given slot.

void SetTargetCount

(

int

iCount

)

Sets the number of target meshes.

Examples:

void SetTarget	(	int	iIndex,
		mudbox::SubdivisionLevel *	pTarget
	)

Assigns a mesh pointer to a target mesh slot.

Examples:

bool TargetSmoothing

(

void

)

const

Returns true, if the limit surface of the target meshes should be used.

void SetTargetSmoothing

(

bool

bTargetSmoothing

)

Turns limit surface on/off for target meshes.

Examples:

bool TargetUVSmoothing

(

void

)

const

Returns true if UV of the target meshes should be smoothed.

void SetTargetUVSmoothing

(

bool

bSmoothUV

)

Turns UV smoothing on for the target meshes.

bool TargetCreases

(

void

)

const

Returns true if creasing should be used for the target meshes.

void SetTargetCreases

(

bool

bUse

)

Turns creasing on/off for the target meshes.

Examples:

void SetTangentGenerator

(

mudbox::TangentGenerator *

pTG

)

Sets a tangent generator, which will be used during extraction.

This generator will be deleted by the map extractor node, when the extraction is done.

enum UtilizerType UtilizerType

(

void

)

const

Returns the current utilizer type. This controls what the final result of the extraction will be, default is textures.

void SetUtilizerType

(

enum UtilizerType

eUtilizerType

)

Sets the utilizer type. This controls what the final result of the extraction will be, default is textures.

Examples:

int MapWidth

(

void

)

const

Returns the width of the generated textures. This is only valid when utilizer type is set to texture.

int MapHeight

(

void

)

const

Returns the height of the generated textures. This is only valid when utilizer type is set to texture.

void SetMapWidth

(

int

iWidth

)

Sets the width of the generated textures. This is only valid when utilizer type is set to texture.

Examples:

void SetMapHeight

(

int

iHeight

)

Sets the height of the generated textures. This is only valid when utilizer type is set to texture.

Examples:

enum Antialiasing Antialiasing

(

void

)

const

Returns the current anti-aliasing settings. Only valid when utilizer type is set to texture.

void SetAntialiasing

(

enum Antialiasing

eAntialiasing

)

Sets the current anti-aliasing settings. Only valid when utilizer type is set to texture.

Examples:

int EdgeBleeding

(

void

)

const

Returns the number of pixels used for edge bleeding. -1 means the bleed value set for texture painting is used.

void SetEdgeBleeding

(

int

iPixels

)

Sets the width of the bleed area in pixels.

-1 means the bleed value set for texture painting in the preferences is used. This parameter is not currently exposed on the UI, but can be set programmatically.

class DisplacementSampler DisplacementSampler

(

int

iIndex = 0

)

Returns the displacement sampler.

class VectorDisplacementSampler VectorDisplacementSampler

(

int

iIndex = 0

)

Returns the vector dispalcement sampler.

class NormalSampler NormalSampler

(

int

iIndex = 0

)

Returns the normal vector sampler.

class AmbientOcclusionSampler AmbientOcclusionSampler

(

int

iIndex = 0

)

Returns the ambient occlusion sampler.

class PaintLayerSampler PaintLayerSampler

(

int

iIndex = 0

)

Returns the paint layer sampler. This is not exposed on the UI currently, but can be used programmatically.

Examples:

class SculptLayerSampler SculptLayerSampler

(

int

iIndex = 0

)

Returns the sculpt layer sampler. This is not exposed on the UI currently, but can be used programmatically.

class Sampler DummySampler

(

int

iIndex = 0

)

Returns an empty sampler, which only outputs black color. This is not exposed on the UI currently, but can be used programmatically.

enum LocateMethod LocateMethod

(

int

iIndex = 0

)

const

Returns the current locate method.

void SetLocateMethod	(	enum LocateMethod	eLocateMethod,
		int	iIndex = 0
	)

Sets the current locate method. This controls how target surface points gets paired with source surface points.

Examples:

void SetLocateMeshes	(	QVector< mudbox::SubdivisionLevel * >	aInputs,
		QVector< mudbox::SubdivisionLevel * >	aOutputs,
		int	iIndex = 0
	)

Sets the input and output meshes for a locator. This should be called only if there mare more than one locators.

enum Sampling Sampling

(

int

iIndex = 0

)

const

Returns how the final intersection point is chosen, if there are multiple candidates. This is only valid if locate method is set to raycast.

void SetSampling	(	enum	Sampling,
		int	iIndex = 0
	)

Sets how the final intersection point is chosen, if there are multiple candidates. This is only valid if locate method is set to raycast.

Examples:

float SearchDistance

(

int

iIndex = 0

)

const

Returns the distance from the target mesh where the ray starts and ends.

The total length of the ray will be the double of this value. This is only valid if locate method is set to raycast.

void SetSearchDistance	(	float	fSearchDistance,
		int	iIndex = 0
	)

Sets the distance from the target mesh where the ray should start and end.

The total length of the ray will be the double of this value. This is only valid if locate method is set to raycast.

Examples:

bool TestBothSides

(

int

iIndex = 0

)

const

Returns true, if the ray-surface intersection should also check the back of the surface, not only the front. This is only valid if locate method is set to raycast.

void SetTestBothSides	(	bool	bBothSides,
		int	iIndex = 0
	)

If bBothSides is true, turns checking of the back of the source surface on, when calculating the ray-surface intersection. This is only valid if locate method is set to raycast.

Examples:

bool PickLowestLevel

(

int

iIndex = 0

)

const

Returns true, if the lowest level of the source sourfaces should be used for finding the ray-surface intersection point.

When the point is found, further calculation is done to find the matching point on the desired sudivision level of the source mesh. This is only valid if locate method is set to raycast. This is not exposed on the UI currently, but can be used programmatically.

void SetPickLowestLevel	(	bool	bPickLowest,
		int	iIndex = 0
	)

Turns picking the lowest level on or off. For more details, see PickLowestLevel().

float Tolerance

(

int

iIndex = 0

)

const

Returns the current tolerance used when ray misses the surface near an open border. -1 means the tolerance is auto calculated from the mesh size.

void SetTolerance	(	float	fTolerance,
		int	iIndex = 0
	)

Setss the tolerance used when ray misses the surface near an open border.

bool Execute

(

bool

bInterface = true

)

Executes the extraction. When bInterface is false, no gui will be displayed during the process, only the progress bar in the lower left corner.

Examples:

Friends And Related Function Documentation

MEADLL Extractor CreateNewOperation ( void  )

friend

Creates a new extractor node.

MEADLL Extractor OperationByIndex ( int  )

friend

Returns a given existing extractor node.

---

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

• MapExtractorAPI/MapExtractorAPI.h