Simplygon 9 Documentation

# class DisplacementCaster

DisplacementCaster is used to store the delta-values between the original and processed geometries. The values are divided by a scaling value, and clamped into the -1 -> 1 range before being stored into an image.

# Properties

Property Description
DestMaterialId The DestMaterialId object. If set, only the parts of the destination map that. To disable, set to -1.
MappingImage The MappingImage object. The MappingImage object contains the mapping between the Geometry and SourceGeometry objects.
OutputFilePath The OutputFilePath file path, where the output image will be placed. Note that the extension will be appended the file path if it differs from the OutputImageFileFormat set in the caster settings object. Either OutputImage or OutputFilePath must be set. If OutputImage is set, then OutputFilePath is ignored.
OutputImage The OutputImage object that will receive the image. The current contents of the image will be removed, and the image will be written to the Colors field of the ImageData object. Either OutputImage or OutputFilePath must be set. If OutputImage is set, then OutputFilePath is ignored.
SourceMaterials The SourceMaterials object. The SourceMaterials object contains all materials of the the source geometry. The source geometry must have a "MaterialIds" field that indices the material table.
SourceTextures The SourceTextures object. The SourceTextures object contains all textures of the the source geometry.

# Methods

Method Description
Clear Clear all internal states of the object. This will NOT clear the parameters set in the object.
GetClass Get the name of the DisplacementCaster class.
GetDisplacementCasterSettings The displacement caster settings object.
GetMaterialCasterSettings The settings object.
GetPercentDone Returns the current progress of the processing as a value between 0 and 100.
IsA Returns true if DisplacementCaster is a or is a descendant of the class named as the type parameter.
IsNull Returns true if the DisplacementCaster object is invalid.
RunProcessing Runs the processing the object is designed for.
ToJSON Get settings as JSON for debugging purposes.

# Static methods

Method Description
IsClassA Returns true if the class is a or is a descendant of the class named as the type parameter.
SafeCast SafeCast makes sure the input object is of a class that can be cast into spDisplacementCaster, and if this is the case, returns the object cast into spDisplacementCaster.

# Properties details

# DestMaterialId

The DestMaterialId object. If set, only the parts of the destination map that. To disable, set to -1.

# Syntax

// Setter
void SetDestMaterialId( rid value );

// Getter
rid GetDestMaterialId();

# SetDestMaterialId parameters

Type Name Min Max Description
rid value The value to which DestMaterialId will be set.

# GetDestMaterialId return value

Type: rid

# MappingImage

The MappingImage object. The MappingImage object contains the mapping between the Geometry and SourceGeometry objects.

# Syntax

// Setter
void SetMappingImage( spMappingImage value );

// Getter
spMappingImage GetMappingImage();

# SetMappingImage parameters

Type Name Min Max Description
MappingImage value The mapping image to which MappingImage will be set.

# GetMappingImage return value

Type: MappingImage

# OutputFilePath

The OutputFilePath file path, where the output image will be placed. Note that the extension will be appended the file path if it differs from the OutputImageFileFormat set in the caster settings object. Either OutputImage or OutputFilePath must be set. If OutputImage is set, then OutputFilePath is ignored.

# Syntax

// Setter
void SetOutputFilePath( const char * value );

// Getter
spString GetOutputFilePath();

# SetOutputFilePath parameters

Type Name Min Max Description
const char * value The string to which OutputFilePath will be set.

# GetOutputFilePath return value

Type: spString

# OutputImage

The OutputImage object that will receive the image. The current contents of the image will be removed, and the image will be written to the Colors field of the ImageData object. Either OutputImage or OutputFilePath must be set. If OutputImage is set, then OutputFilePath is ignored.

# Syntax

// Setter
void SetOutputImage( spImageData value );

// Getter
spImageData GetOutputImage();

# SetOutputImage parameters

Type Name Min Max Description
ImageData value The image data to which OutputImage will be set.

# GetOutputImage return value

Type: ImageData

# SourceMaterials

The SourceMaterials object. The SourceMaterials object contains all materials of the the source geometry. The source geometry must have a "MaterialIds" field that indices the material table.

# Syntax

// Setter
void SetSourceMaterials( spMaterialTable value );

// Getter
spMaterialTable GetSourceMaterials();

# SetSourceMaterials parameters

Type Name Min Max Description
MaterialTable value The material table to which SourceMaterials will be set.

# GetSourceMaterials return value

Type: MaterialTable

# SourceTextures

The SourceTextures object. The SourceTextures object contains all textures of the the source geometry.

# Syntax

// Setter
void SetSourceTextures( spTextureTable value );

// Getter
spTextureTable GetSourceTextures();

# SetSourceTextures parameters

Type Name Min Max Description
TextureTable value The texture table to which SourceTextures will be set.

# GetSourceTextures return value

Type: TextureTable

# Methods details

# Clear

Clear all internal states of the object. This will NOT clear the parameters set in the object.

# Syntax

void Clear();

# Parameters

Clear takes no parameters.

# GetClass

Get the name of the DisplacementCaster class.

# Syntax

spString GetClass();

# Parameters

GetClass takes no parameters.

# Return value

Type: spString

# GetDisplacementCasterSettings

The displacement caster settings object.

# Syntax

spDisplacementCasterSettings GetDisplacementCasterSettings();

# Parameters

GetDisplacementCasterSettings takes no parameters.

# Return value

Type: DisplacementCasterSettings

# GetMaterialCasterSettings

The settings object.

# Syntax

spMaterialCasterSettings GetMaterialCasterSettings();

# Parameters

GetMaterialCasterSettings takes no parameters.

# Return value

Type: MaterialCasterSettings

# GetPercentDone

Returns the current progress of the processing as a value between 0 and 100.

# Syntax

real GetPercentDone();

# Parameters

GetPercentDone takes no parameters.

# Return value

Type: real

# IsA

Returns true if DisplacementCaster is a or is a descendant of the class named as the type parameter.

# Syntax

bool IsA( const char * type );

# Parameters

Type Name Min Max Description
const char * type Name of the class to check if DisplacementCaster is, or is a descendant of.

# Return value

Type: bool

# IsNull

Returns true if the DisplacementCaster object is invalid.

# Syntax

bool IsNull();

# Parameters

IsNull takes no parameters.

# Return value

Type: bool

# RunProcessing

Runs the processing the object is designed for.

# Syntax

void RunProcessing();

# Parameters

RunProcessing takes no parameters.

# ToJSON

Get settings as JSON for debugging purposes.

# Syntax

spString ToJSON();

# Parameters

ToJSON takes no parameters.

# Return value

Type: spString

# Static methods details

# IsClassA

Returns true if the class is a or is a descendant of the class named as the type parameter.

# Syntax

static bool IsClassA( const char * type );

# Parameters

Type Name Min Max Description
const char * type Name of the class to check if the class is, or is a descendant of.

# Return value

Type: bool

# SafeCast

SafeCast makes sure the input object is of a class that can be cast into spDisplacementCaster, and if this is the case, returns the object cast into spDisplacementCaster.

# Syntax

static spDisplacementCaster SafeCast( spObject object );

# Parameters

Type Name Min Max Description
Object object Object to cast.

# Return value

Type: DisplacementCaster

← GeometryDataCaster →