DisplacementSampler Class Reference
#include <MapExtractorAPI.h>
Class Description
This class represents the displacement sampler.
Examples:
Definition at line 188 of file MapExtractorAPI.h.
Inheritance diagram for DisplacementSampler:
Public Member Functions | |
| bool | NormalizeToSearchDistance (void) const |
| Returns true, if the displacement values should be normalized to the search distance by Mudbox. This is only valid if locate method is set to raycast. More... | |
| void | SetNormalizeToSearchDistance (bool bNormalize) |
| When bNormalize is true, the displacement values will be normalized to the search distance by Mudbox. This is only valid if locate method is set to raycast. More... | |
| Public Member Functions inherited from Sampler | |
| 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... | |
Additional Inherited Members | |
| Protected Member Functions inherited from Sampler | |
| Sampler (void) | |
| Protected Attributes inherited from Sampler | |
| mudbox::aptr< mapextractionmodules::Sampler > | m_pSampler |
Member Function Documentation
| bool NormalizeToSearchDistance | ( | void | ) | const |
Returns true, if the displacement values should be normalized to the search distance by Mudbox. This is only valid if locate method is set to raycast.
| void SetNormalizeToSearchDistance | ( | bool | bNormalize | ) |
When bNormalize is true, the displacement values will be normalized to the search distance by Mudbox. This is only valid if locate method is set to raycast.
The documentation for this class was generated from the following file:
- MapExtractorAPI/MapExtractorAPI.h