Sampler Class Reference

#include <MapExtractorAPI.h>

Class Description

This class represents a sampler in map extraction, like Displacement, Ambient occlusion, etc...

Definition at line 126 of file MapExtractorAPI.h.

Inheritance diagram for Sampler:

Public Member Functions
	Sampler (mapextractionmodules::Sampler *p)
	Create a sampler class for an existing sampler module. More...
bool	IsEnabled (void) const
	Returns true, if the sampler is enabled. Only enabled samplers are used during extraction. More...
void	SetEnabled (bool bEnable)
	Turns a sampler on or off. Each sampler is disabled by default. At least one sampler has to be enalbed, otherwise the extraction does nothing. More...
enum VertexAction	VertexAction (void) const
	Returns the current vertex action. This is only valid if utilizer type is set to vertex. More...
void	SetVertexAction (enum VertexAction eAction)
	Sets the current vertex action. This is the action Mudbox performs on each vertex of the target mesh after the extraction. This is only valid if utilizer type is set to vertex. More...
QString	FileName (void) const
	Return the name of the file(s) produced by mudbox after map extraction. This is only valid if utilizer type is set to texture or ptex. More...
void	SetFileName (const QString &sFileName)
	Sets the name of the file(s) produced by mudbox after map extraction. More...
bool	UseTmpFile (void) const
	Returns true, if the image files are saved into a tmp location. More...
void	SetUseTmpFile (bool bTmp)
	When bTmp is true, the filename will be ignored, and a temporary file name and location will be used. More...
enum mudbox::Image::Format	PixelFormat (void) const
	Return the pixel format which will be used in the saved file. This is only valid if utilizer type is set to texture. More...
void	SetPixelFormat (enum mudbox::Image::Format eFormat)
	Sets the pixel format which will be used in the saved file. This is only valid if utilizer type is set to texture. More...
bool	Preview (void) const
	Return true if Mudbox should use the result texture as a preview in rendering. This is only valid if utilizer type is set to texture. More...
void	SetPreview (bool bEnable)
	Turns on/off preview in rendering after extraction. This is only valid if utilizer type is set to texture. More...
Space	VertexMoveSpace (void) const
	Returns the space what the vertex move action uses. This is only valid if utilizer type is set to vertex, and vertex action is set to move. Only the following spaces are used: world, object, tangent. More...
void	SetVertexMoveSpace (Space eSpace)
	Sets the space what the vertex move action uses. This is only valid if utilizer type is set to vertex, and vertex action is set to move. Only the following spaces are used: world, object, tangent. More...
mudbox::Vector	VertexFactor (void) const
void	SetVertexFactor (const mudbox::Vector &vFactor)
mudbox::Vector	VertexOffset (void) const
void	SetVertexOffset (const mudbox::Vector &vOffset)
QString	LayerNameForVertexAction (void) const
	Return the name of the layer which should be used as the target for the set sculpt layer mask action. This is only valid if utilizer type is set to vertex, and vertex action is set to vaSculptLayerMask. More...
void	SetLayerNameForVertexAction (const QString &sLayerName)
	Sets the name of the layer which should be used as the target for the set sculpt layer mask action. This is only valid if utilizer type is set to vertex, and vertex action is set to vaSculptLayerMask. More...
bool	RedirectToSculptLayer (void) const
	Returns true, if the result will be put into a new sculpt layer. This is only valid if utilizer type is set to vertex, and vertex actio is set to vaMove or vaDisplace. More...
void	SetRedirectToSculptLayer (bool bRedirect)
	Turns sculpt layer creation on/off. This is only valid if utilizer type is set to vertex, and vertex actio is set to vaMove or vaDisplace. More...
mudbox::Layer *	ResultLayer (void) const
	Returns the address of the layer created by the sampler. This should be called after the map extraction operation was executed. More...

Protected Member Functions
	Sampler (void)

Protected Attributes
mudbox::aptr< mapextractionmodules::Sampler >	m_pSampler

Friends
class	Extractor

Constructor & Destructor Documentation

Sampler ( void  )

protected

Sampler ( mapextractionmodules::Sampler *  p )

inline

Create a sampler class for an existing sampler module.

Definition at line 134 of file MapExtractorAPI.h.

{ m_pSampler = p; };

Member Function Documentation

bool IsEnabled ( void  ) const

inline

Returns true, if the sampler is enabled. Only enabled samplers are used during extraction.

Definition at line 136 of file MapExtractorAPI.h.

{ return m_pSampler->IsEnabled(); };

void SetEnabled ( bool  bEnable )

inline

Turns a sampler on or off. Each sampler is disabled by default. At least one sampler has to be enalbed, otherwise the extraction does nothing.

Examples:

Definition at line 138 of file MapExtractorAPI.h.

{ m_pSampler->SetEnabled( bEnable ); m_pSampler->Extractor()->ValidityChanged(); };

enum VertexAction VertexAction

(

void

)

const

Returns the current vertex action. This is only valid if utilizer type is set to vertex.

void SetVertexAction

(

enum VertexAction

eAction

)

Sets the current vertex action. This is the action Mudbox performs on each vertex of the target mesh after the extraction. This is only valid if utilizer type is set to vertex.

Examples:

QString FileName

(

void

)

const

Return the name of the file(s) produced by mudbox after map extraction. This is only valid if utilizer type is set to texture or ptex.

void SetFileName

(

const QString &

sFileName

)

Sets the name of the file(s) produced by mudbox after map extraction.

This is only valid if utilizer type is set to texture or ptex. When the utilizer type is set to texture, and the mesh has multiple tiles, the tile ID is encoded to the name of each image file generated.

Examples:

bool UseTmpFile

(

void

)

const

Returns true, if the image files are saved into a tmp location.

void SetUseTmpFile

(

bool

bTmp

)

When bTmp is true, the filename will be ignored, and a temporary file name and location will be used.

enum mudbox::Image::Format PixelFormat

(

void

)

const

Return the pixel format which will be used in the saved file. This is only valid if utilizer type is set to texture.

void SetPixelFormat

(

enum mudbox::Image::Format

eFormat

)

Sets the pixel format which will be used in the saved file. This is only valid if utilizer type is set to texture.

bool Preview

(

void

)

const

Return true if Mudbox should use the result texture as a preview in rendering. This is only valid if utilizer type is set to texture.

void SetPreview

(

bool

bEnable

)

Turns on/off preview in rendering after extraction. This is only valid if utilizer type is set to texture.

Space VertexMoveSpace

(

void

)

const

Returns the space what the vertex move action uses. This is only valid if utilizer type is set to vertex, and vertex action is set to move. Only the following spaces are used: world, object, tangent.

void SetVertexMoveSpace

(

Space

eSpace

)

Sets the space what the vertex move action uses. This is only valid if utilizer type is set to vertex, and vertex action is set to move. Only the following spaces are used: world, object, tangent.

Examples:

mudbox::Vector VertexFactor

(

void

)

const

void SetVertexFactor

(

const mudbox::Vector &

vFactor

)

Examples:

mudbox::Vector VertexOffset

(

void

)

const

void SetVertexOffset

(

const mudbox::Vector &

vOffset

)

Examples:

QString LayerNameForVertexAction

(

void

)

const

Return the name of the layer which should be used as the target for the set sculpt layer mask action. This is only valid if utilizer type is set to vertex, and vertex action is set to vaSculptLayerMask.

void SetLayerNameForVertexAction

(

const QString &

sLayerName

)

Sets the name of the layer which should be used as the target for the set sculpt layer mask action. This is only valid if utilizer type is set to vertex, and vertex action is set to vaSculptLayerMask.

Examples:

bool RedirectToSculptLayer

(

void

)

const

Returns true, if the result will be put into a new sculpt layer. This is only valid if utilizer type is set to vertex, and vertex actio is set to vaMove or vaDisplace.

void SetRedirectToSculptLayer

(

bool

bRedirect

)

Turns sculpt layer creation on/off. This is only valid if utilizer type is set to vertex, and vertex actio is set to vaMove or vaDisplace.

mudbox::Layer* ResultLayer

(

void

)

const

Returns the address of the layer created by the sampler. This should be called after the map extraction operation was executed.

Examples:

Friends And Related Function Documentation

friend class Extractor

friend

Definition at line 184 of file MapExtractorAPI.h.

Member Data Documentation

mudbox::aptr<mapextractionmodules::Sampler> m_pSampler

protected

Definition at line 130 of file MapExtractorAPI.h.

---

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

• MapExtractorAPI/MapExtractorAPI.h