class NormalSplatterCasterSettings

NormalSplatterCasterSettings is the interface for the settings of the normal splatter caster.

Properties

Property	Description
CalculateBitangentPerFragment	If set, the normal splatter caster calculates the bitangent used for encoding per-fragment using the normal, tangent and bitangent sign instead of interpolating the actual bitangent vertex data. This needs to match the behavior of the renderer to not produce rendering artifacts. Only used when OutputNormalSpace is Tangent.
CameraSelectionSetName	The name of the selection set for cameras which should be used. If not set, all cameras in the scene will be considered for splatter casting. Only cameras with valid scene render metadata will eventually be used. (Inherited from SplatterCasterSettings)
Dilation	The Dilation value. Where applicable, such as colors and normals, the caster will fill empty pixels surrounding filled pixels with values mixed from the filled ones. This setting sets how many pixels to fill outside the original filled pixels. (Inherited from MaterialCasterSettings)
DitherType	The type of dithering to use when creating the output object. (Inherited from MaterialCasterSettings)
FillMode	The fill mode determines what to do with the pixels that remain unfilled after both the casting and dilation has been performed. Options are: NoFill = Do not fill remaining pixels Interpolate = linearly interpolate the closest samples NearestNeighbor = use the closest available pixel value without interpolation. (Inherited from MaterialCasterSettings)
MaterialChannel	The name of the input material channel to cast. Existing user channels of any arbitrary name in the input materials can be cast. (Inherited from MaterialCasterSettings)
Name	The name of the NormalSplatterCasterSettings object. (Inherited from Object)
NormalizeInterpolatedTangentSpace	If set, the normal splatter caster normalizes the normal, tangent and bitangent data used for encoding after interpolation. This needs to match the behavior of the renderer to not produce rendering artifacts. Only used when OutputNormalSpace is Tangent.
OpacityChannel	The name of the input opacity channel to use for combining layers in most casters and casting opacity in the opacitycaster. User channels of any arbitrary name can be used. If the caster is run through a Pipeline object, the OpacityChannel set here will also be set as the output materials OpacityChannel property. (Inherited from MaterialCasterSettings)
OpacityChannelComponent	The component in the opacity channel to use as opacity value. (Inherited from MaterialCasterSettings)
OutputDDSCompressionType	DDS compression if output format is DDS. (Inherited from MaterialCasterSettings)
OutputFlipGreen	If set, the green channel of the output is assumed to point along the negative bitangent instead of the positive. This is roughly equivalent to switching between left- and righthanded tangent space normal maps. Only used when OutputNormalSpace is Tangent.
OutputImageFileFormat	File format for output texture. (Inherited from MaterialCasterSettings)
OutputNormalSpace	The space of the output normals. The splatted renders contain world-space normals, which must be in the same coordinate system as the scene. If the captures use a different coordinate system, for example left-handed Z-up captures for a scene exported as right-handed Y-up, the caller must convert them to the scene's coordinate system before splatting. Tangent and Global are supported. Tangent converts the normals into the tangent space of the destination geometry. Global outputs the world-space normals in scene space.
OutputPixelFormat	The output pixel format (Inherited from MaterialCasterSettings)
UseMultisampling	Enable or disable multisampling. (Inherited from MaterialCasterSettings)

Methods

Method	Description
AddObserver	Adds a user-defined observer object to the interface, that will receive events from the interface. (Inherited from Object)
GetBoolParameter	Get a named parameter boolean value. (Inherited from SettingsObject)
GetClass	Get the name of the NormalSplatterCasterSettings class. (Inherited from Object)
GetDoubleParameter	Get a named parameter floating point value. (Inherited from SettingsObject)
GetErrorString	Returns a string describing the error that was found the last time ValidateSettings was performed. (Inherited from SettingsObject)
GetIntParameter	Get a named parameter integer value. (Inherited from SettingsObject)
GetStringParameter	Get a named parameter string value. (Inherited from SettingsObject)
GetUIntParameter	Get a named parameter unsigned integer value. (Inherited from SettingsObject)
IsA	Returns true if NormalSplatterCasterSettings is a or is a descendant of the class named as the type parameter. (Inherited from Object)
IsNull	Returns true if the NormalSplatterCasterSettings object is invalid. (Inherited from Object)
IsSameObjectAs	Returns true if the NormalSplatterCasterSettings object is valid. (Inherited from Object)
NonNull	Returns true if the NormalSplatterCasterSettings object is valid. (Inherited from Object)
PrintInfo	Prints the content/info of the NormalSplatterCasterSettings object to the log. (Inherited from Object)
RemoveObserver	Removes a previously added observer object. (Inherited from Object)
SetBoolParameter	Set a named parameter boolean value. (Inherited from SettingsObject)
SetDoubleParameter	Set a named parameter floating point value. (Inherited from SettingsObject)
SetIntParameter	Set a named parameter integer value. (Inherited from SettingsObject)
SetStringParameter	Set a named parameter string value. (Inherited from SettingsObject)
SetUIntParameter	Set a named parameter unsigned integer value. (Inherited from SettingsObject)
SetValidateParameterNames	Set if parameter names should be validated or not. Parameters that previously do not exist will generate and error if validation is enabled and be allowed if validation is disabled. (Inherited from SettingsObject)
ToJSON	Get settings as JSON for debugging purposes. (Inherited from SettingsObject)
ValidateSettings	Validates the current settings values. (Inherited from SettingsObject)

Static methods

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

Properties details

CalculateBitangentPerFragment

If set, the normal splatter caster calculates the bitangent used for encoding per-fragment using the normal, tangent and bitangent sign instead of interpolating the actual bitangent vertex data. This needs to match the behavior of the renderer to not produce rendering artifacts. Only used when OutputNormalSpace is Tangent.

Syntax

// Setter
SGEXPERIMENTAL void SetCalculateBitangentPerFragment( bool value ) const;

// Getter
SGEXPERIMENTAL bool GetCalculateBitangentPerFragment() const;

SetCalculateBitangentPerFragment parameters

Type	Name	Min	Max	Description
bool	value			The value to set to.

GetCalculateBitangentPerFragment return value

Type: bool

Default: true

Syntax

// Setter
void SetCalculateBitangentPerFragment(bool value);

// Getter
bool GetCalculateBitangentPerFragment();

SetCalculateBitangentPerFragment parameters

Type	Name	Min	Max	Description
bool	value			The value to set to.

GetCalculateBitangentPerFragment return value

Type: bool

Default: true

Syntax

# Setter
None SetCalculateBitangentPerFragment(value: bool)

# Getter
bool GetCalculateBitangentPerFragment()

SetCalculateBitangentPerFragment parameters

Name	Type	Min	Max	Description
value	bool			The value to set to.

GetCalculateBitangentPerFragment return value

Type: bool

Default: true

CameraSelectionSetName

The name of the selection set for cameras which should be used. If not set, all cameras in the scene will be considered for splatter casting. Only cameras with valid scene render metadata will eventually be used.

Syntax

// Setter
SGEXPERIMENTAL void SetCameraSelectionSetName( const char * value ) const;

// Getter
SGEXPERIMENTAL spString GetCameraSelectionSetName() const;

SetCameraSelectionSetName parameters

Type	Name	Min	Max	Description
const char *	value			The value to set to.

GetCameraSelectionSetName return value

Type: spString

Syntax

// Setter
void SetCameraSelectionSetName(string value);

// Getter
string GetCameraSelectionSetName();

SetCameraSelectionSetName parameters

Type	Name	Min	Max	Description
string	value			The value to set to.

GetCameraSelectionSetName return value

Type: string

Syntax

# Setter
None SetCameraSelectionSetName(value: str)

# Getter
str GetCameraSelectionSetName()

SetCameraSelectionSetName parameters

Name	Type	Min	Max	Description
value	str			The value to set to.

GetCameraSelectionSetName return value

Type: str

Dilation

The Dilation value. Where applicable, such as colors and normals, the caster will fill empty pixels surrounding filled pixels with values mixed from the filled ones. This setting sets how many pixels to fill outside the original filled pixels.

Syntax

// Setter
SGEXPERIMENTAL void SetDilation( unsigned int value ) const;

// Getter
SGEXPERIMENTAL unsigned int GetDilation() const;

SetDilation parameters

Type	Name	Min	Max	Description
unsigned int	value	0	1000	The value to which Dilation will be set.

GetDilation return value

Type: unsigned int

Default: 10

Syntax

// Setter
void SetDilation(uint value);

// Getter
uint GetDilation();

SetDilation parameters

Type	Name	Min	Max	Description
uint	value	0	1000	The value to which Dilation will be set.

GetDilation return value

Type: uint

Default: 10

Syntax

# Setter
None SetDilation(value: int)

# Getter
int GetDilation()

SetDilation parameters

Name	Type	Min	Max	Description
value	int	0	1000	The value to which Dilation will be set.

GetDilation return value

Type: int

Default: 10

DitherType

The type of dithering to use when creating the output object.

Syntax

// Setter
SGEXPERIMENTAL void SetDitherType( Simplygon::EDitherPatterns value ) const;

// Getter
SGEXPERIMENTAL Simplygon::EDitherPatterns GetDitherType() const;

SetDitherType parameters

Type	Name	Min	Max	Description
EDitherPatterns	value			The desired value of the DitherType to use.

GetDitherType return value

Type: EDitherPatterns

Default: FloydSteinberg

Key	Value	Comment
NoDither	0	Use no dithering
FloydSteinberg	1	Use Floyd-Steinberg dithering
JarvisJudiceNinke	2	Use Jarvis, Judice, and Ninke dithering
Sierra	3	Use Sierra-3 (three row) dithering

Syntax

// Setter
void SetDitherType(EDitherPatterns value);

// Getter
EDitherPatterns GetDitherType();

SetDitherType parameters

Type	Name	Min	Max	Description
EDitherPatterns	value			The desired value of the DitherType to use.

GetDitherType return value

Type: EDitherPatterns

Default: FloydSteinberg

Key	Value	Comment
NoDither	0	Use no dithering
FloydSteinberg	1	Use Floyd-Steinberg dithering
JarvisJudiceNinke	2	Use Jarvis, Judice, and Ninke dithering
Sierra	3	Use Sierra-3 (three row) dithering

Syntax

# Setter
None SetDitherType(value: EDitherPatterns_*)

# Getter
EDitherPatterns_* GetDitherType()

SetDitherType parameters

Name	Type	Min	Max	Description
value	EDitherPatterns			The desired value of the DitherType to use.

GetDitherType return value

Type: EDitherPatterns

Default: FloydSteinberg

Key	Value	Comment
EDitherPatterns_NoDither	0	Use no dithering
EDitherPatterns_FloydSteinberg	1	Use Floyd-Steinberg dithering
EDitherPatterns_JarvisJudiceNinke	2	Use Jarvis, Judice, and Ninke dithering
EDitherPatterns_Sierra	3	Use Sierra-3 (three row) dithering

FillMode

The fill mode determines what to do with the pixels that remain unfilled after both the casting and dilation has been performed. Options are: NoFill = Do not fill remaining pixels Interpolate = linearly interpolate the closest samples NearestNeighbor = use the closest available pixel value without interpolation.

Syntax

// Setter
SGEXPERIMENTAL void SetFillMode( Simplygon::EAtlasFillMode value ) const;

// Getter
SGEXPERIMENTAL Simplygon::EAtlasFillMode GetFillMode() const;

SetFillMode parameters

Type	Name	Min	Max	Description
EAtlasFillMode	value			The mode to which the fill mode will be set.

GetFillMode return value

Type: EAtlasFillMode

Default: Interpolate

Key	Value	Comment
Interpolate	0	linearly interpolate the closest samples
NearestNeighbor	1	use the closest available pixel value without interpolation
NoFill	2	Do not fill remaining pixels
InterpolateRGBZeroAlpha	3	linearly interpolate the closest samples for the R, G & B channels, and set A to 0. Note that this mode is identical to 'Interpolate' for non-RGBA output images.
NearestNeighborRGBZeroAlpha	4	use the closest available pixel value without interpolation for the R, G & B channels, and set A to 0. Note that this mode is identical to 'NearestNeighbor' for non-RGBA output images.

Syntax

// Setter
void SetFillMode(EAtlasFillMode value);

// Getter
EAtlasFillMode GetFillMode();

SetFillMode parameters

Type	Name	Min	Max	Description
EAtlasFillMode	value			The mode to which the fill mode will be set.

GetFillMode return value

Type: EAtlasFillMode

Default: Interpolate

Key	Value	Comment
Interpolate	0	linearly interpolate the closest samples
NearestNeighbor	1	use the closest available pixel value without interpolation
NoFill	2	Do not fill remaining pixels
InterpolateRGBZeroAlpha	3	linearly interpolate the closest samples for the R, G & B channels, and set A to 0. Note that this mode is identical to 'Interpolate' for non-RGBA output images.
NearestNeighborRGBZeroAlpha	4	use the closest available pixel value without interpolation for the R, G & B channels, and set A to 0. Note that this mode is identical to 'NearestNeighbor' for non-RGBA output images.

Syntax

# Setter
None SetFillMode(value: EAtlasFillMode_*)

# Getter
EAtlasFillMode_* GetFillMode()

SetFillMode parameters

Name	Type	Min	Max	Description
value	EAtlasFillMode			The mode to which the fill mode will be set.

GetFillMode return value

Type: EAtlasFillMode

Default: Interpolate

Key	Value	Comment
EAtlasFillMode_Interpolate	0	linearly interpolate the closest samples
EAtlasFillMode_NearestNeighbor	1	use the closest available pixel value without interpolation
EAtlasFillMode_NoFill	2	Do not fill remaining pixels
EAtlasFillMode_InterpolateRGBZeroAlpha	3	linearly interpolate the closest samples for the R, G & B channels, and set A to 0. Note that this mode is identical to 'Interpolate' for non-RGBA output images.
EAtlasFillMode_NearestNeighborRGBZeroAlpha	4	use the closest available pixel value without interpolation for the R, G & B channels, and set A to 0. Note that this mode is identical to 'NearestNeighbor' for non-RGBA output images.

MaterialChannel

The name of the input material channel to cast. Existing user channels of any arbitrary name in the input materials can be cast.

Syntax

// Setter
SGEXPERIMENTAL void SetMaterialChannel( const char * value ) const;

// Getter
SGEXPERIMENTAL spString GetMaterialChannel() const;

SetMaterialChannel parameters

Type	Name	Min	Max	Description
const char *	value			The input material channel name.

GetMaterialChannel return value

Type: spString

Default: nullptr

Syntax

// Setter
void SetMaterialChannel(string value);

// Getter
string GetMaterialChannel();

SetMaterialChannel parameters

Type	Name	Min	Max	Description
string	value			The input material channel name.

GetMaterialChannel return value

Type: string

Default: null

Syntax

# Setter
None SetMaterialChannel(value: str)

# Getter
str GetMaterialChannel()

SetMaterialChannel parameters

Name	Type	Min	Max	Description
value	str			The input material channel name.

GetMaterialChannel return value

Type: str

Default: None

Name

The name of the NormalSplatterCasterSettings object. (Inherited from Object)

Syntax

// Setter
SGEXPERIMENTAL void SetName( const char * name ) const;

// Getter
SGEXPERIMENTAL spString GetName() const;

SetName parameters

Type	Name	Min	Max	Description
const char *	name			New name of the object.

GetName return value

Type: spString

Syntax

// Setter
void SetName(string name);

// Getter
string GetName();

SetName parameters

Type	Name	Min	Max	Description
string	name			New name of the object.

GetName return value

Type: string

Syntax

# Setter
None SetName(name: str)

# Getter
str GetName()

SetName parameters

Name	Type	Min	Max	Description
name	str			New name of the object.

GetName return value

Type: str

NormalizeInterpolatedTangentSpace

If set, the normal splatter caster normalizes the normal, tangent and bitangent data used for encoding after interpolation. This needs to match the behavior of the renderer to not produce rendering artifacts. Only used when OutputNormalSpace is Tangent.

Syntax

// Setter
SGEXPERIMENTAL void SetNormalizeInterpolatedTangentSpace( bool value ) const;

// Getter
SGEXPERIMENTAL bool GetNormalizeInterpolatedTangentSpace() const;

SetNormalizeInterpolatedTangentSpace parameters

Type	Name	Min	Max	Description
bool	value			The value to set to.

GetNormalizeInterpolatedTangentSpace return value

Type: bool

Default: false

Syntax

// Setter
void SetNormalizeInterpolatedTangentSpace(bool value);

// Getter
bool GetNormalizeInterpolatedTangentSpace();

SetNormalizeInterpolatedTangentSpace parameters

Type	Name	Min	Max	Description
bool	value			The value to set to.

GetNormalizeInterpolatedTangentSpace return value

Type: bool

Default: false

Syntax

# Setter
None SetNormalizeInterpolatedTangentSpace(value: bool)

# Getter
bool GetNormalizeInterpolatedTangentSpace()

SetNormalizeInterpolatedTangentSpace parameters

Name	Type	Min	Max	Description
value	bool			The value to set to.

GetNormalizeInterpolatedTangentSpace return value

Type: bool

Default: false

OpacityChannel

The name of the input opacity channel to use for combining layers in most casters and casting opacity in the opacitycaster. User channels of any arbitrary name can be used. If the caster is run through a Pipeline object, the OpacityChannel set here will also be set as the output materials OpacityChannel property.

Syntax

// Setter
SGEXPERIMENTAL void SetOpacityChannel( const char * value ) const;

// Getter
SGEXPERIMENTAL spString GetOpacityChannel() const;

SetOpacityChannel parameters

Type	Name	Min	Max	Description
const char *	value			The desired material channel.

GetOpacityChannel return value

Type: spString

Default: Opacity

Syntax

// Setter
void SetOpacityChannel(string value);

// Getter
string GetOpacityChannel();

SetOpacityChannel parameters

Type	Name	Min	Max	Description
string	value			The desired material channel.

GetOpacityChannel return value

Type: string

Default: Opacity

Syntax

# Setter
None SetOpacityChannel(value: str)

# Getter
str GetOpacityChannel()

SetOpacityChannel parameters

Name	Type	Min	Max	Description
value	str			The desired material channel.

GetOpacityChannel return value

Type: str

Default: Opacity

OpacityChannelComponent

The component in the opacity channel to use as opacity value.

Syntax

// Setter
SGEXPERIMENTAL void SetOpacityChannelComponent( Simplygon::EColorComponent value ) const;

// Getter
SGEXPERIMENTAL Simplygon::EColorComponent GetOpacityChannelComponent() const;

SetOpacityChannelComponent parameters

Type	Name	Min	Max	Description
EColorComponent	value			The desired component in the opacity material channel to use as opacity value.

GetOpacityChannelComponent return value

Type: EColorComponent

Default: Red

Key	Value	Comment
Red	0	Red color component
Green	1	Green color component
Blue	2	Blue color component
Alpha	3	Alpha color component

Syntax

// Setter
void SetOpacityChannelComponent(EColorComponent value);

// Getter
EColorComponent GetOpacityChannelComponent();

SetOpacityChannelComponent parameters

Type	Name	Min	Max	Description
EColorComponent	value			The desired component in the opacity material channel to use as opacity value.

GetOpacityChannelComponent return value

Type: EColorComponent

Default: Red

Key	Value	Comment
Red	0	Red color component
Green	1	Green color component
Blue	2	Blue color component
Alpha	3	Alpha color component

Syntax

# Setter
None SetOpacityChannelComponent(value: EColorComponent_*)

# Getter
EColorComponent_* GetOpacityChannelComponent()

SetOpacityChannelComponent parameters

Name	Type	Min	Max	Description
value	EColorComponent			The desired component in the opacity material channel to use as opacity value.

GetOpacityChannelComponent return value

Type: EColorComponent

Default: Red

Key	Value	Comment
EColorComponent_Red	0	Red color component
EColorComponent_Green	1	Green color component
EColorComponent_Blue	2	Blue color component
EColorComponent_Alpha	3	Alpha color component

OutputDDSCompressionType

DDS compression if output format is DDS.

Syntax

// Setter
SGEXPERIMENTAL void SetOutputDDSCompressionType( Simplygon::EDDSCompressionType value ) const;

// Getter
SGEXPERIMENTAL Simplygon::EDDSCompressionType GetOutputDDSCompressionType() const;

SetOutputDDSCompressionType parameters

Type	Name	Min	Max	Description
EDDSCompressionType	value			The desired DDS compression type.

GetOutputDDSCompressionType return value

Type: EDDSCompressionType

Default: NoCompression

Key	Value	Comment
NoCompression	-1	No compression
BC1	0	BC1 compression
BC2	1	BC2 compression
BC3	2	BC3 compression
BC4	3	BC4 compression
BC5	4	BC5 compression

Syntax

// Setter
void SetOutputDDSCompressionType(EDDSCompressionType value);

// Getter
EDDSCompressionType GetOutputDDSCompressionType();

SetOutputDDSCompressionType parameters

Type	Name	Min	Max	Description
EDDSCompressionType	value			The desired DDS compression type.

GetOutputDDSCompressionType return value

Type: EDDSCompressionType

Default: NoCompression

Key	Value	Comment
NoCompression	-1	No compression
BC1	0	BC1 compression
BC2	1	BC2 compression
BC3	2	BC3 compression
BC4	3	BC4 compression
BC5	4	BC5 compression

Syntax

# Setter
None SetOutputDDSCompressionType(value: EDDSCompressionType_*)

# Getter
EDDSCompressionType_* GetOutputDDSCompressionType()

SetOutputDDSCompressionType parameters

Name	Type	Min	Max	Description
value	EDDSCompressionType			The desired DDS compression type.

GetOutputDDSCompressionType return value

Type: EDDSCompressionType

Default: NoCompression

Key	Value	Comment
EDDSCompressionType_NoCompression	-1	No compression
EDDSCompressionType_BC1	0	BC1 compression
EDDSCompressionType_BC2	1	BC2 compression
EDDSCompressionType_BC3	2	BC3 compression
EDDSCompressionType_BC4	3	BC4 compression
EDDSCompressionType_BC5	4	BC5 compression

OutputFlipGreen

If set, the green channel of the output is assumed to point along the negative bitangent instead of the positive. This is roughly equivalent to switching between left- and righthanded tangent space normal maps. Only used when OutputNormalSpace is Tangent.

Syntax

// Setter
SGEXPERIMENTAL void SetOutputFlipGreen( bool value ) const;

// Getter
SGEXPERIMENTAL bool GetOutputFlipGreen() const;

SetOutputFlipGreen parameters

Type	Name	Min	Max	Description
bool	value			The value to set to.

GetOutputFlipGreen return value

Type: bool

Default: false

Syntax

// Setter
void SetOutputFlipGreen(bool value);

// Getter
bool GetOutputFlipGreen();

SetOutputFlipGreen parameters

Type	Name	Min	Max	Description
bool	value			The value to set to.

GetOutputFlipGreen return value

Type: bool

Default: false

Syntax

# Setter
None SetOutputFlipGreen(value: bool)

# Getter
bool GetOutputFlipGreen()

SetOutputFlipGreen parameters

Name	Type	Min	Max	Description
value	bool			The value to set to.

GetOutputFlipGreen return value

Type: bool

Default: false

OutputImageFileFormat

File format for output texture.

Syntax

// Setter
SGEXPERIMENTAL void SetOutputImageFileFormat( Simplygon::EImageOutputFormat value ) const;

// Getter
SGEXPERIMENTAL Simplygon::EImageOutputFormat GetOutputImageFileFormat() const;

SetOutputImageFileFormat parameters

Type	Name	Min	Max	Description
EImageOutputFormat	value			The desired file format.

GetOutputImageFileFormat return value

Type: EImageOutputFormat

Default: PNG

Key	Value	Comment
BMP	0	Bitmap image
DDS	1	Direct Draw Surface
JPEG	2	Joint Photographic Experts Group image
PNG	3	Portable Network Graphics image
TGA	4	TARGA image file format
TIFF	5	Tagged Image File Format
EXR	8	OpenEXR image

Syntax

// Setter
void SetOutputImageFileFormat(EImageOutputFormat value);

// Getter
EImageOutputFormat GetOutputImageFileFormat();

SetOutputImageFileFormat parameters

Type	Name	Min	Max	Description
EImageOutputFormat	value			The desired file format.

GetOutputImageFileFormat return value

Type: EImageOutputFormat

Default: PNG

Key	Value	Comment
BMP	0	Bitmap image
DDS	1	Direct Draw Surface
JPEG	2	Joint Photographic Experts Group image
PNG	3	Portable Network Graphics image
TGA	4	TARGA image file format
TIFF	5	Tagged Image File Format
EXR	8	OpenEXR image

Syntax

# Setter
None SetOutputImageFileFormat(value: EImageOutputFormat_*)

# Getter
EImageOutputFormat_* GetOutputImageFileFormat()

SetOutputImageFileFormat parameters

Name	Type	Min	Max	Description
value	EImageOutputFormat			The desired file format.

GetOutputImageFileFormat return value

Type: EImageOutputFormat

Default: PNG

Key	Value	Comment
EImageOutputFormat_BMP	0	Bitmap image
EImageOutputFormat_DDS	1	Direct Draw Surface
EImageOutputFormat_JPEG	2	Joint Photographic Experts Group image
EImageOutputFormat_PNG	3	Portable Network Graphics image
EImageOutputFormat_TGA	4	TARGA image file format
EImageOutputFormat_TIFF	5	Tagged Image File Format
EImageOutputFormat_EXR	8	OpenEXR image

OutputNormalSpace

The space of the output normals. The splatted renders contain world-space normals, which must be in the same coordinate system as the scene. If the captures use a different coordinate system, for example left-handed Z-up captures for a scene exported as right-handed Y-up, the caller must convert them to the scene's coordinate system before splatting. Tangent and Global are supported. Tangent converts the normals into the tangent space of the destination geometry. Global outputs the world-space normals in scene space.

Syntax

// Setter
SGEXPERIMENTAL void SetOutputNormalSpace( Simplygon::ETransformationSpace value ) const;

// Getter
SGEXPERIMENTAL Simplygon::ETransformationSpace GetOutputNormalSpace() const;

SetOutputNormalSpace parameters

Type	Name	Min	Max	Description
ETransformationSpace	value			The value to set to.

GetOutputNormalSpace return value

Type: ETransformationSpace

Default: Tangent

Key	Value	Comment
Global	0	Transformation in scene global space
Local	1	Transformation in object/geometry local space
Tangent	2	Transformation in vertex/triangle tangent space
View	3	Transformation in view/camera space

Syntax

// Setter
void SetOutputNormalSpace(ETransformationSpace value);

// Getter
ETransformationSpace GetOutputNormalSpace();

SetOutputNormalSpace parameters

Type	Name	Min	Max	Description
ETransformationSpace	value			The value to set to.

GetOutputNormalSpace return value

Type: ETransformationSpace

Default: Tangent

Key	Value	Comment
Global	0	Transformation in scene global space
Local	1	Transformation in object/geometry local space
Tangent	2	Transformation in vertex/triangle tangent space
View	3	Transformation in view/camera space

Syntax

# Setter
None SetOutputNormalSpace(value: ETransformationSpace_*)

# Getter
ETransformationSpace_* GetOutputNormalSpace()

SetOutputNormalSpace parameters

Name	Type	Min	Max	Description
value	ETransformationSpace			The value to set to.

GetOutputNormalSpace return value

Type: ETransformationSpace

Default: Tangent

Key	Value	Comment
ETransformationSpace_Global	0	Transformation in scene global space
ETransformationSpace_Local	1	Transformation in object/geometry local space
ETransformationSpace_Tangent	2	Transformation in vertex/triangle tangent space
ETransformationSpace_View	3	Transformation in view/camera space

OutputPixelFormat

The output pixel format

Syntax

// Setter
SGEXPERIMENTAL void SetOutputPixelFormat( Simplygon::EPixelFormat value ) const;

// Getter
SGEXPERIMENTAL Simplygon::EPixelFormat GetOutputPixelFormat() const;

SetOutputPixelFormat parameters

Type	Name	Min	Max	Description
EPixelFormat	value			The desired value to which OutputChannels will be set.

GetOutputPixelFormat return value

Type: EPixelFormat

Default: R8G8B8A8

Key	Value	Comment
R8G8B8A8	0	RGBA color channels with 8 bit depth per color channel
R8G8B8	1	RGB color channels with 8 bit depth per color channel
R8	2	R color channel with 8 bit depth per color channel
R16G16B16A16	3	RGBA color channels with 16 bit depth per color channel
R16G16B16	4	RGB color channels with 16 bit depth per color channel
R16	5	R color channel with 16 bit depth per color channel
R32G32B32A32F	6	RGBA color channels with 32 bit depth floating point per color channel

Syntax

// Setter
void SetOutputPixelFormat(EPixelFormat value);

// Getter
EPixelFormat GetOutputPixelFormat();

SetOutputPixelFormat parameters

Type	Name	Min	Max	Description
EPixelFormat	value			The desired value to which OutputChannels will be set.

GetOutputPixelFormat return value

Type: EPixelFormat

Default: R8G8B8A8

Key	Value	Comment
R8G8B8A8	0	RGBA color channels with 8 bit depth per color channel
R8G8B8	1	RGB color channels with 8 bit depth per color channel
R8	2	R color channel with 8 bit depth per color channel
R16G16B16A16	3	RGBA color channels with 16 bit depth per color channel
R16G16B16	4	RGB color channels with 16 bit depth per color channel
R16	5	R color channel with 16 bit depth per color channel
R32G32B32A32F	6	RGBA color channels with 32 bit depth floating point per color channel

Syntax

# Setter
None SetOutputPixelFormat(value: EPixelFormat_*)

# Getter
EPixelFormat_* GetOutputPixelFormat()

SetOutputPixelFormat parameters

Name	Type	Min	Max	Description
value	EPixelFormat			The desired value to which OutputChannels will be set.

GetOutputPixelFormat return value

Type: EPixelFormat

Default: R8G8B8A8

Key	Value	Comment
EPixelFormat_R8G8B8A8	0	RGBA color channels with 8 bit depth per color channel
EPixelFormat_R8G8B8	1	RGB color channels with 8 bit depth per color channel
EPixelFormat_R8	2	R color channel with 8 bit depth per color channel
EPixelFormat_R16G16B16A16	3	RGBA color channels with 16 bit depth per color channel
EPixelFormat_R16G16B16	4	RGB color channels with 16 bit depth per color channel
EPixelFormat_R16	5	R color channel with 16 bit depth per color channel
EPixelFormat_R32G32B32A32F	6	RGBA color channels with 32 bit depth floating point per color channel

UseMultisampling

Enable or disable multisampling.

Syntax

// Setter
SGEXPERIMENTAL void SetUseMultisampling( bool value ) const;

// Getter
SGEXPERIMENTAL bool GetUseMultisampling() const;

SetUseMultisampling parameters

Type	Name	Min	Max	Description
bool	value			The desired value of the flag.

GetUseMultisampling return value

Type: bool

Default: true

Syntax

// Setter
void SetUseMultisampling(bool value);

// Getter
bool GetUseMultisampling();

SetUseMultisampling parameters

Type	Name	Min	Max	Description
bool	value			The desired value of the flag.

GetUseMultisampling return value

Type: bool

Default: true

Syntax

# Setter
None SetUseMultisampling(value: bool)

# Getter
bool GetUseMultisampling()

SetUseMultisampling parameters

Name	Type	Min	Max	Description
value	bool			The desired value of the flag.

GetUseMultisampling return value

Type: bool

Default: true

Methods details

AddObserver

Adds a user-defined observer object to the interface, that will receive events from the interface. (Inherited from Object)

Syntax

SGEXPERIMENTAL rid AddObserver( const spObserver & observer ) const;

Parameters

Type	Name	Min	Max	Description
Observer	observer			Observer is the object that will receive events.

Return value

Type: rid

Syntax

int AddObserver(spObserver observer);

Parameters

Type	Name	Min	Max	Description
Observer	observer			Observer is the object that will receive events.

Return value

Type: int

Syntax

int AddObserver(observer: spObserver)

Parameters

Name	Type	Min	Max	Description
observer	Observer			Observer is the object that will receive events.

Return value

Type: int

GetBoolParameter

Get a named parameter boolean value.

Syntax

SGEXPERIMENTAL bool GetBoolParameter( const char * name ) const;

Parameters

Type	Name	Min	Max	Description
const char *	name			Parameter name.

Return value

Type: bool

Syntax

bool GetBoolParameter(string name);

Parameters

Type	Name	Min	Max	Description
string	name			Parameter name.

Return value

Type: bool

Syntax

bool GetBoolParameter(name: str)

Parameters

Name	Type	Min	Max	Description
name	str			Parameter name.

Return value

Type: bool

GetClass

Get the name of the NormalSplatterCasterSettings class. (Inherited from Object)

Syntax

SGEXPERIMENTAL spString GetClass() const;

Parameters

GetClass takes no parameters.

Return value

Type: spString

Syntax

string GetClass();

Parameters

GetClass takes no parameters.

Return value

Type: string

Syntax

str GetClass()

Parameters

GetClass takes no parameters.

Return value

Type: str

GetDoubleParameter

Get a named parameter floating point value.

Syntax

SGEXPERIMENTAL double GetDoubleParameter( const char * name ) const;

Parameters

Type	Name	Min	Max	Description
const char *	name			Parameter name.

Return value

Type: double

Syntax

double GetDoubleParameter(string name);

Parameters

Type	Name	Min	Max	Description
string	name			Parameter name.

Return value

Type: double

Syntax

float GetDoubleParameter(name: str)

Parameters

Name	Type	Min	Max	Description
name	str			Parameter name.

Return value

Type: float

GetErrorString

Returns a string describing the error that was found the last time ValidateSettings was performed.

Syntax

SGEXPERIMENTAL spString GetErrorString() const;

Parameters

GetErrorString takes no parameters.

Return value

Type: spString

Syntax

string GetErrorString();

Parameters

GetErrorString takes no parameters.

Return value

Type: string

Syntax

str GetErrorString()

Parameters

GetErrorString takes no parameters.

Return value

Type: str

GetIntParameter

Get a named parameter integer value.

Syntax

SGEXPERIMENTAL int GetIntParameter( const char * name ) const;

Parameters

Type	Name	Min	Max	Description
const char *	name			Parameter name.

Return value

Type: int

Syntax

int GetIntParameter(string name);

Parameters

Type	Name	Min	Max	Description
string	name			Parameter name.

Return value

Type: int

Syntax

int GetIntParameter(name: str)

Parameters

Name	Type	Min	Max	Description
name	str			Parameter name.

Return value

Type: int

GetStringParameter

Get a named parameter string value.

Syntax

SGEXPERIMENTAL spString GetStringParameter( const char * name ) const;

Parameters

Type	Name	Min	Max	Description
const char *	name			Parameter name.

Return value

Type: spString

Syntax

string GetStringParameter(string name);

Parameters

Type	Name	Min	Max	Description
string	name			Parameter name.

Return value

Type: string

Syntax

str GetStringParameter(name: str)

Parameters

Name	Type	Min	Max	Description
name	str			Parameter name.

Return value

Type: str

GetUIntParameter

Get a named parameter unsigned integer value.

Syntax

SGEXPERIMENTAL unsigned int GetUIntParameter( const char * name ) const;

Parameters

Type	Name	Min	Max	Description
const char *	name			Parameter name.

Return value

Type: unsigned int

Syntax

uint GetUIntParameter(string name);

Parameters

Type	Name	Min	Max	Description
string	name			Parameter name.

Return value

Type: uint

Syntax

int GetUIntParameter(name: str)

Parameters

Name	Type	Min	Max	Description
name	str			Parameter name.

Return value

Type: int

IsA

Returns true if NormalSplatterCasterSettings is a or is a descendant of the class named as the type parameter. (Inherited from Object)

Syntax

SGEXPERIMENTAL bool IsA( const char * type ) const;

Parameters

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

Return value

Type: bool

Syntax

bool IsA(string type);

Parameters

Type	Name	Min	Max	Description
string	type			Name of the class to check if NormalSplatterCasterSettings is, or is a descendant of.

Return value

Type: bool

Syntax

bool IsA(type: str)

Parameters

Name	Type	Min	Max	Description
type	str			Name of the class to check if NormalSplatterCasterSettings is, or is a descendant of.

Return value

Type: bool

IsNull

Returns true if the NormalSplatterCasterSettings object is invalid. (Inherited from Object)

Syntax

SGEXPERIMENTAL bool IsNull() const;

Parameters

IsNull takes no parameters.

Return value

Type: bool

Syntax

bool IsNull();

Parameters

IsNull takes no parameters.

Return value

Type: bool

Syntax

bool IsNull()

Parameters

IsNull takes no parameters.

Return value

Type: bool

IsSameObjectAs

Returns true if the NormalSplatterCasterSettings object is valid. (Inherited from Object)

Syntax

SGEXPERIMENTAL bool IsSameObjectAs( const spObject & object ) const;

Parameters

Type	Name	Min	Max	Description
Object	object			Object to compare with.

Return value

Type: bool

Syntax

bool IsSameObjectAs(spObject object);

Parameters

Type	Name	Min	Max	Description
Object	object			Object to compare with.

Return value

Type: bool

Syntax

bool IsSameObjectAs(object: spObject)

Parameters

Name	Type	Min	Max	Description
object	Object			Object to compare with.

Return value

Type: bool

NonNull

Returns true if the NormalSplatterCasterSettings object is valid. (Inherited from Object)

Syntax

SGEXPERIMENTAL bool NonNull() const;

Parameters

NonNull takes no parameters.

Return value

Type: bool

Syntax

bool NonNull();

Parameters

NonNull takes no parameters.

Return value

Type: bool

Syntax

bool NonNull()

Parameters

NonNull takes no parameters.

Return value

Type: bool

PrintInfo

Prints the content/info of the NormalSplatterCasterSettings object to the log. (Inherited from Object)

Syntax

SGEXPERIMENTAL void PrintInfo() const;

Parameters

PrintInfo takes no parameters.

Syntax

void PrintInfo();

Parameters

PrintInfo takes no parameters.

Syntax

None PrintInfo()

Parameters

PrintInfo takes no parameters.

RemoveObserver

Removes a previously added observer object. (Inherited from Object)

Syntax

SGEXPERIMENTAL void RemoveObserver( rid observerId ) const;

Parameters

Type	Name	Min	Max	Description
rid	observerId			ObserverId is the id returned by AddObserver when the observer was added.

Syntax

void RemoveObserver(int observerId);

Parameters

Type	Name	Min	Max	Description
int	observerId			ObserverId is the id returned by AddObserver when the observer was added.

Syntax

None RemoveObserver(observerId: int)

Parameters

Name	Type	Min	Max	Description
observerId	int			ObserverId is the id returned by AddObserver when the observer was added.

SetBoolParameter

Set a named parameter boolean value.

Syntax

SGEXPERIMENTAL bool SetBoolParameter( const char * name , bool value ) const;

Parameters

Type	Name	Min	Max	Description
const char *	name			Parameter name.
bool	value			New value for parameter.

Return value

Type: bool

Syntax

bool SetBoolParameter(string name, bool value);

Parameters

Type	Name	Min	Max	Description
string	name			Parameter name.
bool	value			New value for parameter.

Return value

Type: bool

Syntax

bool SetBoolParameter(name: str, value: bool)

Parameters

Name	Type	Min	Max	Description
name	str			Parameter name.
value	bool			New value for parameter.

Return value

Type: bool

SetDoubleParameter

Set a named parameter floating point value.

Syntax

SGEXPERIMENTAL bool SetDoubleParameter( const char * name , double value ) const;

Parameters

Type	Name	Min	Max	Description
const char *	name			Parameter name.
double	value			New value for parameter.

Return value

Type: bool

Syntax

bool SetDoubleParameter(string name, double value);

Parameters

Type	Name	Min	Max	Description
string	name			Parameter name.
double	value			New value for parameter.

Return value

Type: bool

Syntax

bool SetDoubleParameter(name: str, value: float)

Parameters

Name	Type	Min	Max	Description
name	str			Parameter name.
value	float			New value for parameter.

Return value

Type: bool

SetIntParameter

Set a named parameter integer value.

Syntax

SGEXPERIMENTAL bool SetIntParameter( const char * name , int value ) const;

Parameters

Type	Name	Min	Max	Description
const char *	name			Parameter name.
int	value			New value for parameter.

Return value

Type: bool

Syntax

bool SetIntParameter(string name, int value);

Parameters

Type	Name	Min	Max	Description
string	name			Parameter name.
int	value			New value for parameter.

Return value

Type: bool

Syntax

bool SetIntParameter(name: str, value: int)

Parameters

Name	Type	Min	Max	Description
name	str			Parameter name.
value	int			New value for parameter.

Return value

Type: bool

SetStringParameter

Set a named parameter string value.

Syntax

SGEXPERIMENTAL bool SetStringParameter( const char * name , const char * value ) const;

Parameters

Type	Name	Min	Max	Description
const char *	name			Parameter name.
const char *	value			New value for parameter.

Return value

Type: bool

Syntax

bool SetStringParameter(string name, string value);

Parameters

Type	Name	Min	Max	Description
string	name			Parameter name.
string	value			New value for parameter.

Return value

Type: bool

Syntax

bool SetStringParameter(name: str, value: str)

Parameters

Name	Type	Min	Max	Description
name	str			Parameter name.
value	str			New value for parameter.

Return value

Type: bool

SetUIntParameter

Set a named parameter unsigned integer value.

Syntax

SGEXPERIMENTAL bool SetUIntParameter( const char * name , unsigned int value ) const;

Parameters

Type	Name	Min	Max	Description
const char *	name			Parameter name.
unsigned int	value			New value for parameter.

Return value

Type: bool

Syntax

bool SetUIntParameter(string name, uint value);

Parameters

Type	Name	Min	Max	Description
string	name			Parameter name.
uint	value			New value for parameter.

Return value

Type: bool

Syntax

bool SetUIntParameter(name: str, value: int)

Parameters

Name	Type	Min	Max	Description
name	str			Parameter name.
value	int			New value for parameter.

Return value

Type: bool

SetValidateParameterNames

Set if parameter names should be validated or not. Parameters that previously do not exist will generate and error if validation is enabled and be allowed if validation is disabled.

Syntax

SGEXPERIMENTAL void SetValidateParameterNames( bool validate ) const;

Parameters

Type	Name	Min	Max	Description
bool	validate			Flag indicating if validation is performed or not.

Syntax

void SetValidateParameterNames(bool validate);

Parameters

Type	Name	Min	Max	Description
bool	validate			Flag indicating if validation is performed or not.

Syntax

None SetValidateParameterNames(validate: bool)

Parameters

Name	Type	Min	Max	Description
validate	bool			Flag indicating if validation is performed or not.

ToJSON

Get settings as JSON for debugging purposes.

Syntax

SGEXPERIMENTAL spString ToJSON() const;

Parameters

ToJSON takes no parameters.

Return value

Type: spString

Syntax

string ToJSON();

Parameters

ToJSON takes no parameters.

Return value

Type: string

Syntax

str ToJSON()

Parameters

ToJSON takes no parameters.

Return value

Type: str

ValidateSettings

Validates the current settings values.

Syntax

SGEXPERIMENTAL bool ValidateSettings() const;

Parameters

ValidateSettings takes no parameters.

Return value

Type: bool

Syntax

bool ValidateSettings();

Parameters

ValidateSettings takes no parameters.

Return value

Type: bool

Syntax

bool ValidateSettings()

Parameters

ValidateSettings takes no parameters.

Return value

Type: bool

Static methods details

IsClassA

Returns true if the class is a or is a descendant of the class named as the type parameter. (Inherited from Object)

Syntax

static SGEXPERIMENTAL bool IsClassA( const char * type ) const;

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

Syntax

static bool IsClassA(string type);

Parameters

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

Return value

Type: bool

Syntax

@staticmethod
bool IsClassA(type: str)

Parameters

Name	Type	Min	Max	Description
type	str			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 spNormalSplatterCasterSettings, and if this is the case, returns the object cast into spNormalSplatterCasterSettings. (Inherited from Object)

Syntax

static SGEXPERIMENTAL spNormalSplatterCasterSettings SafeCast( const spObject & object ) const;

Parameters

Type	Name	Min	Max	Description
Object	object			Object to cast.

Return value

Type: NormalSplatterCasterSettings

Syntax

static spNormalSplatterCasterSettings SafeCast(spObject object);

Parameters

Type	Name	Min	Max	Description
Object	object			Object to cast.

Return value

Type: NormalSplatterCasterSettings

Syntax

@staticmethod
spNormalSplatterCasterSettings SafeCast(object: spObject)

Parameters

Name	Type	Min	Max	Description
object	Object			Object to cast.

Return value

Type: NormalSplatterCasterSettings