class
AttributeTessellation
Management functions for geometry attribute tessellation
Properties
Property | Description |
---|---|
Name | The name of the AttributeTessellation object. (Inherited from Object) |
Methods
Method | Description |
---|---|
AddObserver | Adds a user-defined observer object to the interface, that will receive events from the interface. (Inherited from Object) |
FilterOpacityOnDisplacementEdges | Filter opacity based on displacement curvature, to separate out islands of different heights. Basically clears opacity values on all triangles where the absolute slope of displacement is above a set threshold. Note that the scene geometries must have both Opacity and Displacement as tessellated attributes. |
GetClass | Get the name of the AttributeTessellation class. (Inherited from Object) |
InjectColorDataIntoScene | Sample color data from the supplied material table and texture table, and inject into a named color data tessellated attribute. |
InjectDisplacementDataIntoScene | Fetch displacement data from the supplied material table and texture table, and inject into the displacement data tessellated attribute. Allowed attribute formats are U16 or F32vec3. |
InjectOpacityDataIntoScene | Fetch opacity data from the supplied material table and texture table, and inject into the opacity data tessellated attribute. Attribute format will always be U8. |
IsA | Returns true if AttributeTessellation is a or is a descendant of the class named as the type parameter. (Inherited from Object) |
IsNull | Returns true if the AttributeTessellation object is invalid. (Inherited from Object) |
IsSameObjectAs | Returns true if the AttributeTessellation object is valid. (Inherited from Object) |
NewTessellatedGeometry | Generates a new tessellated geometry with tessellated attributes applied. |
NewTessellatedScene | Generates a new copy of the scene with tessellated geometries which have tessellated attributes applied. |
NonNull | Returns true if the AttributeTessellation object is valid. (Inherited from Object) |
PrintInfo | Prints the content/info of the AttributeTessellation object to the log. (Inherited from Object) |
RemoveObserver | Removes a previously added observer object. (Inherited from Object) |
SetupAttributeTessellationOnGeometry | Sets up attribute tessellation setup and primitive tessellation on a single geometry. |
SetupAttributeTessellationOnScene | Sets up attribute tessellation and primitive tessellation on a scene. |
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 spAttributeTessellation, and if this is the case, returns the object cast into spAttributeTessellation. (Inherited from Object) |
Properties details
Name
The name of the AttributeTessellation object. (Inherited from Object)
Syntax
// Setter
void SetName( const char * name ) const;
// Getter
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
Methods details
AddObserver
Adds a user-defined observer object to the interface, that will receive events from the interface. (Inherited from Object)
Syntax
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
FilterOpacityOnDisplacementEdges
Filter opacity based on displacement curvature, to separate out islands of different heights. Basically clears opacity values on all triangles where the absolute slope of displacement is above a set threshold. Note that the scene geometries must have both Opacity and Displacement as tessellated attributes.
Syntax
bool FilterOpacityOnDisplacementEdges( const spScene & scene , real slopeThreshold ) const;
Parameters
Type | Name | Min | Max | Description |
---|---|---|---|---|
Scene | scene | The scene which is being processed and has tessellated attributes | ||
real | slopeThreshold | -1 | 1 | The slope threshold, defined as a dot product of the subtriangle vs the actual triangle. A value of 1 means that the subtriangle normal points exactly along the normal of the main triangle. |
Return value
Type: bool
Syntax
bool FilterOpacityOnDisplacementEdges(spScene scene, float slopeThreshold);
Parameters
Type | Name | Min | Max | Description |
---|---|---|---|---|
Scene | scene | The scene which is being processed and has tessellated attributes | ||
float | slopeThreshold | -1 | 1 | The slope threshold, defined as a dot product of the subtriangle vs the actual triangle. A value of 1 means that the subtriangle normal points exactly along the normal of the main triangle. |
Return value
Type: bool
Syntax
bool FilterOpacityOnDisplacementEdges(scene: spScene, slopeThreshold: float)
Parameters
Name | Type | Min | Max | Description |
---|---|---|---|---|
scene | Scene | The scene which is being processed and has tessellated attributes | ||
slopeThreshold | float | -1 | 1 | The slope threshold, defined as a dot product of the subtriangle vs the actual triangle. A value of 1 means that the subtriangle normal points exactly along the normal of the main triangle. |
Return value
Type: bool
GetClass
Get the name of the AttributeTessellation class. (Inherited from Object)
InjectColorDataIntoScene
Sample color data from the supplied material table and texture table, and inject into a named color data tessellated attribute.
Syntax
Simplygon::EErrorCodes InjectColorDataIntoScene( const spScene & scene , const char * destColorFieldName , const char * sourceMaterialChannelName , const spAttributeTessellationSamplingSettings & settings , const spMaterialTable & materials , const spTextureTable & textures , Simplygon::ESceneSamplingMode samplingMode ) const;
Parameters
Type | Name | Min | Max | Description |
---|---|---|---|---|
Scene | scene | The scene which is being processed and has data injected into | ||
const char * | destColorFieldName | The name of the attribute color field added per-geometry in the scene | ||
const char * | sourceMaterialChannelName | The name of the material channel to sample from the source material(s) | ||
AttributeTessellationSamplingSettings | settings | Settings for data injection sampling and format. | ||
MaterialTable | materials | Material table used for source color material data. | ||
TextureTable | textures | Texture table used for source color texture data | ||
ESceneSamplingMode | samplingMode | The scene sampling mode to use. Currently, only mode ShadingNetwork is supported. |
Return value
Type: EErrorCodes
Key | Value | Comment |
---|---|---|
NoError | 0 | No error, the initialization or process has finished, and with no errors |
NoLicense | -1 | no license was found (or licence expired) |
NotInitialized | -2 | the SDK is not initialized, or no process object has been loaded/created |
AlreadyInitialized | -3 | the SDK is already initialized |
DLLOrDependenciesNotFound | -4 | the specified file was not found. This might also mean that a .dll cannot be loaded because there is a missing dependency, such as the runtime environment. |
InvalidInputParam | -5 | an invalid parameter was passed to the method |
FailedTesting | -6 | the reduction failed post-testing |
DLLAndHeaderFileIsNotMatching | -7 | the Simplygon DLL and header file interface versions do not match |
DLLFailedToLoad | -8 | the Simplygon DLL failed loading, probably because of a missing dependency |
LicenseNotForThisApplication | -9 | the license is not made for this application of Simplygon |
LicenseNotForThisPlatform | -10 | the license is not made for this platform of Simplygon |
LicenseNotForThisVersion | -11 | the license is not made for this version of Simplygon |
FailedToCreatePipelineSerializer | -12 | failed to create pipeline serializer |
FailedToRunPipeline | -13 | failed to run pipeline |
UnhandledException | -14 | an unhandled exception was encountered |
FileError | -15 | a file read/write failed. |
InvalidPath | -16 | a path is invalid or a file/directory is missing. |
DependencyMissing | -17 | a needed dependency is missing. see log for info on what is missing. |
UnexpectedError | -18 | an unexpected error happened. |
FailedToUploadFreeLicenseAsset | -50 | failed to upload free license asset |
ExceptionalError | -1000 | An exceptional and fatal error occurred, and has been reported to the error handler. The library is placed in an exceptional state, and you should unload and reload the Simplygon library to avoid memory leaks. |
FailedToResolveLicenseServerHostName | -10001 | cannot reach the licensing server, cant look up server, check DNS |
FailedToConnectToLicenseServer | -10002 | cannot contact the licensing server, check firewall/proxy server |
FailedToConnectToLicenseServerAndSendData | -10003 | Failed to connect to the license server. Please check that your internet connection is working and outgoing connections to license.simplygon.com port 443 are not blocked by a firewall or proxy. |
FailedToConnectToLicenseServerAndReceiveData | -10004 | cannot receive data from the licensing server, check firewall/proxy server |
DataFromLicenseServerIsCorrupt | -10005 | data from licensing server is corrupted, try again, check connection |
LicenseHasExpired | -10006 | the license has expired |
LicenseIsInvalid | -10007 | the license data is corrupted, please reinstall the license key |
LicenseNotForThisProduct | -10008 | the license is not for this product, please contact licensing, and replace license key |
NoNetworkCardFound | -10009 | no network card was found on the machine |
LicenseDecodeFailed | -10010 | could not decode license, it is corrupted |
LicenseLockNotMatchingMachine | -10011 | the license is locked to another machine |
ConnectionToLicenseServerLost | -10012 | Connection to license server lost |
LicenseHashDataCorrupt | -10013 | could not decode license, it is corrupted |
LicenseExpired | -10014 | the license is invalid, please contact licensing |
LicenseNotLockedForThisMachine | -10020 | the license is locked to another machine |
YourLicenseRequiresLatestWindows10 | -10024 | your license requires latest Windows 10 version |
LicenseServerReturnedBadRequest | -10400 | Bad license request. Please reach out to SimplygonSupport[at]microsoft.com for support |
ProcessingCap | -10403 | You have reached the maximum number of processings for your license. Please try again in 24 hours or reach out to SimplygonSales@microsoft.com for support.. |
UnknownLicenseKey | -10404 | You are using an unknown license key. Please verify so you typed in the license key correctly and try again |
LicenseIsNotActive | -10410 | You are using an inactive license key. Please reach out to SimplygonSales[at]microsoft.com for support |
MaxNodesReachForThisLicense | -10409 | You have reached the maximum number of nodes for your license. After 48 hours of not using Simplygon on a machine the license will be released and can be installed on another machine |
YourLicenseRequiresLatestSimplygon | -10426 | The license key you are using requires you to update to the latest version before you can use Simplygon |
LicenseServerReturnServerError | -10501 | Bad license request. Please reach out to SimplygonSupport[at]microsoft.com for support |
ProcessingValidationError | -20001 | The process was aborted, because of a validation error. Either the process settings or the input data was invalid, or a combination thereof. Use GetErrorMessages in the main Simplygon object to retrieve error messages, and see the log for details. Note that the library is not left in an exceptional state, and it is safe to continue processing other scenes. |
Syntax
EErrorCodes InjectColorDataIntoScene(spScene scene, string destColorFieldName, string sourceMaterialChannelName, spAttributeTessellationSamplingSettings settings, spMaterialTable materials, spTextureTable textures, ESceneSamplingMode samplingMode);
Parameters
Type | Name | Min | Max | Description |
---|---|---|---|---|
Scene | scene | The scene which is being processed and has data injected into | ||
string | destColorFieldName | The name of the attribute color field added per-geometry in the scene | ||
string | sourceMaterialChannelName | The name of the material channel to sample from the source material(s) | ||
AttributeTessellationSamplingSettings | settings | Settings for data injection sampling and format. | ||
MaterialTable | materials | Material table used for source color material data. | ||
TextureTable | textures | Texture table used for source color texture data | ||
ESceneSamplingMode | samplingMode | The scene sampling mode to use. Currently, only mode ShadingNetwork is supported. |
Return value
Type: EErrorCodes
Key | Value | Comment |
---|---|---|
NoError | 0 | No error, the initialization or process has finished, and with no errors |
NoLicense | -1 | no license was found (or licence expired) |
NotInitialized | -2 | the SDK is not initialized, or no process object has been loaded/created |
AlreadyInitialized | -3 | the SDK is already initialized |
DLLOrDependenciesNotFound | -4 | the specified file was not found. This might also mean that a .dll cannot be loaded because there is a missing dependency, such as the runtime environment. |
InvalidInputParam | -5 | an invalid parameter was passed to the method |
FailedTesting | -6 | the reduction failed post-testing |
DLLAndHeaderFileIsNotMatching | -7 | the Simplygon DLL and header file interface versions do not match |
DLLFailedToLoad | -8 | the Simplygon DLL failed loading, probably because of a missing dependency |
LicenseNotForThisApplication | -9 | the license is not made for this application of Simplygon |
LicenseNotForThisPlatform | -10 | the license is not made for this platform of Simplygon |
LicenseNotForThisVersion | -11 | the license is not made for this version of Simplygon |
FailedToCreatePipelineSerializer | -12 | failed to create pipeline serializer |
FailedToRunPipeline | -13 | failed to run pipeline |
UnhandledException | -14 | an unhandled exception was encountered |
FileError | -15 | a file read/write failed. |
InvalidPath | -16 | a path is invalid or a file/directory is missing. |
DependencyMissing | -17 | a needed dependency is missing. see log for info on what is missing. |
UnexpectedError | -18 | an unexpected error happened. |
FailedToUploadFreeLicenseAsset | -50 | failed to upload free license asset |
ExceptionalError | -1000 | An exceptional and fatal error occurred, and has been reported to the error handler. The library is placed in an exceptional state, and you should unload and reload the Simplygon library to avoid memory leaks. |
FailedToResolveLicenseServerHostName | -10001 | cannot reach the licensing server, cant look up server, check DNS |
FailedToConnectToLicenseServer | -10002 | cannot contact the licensing server, check firewall/proxy server |
FailedToConnectToLicenseServerAndSendData | -10003 | Failed to connect to the license server. Please check that your internet connection is working and outgoing connections to license.simplygon.com port 443 are not blocked by a firewall or proxy. |
FailedToConnectToLicenseServerAndReceiveData | -10004 | cannot receive data from the licensing server, check firewall/proxy server |
DataFromLicenseServerIsCorrupt | -10005 | data from licensing server is corrupted, try again, check connection |
LicenseHasExpired | -10006 | the license has expired |
LicenseIsInvalid | -10007 | the license data is corrupted, please reinstall the license key |
LicenseNotForThisProduct | -10008 | the license is not for this product, please contact licensing, and replace license key |
NoNetworkCardFound | -10009 | no network card was found on the machine |
LicenseDecodeFailed | -10010 | could not decode license, it is corrupted |
LicenseLockNotMatchingMachine | -10011 | the license is locked to another machine |
ConnectionToLicenseServerLost | -10012 | Connection to license server lost |
LicenseHashDataCorrupt | -10013 | could not decode license, it is corrupted |
LicenseExpired | -10014 | the license is invalid, please contact licensing |
LicenseNotLockedForThisMachine | -10020 | the license is locked to another machine |
YourLicenseRequiresLatestWindows10 | -10024 | your license requires latest Windows 10 version |
LicenseServerReturnedBadRequest | -10400 | Bad license request. Please reach out to SimplygonSupport[at]microsoft.com for support |
ProcessingCap | -10403 | You have reached the maximum number of processings for your license. Please try again in 24 hours or reach out to SimplygonSales@microsoft.com for support.. |
UnknownLicenseKey | -10404 | You are using an unknown license key. Please verify so you typed in the license key correctly and try again |
LicenseIsNotActive | -10410 | You are using an inactive license key. Please reach out to SimplygonSales[at]microsoft.com for support |
MaxNodesReachForThisLicense | -10409 | You have reached the maximum number of nodes for your license. After 48 hours of not using Simplygon on a machine the license will be released and can be installed on another machine |
YourLicenseRequiresLatestSimplygon | -10426 | The license key you are using requires you to update to the latest version before you can use Simplygon |
LicenseServerReturnServerError | -10501 | Bad license request. Please reach out to SimplygonSupport[at]microsoft.com for support |
ProcessingValidationError | -20001 | The process was aborted, because of a validation error. Either the process settings or the input data was invalid, or a combination thereof. Use GetErrorMessages in the main Simplygon object to retrieve error messages, and see the log for details. Note that the library is not left in an exceptional state, and it is safe to continue processing other scenes. |
Syntax
EErrorCodes_* InjectColorDataIntoScene(scene: spScene, destColorFieldName: str, sourceMaterialChannelName: str, settings: spAttributeTessellationSamplingSettings, materials: spMaterialTable, textures: spTextureTable, samplingMode: ESceneSamplingMode_*)
Parameters
Name | Type | Min | Max | Description |
---|---|---|---|---|
scene | Scene | The scene which is being processed and has data injected into | ||
destColorFieldName | str | The name of the attribute color field added per-geometry in the scene | ||
sourceMaterialChannelName | str | The name of the material channel to sample from the source material(s) | ||
settings | AttributeTessellationSamplingSettings | Settings for data injection sampling and format. | ||
materials | MaterialTable | Material table used for source color material data. | ||
textures | TextureTable | Texture table used for source color texture data | ||
samplingMode | ESceneSamplingMode | The scene sampling mode to use. Currently, only mode ShadingNetwork is supported. |
Return value
Type: EErrorCodes
Key | Value | Comment |
---|---|---|
EErrorCodes_NoError | 0 | No error, the initialization or process has finished, and with no errors |
EErrorCodes_NoLicense | -1 | no license was found (or licence expired) |
EErrorCodes_NotInitialized | -2 | the SDK is not initialized, or no process object has been loaded/created |
EErrorCodes_AlreadyInitialized | -3 | the SDK is already initialized |
EErrorCodes_DLLOrDependenciesNotFound | -4 | the specified file was not found. This might also mean that a .dll cannot be loaded because there is a missing dependency, such as the runtime environment. |
EErrorCodes_InvalidInputParam | -5 | an invalid parameter was passed to the method |
EErrorCodes_FailedTesting | -6 | the reduction failed post-testing |
EErrorCodes_DLLAndHeaderFileIsNotMatching | -7 | the Simplygon DLL and header file interface versions do not match |
EErrorCodes_DLLFailedToLoad | -8 | the Simplygon DLL failed loading, probably because of a missing dependency |
EErrorCodes_LicenseNotForThisApplication | -9 | the license is not made for this application of Simplygon |
EErrorCodes_LicenseNotForThisPlatform | -10 | the license is not made for this platform of Simplygon |
EErrorCodes_LicenseNotForThisVersion | -11 | the license is not made for this version of Simplygon |
EErrorCodes_FailedToCreatePipelineSerializer | -12 | failed to create pipeline serializer |
EErrorCodes_FailedToRunPipeline | -13 | failed to run pipeline |
EErrorCodes_UnhandledException | -14 | an unhandled exception was encountered |
EErrorCodes_FileError | -15 | a file read/write failed. |
EErrorCodes_InvalidPath | -16 | a path is invalid or a file/directory is missing. |
EErrorCodes_DependencyMissing | -17 | a needed dependency is missing. see log for info on what is missing. |
EErrorCodes_UnexpectedError | -18 | an unexpected error happened. |
EErrorCodes_FailedToUploadFreeLicenseAsset | -50 | failed to upload free license asset |
EErrorCodes_ExceptionalError | -1000 | An exceptional and fatal error occurred, and has been reported to the error handler. The library is placed in an exceptional state, and you should unload and reload the Simplygon library to avoid memory leaks. |
EErrorCodes_FailedToResolveLicenseServerHostName | -10001 | cannot reach the licensing server, cant look up server, check DNS |
EErrorCodes_FailedToConnectToLicenseServer | -10002 | cannot contact the licensing server, check firewall/proxy server |
EErrorCodes_FailedToConnectToLicenseServerAndSendData | -10003 | Failed to connect to the license server. Please check that your internet connection is working and outgoing connections to license.simplygon.com port 443 are not blocked by a firewall or proxy. |
EErrorCodes_FailedToConnectToLicenseServerAndReceiveData | -10004 | cannot receive data from the licensing server, check firewall/proxy server |
EErrorCodes_DataFromLicenseServerIsCorrupt | -10005 | data from licensing server is corrupted, try again, check connection |
EErrorCodes_LicenseHasExpired | -10006 | the license has expired |
EErrorCodes_LicenseIsInvalid | -10007 | the license data is corrupted, please reinstall the license key |
EErrorCodes_LicenseNotForThisProduct | -10008 | the license is not for this product, please contact licensing, and replace license key |
EErrorCodes_NoNetworkCardFound | -10009 | no network card was found on the machine |
EErrorCodes_LicenseDecodeFailed | -10010 | could not decode license, it is corrupted |
EErrorCodes_LicenseLockNotMatchingMachine | -10011 | the license is locked to another machine |
EErrorCodes_ConnectionToLicenseServerLost | -10012 | Connection to license server lost |
EErrorCodes_LicenseHashDataCorrupt | -10013 | could not decode license, it is corrupted |
EErrorCodes_LicenseExpired | -10014 | the license is invalid, please contact licensing |
EErrorCodes_LicenseNotLockedForThisMachine | -10020 | the license is locked to another machine |
EErrorCodes_YourLicenseRequiresLatestWindows10 | -10024 | your license requires latest Windows 10 version |
EErrorCodes_LicenseServerReturnedBadRequest | -10400 | Bad license request. Please reach out to SimplygonSupport[at]microsoft.com for support |
EErrorCodes_ProcessingCap | -10403 | You have reached the maximum number of processings for your license. Please try again in 24 hours or reach out to SimplygonSales@microsoft.com for support.. |
EErrorCodes_UnknownLicenseKey | -10404 | You are using an unknown license key. Please verify so you typed in the license key correctly and try again |
EErrorCodes_LicenseIsNotActive | -10410 | You are using an inactive license key. Please reach out to SimplygonSales[at]microsoft.com for support |
EErrorCodes_MaxNodesReachForThisLicense | -10409 | You have reached the maximum number of nodes for your license. After 48 hours of not using Simplygon on a machine the license will be released and can be installed on another machine |
EErrorCodes_YourLicenseRequiresLatestSimplygon | -10426 | The license key you are using requires you to update to the latest version before you can use Simplygon |
EErrorCodes_LicenseServerReturnServerError | -10501 | Bad license request. Please reach out to SimplygonSupport[at]microsoft.com for support |
EErrorCodes_ProcessingValidationError | -20001 | The process was aborted, because of a validation error. Either the process settings or the input data was invalid, or a combination thereof. Use GetErrorMessages in the main Simplygon object to retrieve error messages, and see the log for details. Note that the library is not left in an exceptional state, and it is safe to continue processing other scenes. |
InjectDisplacementDataIntoScene
Fetch displacement data from the supplied material table and texture table, and inject into the displacement data tessellated attribute. Allowed attribute formats are U16 or F32vec3.
Syntax
Simplygon::EErrorCodes InjectDisplacementDataIntoScene( const spScene & scene , const spAttributeTessellationSamplingSettings & settings , const spMaterialTable & materials , const spTextureTable & textures ) const;
Parameters
Type | Name | Min | Max | Description |
---|---|---|---|---|
Scene | scene | The scene which is being processed and has data injected into | ||
AttributeTessellationSamplingSettings | settings | Settings for data injection sampling and format. | ||
MaterialTable | materials | Material table used for lookup of displacement channels. | ||
TextureTable | textures | Texture table used for lookup of displacement images. |
Return value
Type: EErrorCodes
Key | Value | Comment |
---|---|---|
NoError | 0 | No error, the initialization or process has finished, and with no errors |
NoLicense | -1 | no license was found (or licence expired) |
NotInitialized | -2 | the SDK is not initialized, or no process object has been loaded/created |
AlreadyInitialized | -3 | the SDK is already initialized |
DLLOrDependenciesNotFound | -4 | the specified file was not found. This might also mean that a .dll cannot be loaded because there is a missing dependency, such as the runtime environment. |
InvalidInputParam | -5 | an invalid parameter was passed to the method |
FailedTesting | -6 | the reduction failed post-testing |
DLLAndHeaderFileIsNotMatching | -7 | the Simplygon DLL and header file interface versions do not match |
DLLFailedToLoad | -8 | the Simplygon DLL failed loading, probably because of a missing dependency |
LicenseNotForThisApplication | -9 | the license is not made for this application of Simplygon |
LicenseNotForThisPlatform | -10 | the license is not made for this platform of Simplygon |
LicenseNotForThisVersion | -11 | the license is not made for this version of Simplygon |
FailedToCreatePipelineSerializer | -12 | failed to create pipeline serializer |
FailedToRunPipeline | -13 | failed to run pipeline |
UnhandledException | -14 | an unhandled exception was encountered |
FileError | -15 | a file read/write failed. |
InvalidPath | -16 | a path is invalid or a file/directory is missing. |
DependencyMissing | -17 | a needed dependency is missing. see log for info on what is missing. |
UnexpectedError | -18 | an unexpected error happened. |
FailedToUploadFreeLicenseAsset | -50 | failed to upload free license asset |
ExceptionalError | -1000 | An exceptional and fatal error occurred, and has been reported to the error handler. The library is placed in an exceptional state, and you should unload and reload the Simplygon library to avoid memory leaks. |
FailedToResolveLicenseServerHostName | -10001 | cannot reach the licensing server, cant look up server, check DNS |
FailedToConnectToLicenseServer | -10002 | cannot contact the licensing server, check firewall/proxy server |
FailedToConnectToLicenseServerAndSendData | -10003 | Failed to connect to the license server. Please check that your internet connection is working and outgoing connections to license.simplygon.com port 443 are not blocked by a firewall or proxy. |
FailedToConnectToLicenseServerAndReceiveData | -10004 | cannot receive data from the licensing server, check firewall/proxy server |
DataFromLicenseServerIsCorrupt | -10005 | data from licensing server is corrupted, try again, check connection |
LicenseHasExpired | -10006 | the license has expired |
LicenseIsInvalid | -10007 | the license data is corrupted, please reinstall the license key |
LicenseNotForThisProduct | -10008 | the license is not for this product, please contact licensing, and replace license key |
NoNetworkCardFound | -10009 | no network card was found on the machine |
LicenseDecodeFailed | -10010 | could not decode license, it is corrupted |
LicenseLockNotMatchingMachine | -10011 | the license is locked to another machine |
ConnectionToLicenseServerLost | -10012 | Connection to license server lost |
LicenseHashDataCorrupt | -10013 | could not decode license, it is corrupted |
LicenseExpired | -10014 | the license is invalid, please contact licensing |
LicenseNotLockedForThisMachine | -10020 | the license is locked to another machine |
YourLicenseRequiresLatestWindows10 | -10024 | your license requires latest Windows 10 version |
LicenseServerReturnedBadRequest | -10400 | Bad license request. Please reach out to SimplygonSupport[at]microsoft.com for support |
ProcessingCap | -10403 | You have reached the maximum number of processings for your license. Please try again in 24 hours or reach out to SimplygonSales@microsoft.com for support.. |
UnknownLicenseKey | -10404 | You are using an unknown license key. Please verify so you typed in the license key correctly and try again |
LicenseIsNotActive | -10410 | You are using an inactive license key. Please reach out to SimplygonSales[at]microsoft.com for support |
MaxNodesReachForThisLicense | -10409 | You have reached the maximum number of nodes for your license. After 48 hours of not using Simplygon on a machine the license will be released and can be installed on another machine |
YourLicenseRequiresLatestSimplygon | -10426 | The license key you are using requires you to update to the latest version before you can use Simplygon |
LicenseServerReturnServerError | -10501 | Bad license request. Please reach out to SimplygonSupport[at]microsoft.com for support |
ProcessingValidationError | -20001 | The process was aborted, because of a validation error. Either the process settings or the input data was invalid, or a combination thereof. Use GetErrorMessages in the main Simplygon object to retrieve error messages, and see the log for details. Note that the library is not left in an exceptional state, and it is safe to continue processing other scenes. |
Syntax
EErrorCodes InjectDisplacementDataIntoScene(spScene scene, spAttributeTessellationSamplingSettings settings, spMaterialTable materials, spTextureTable textures);
Parameters
Type | Name | Min | Max | Description |
---|---|---|---|---|
Scene | scene | The scene which is being processed and has data injected into | ||
AttributeTessellationSamplingSettings | settings | Settings for data injection sampling and format. | ||
MaterialTable | materials | Material table used for lookup of displacement channels. | ||
TextureTable | textures | Texture table used for lookup of displacement images. |
Return value
Type: EErrorCodes
Key | Value | Comment |
---|---|---|
NoError | 0 | No error, the initialization or process has finished, and with no errors |
NoLicense | -1 | no license was found (or licence expired) |
NotInitialized | -2 | the SDK is not initialized, or no process object has been loaded/created |
AlreadyInitialized | -3 | the SDK is already initialized |
DLLOrDependenciesNotFound | -4 | the specified file was not found. This might also mean that a .dll cannot be loaded because there is a missing dependency, such as the runtime environment. |
InvalidInputParam | -5 | an invalid parameter was passed to the method |
FailedTesting | -6 | the reduction failed post-testing |
DLLAndHeaderFileIsNotMatching | -7 | the Simplygon DLL and header file interface versions do not match |
DLLFailedToLoad | -8 | the Simplygon DLL failed loading, probably because of a missing dependency |
LicenseNotForThisApplication | -9 | the license is not made for this application of Simplygon |
LicenseNotForThisPlatform | -10 | the license is not made for this platform of Simplygon |
LicenseNotForThisVersion | -11 | the license is not made for this version of Simplygon |
FailedToCreatePipelineSerializer | -12 | failed to create pipeline serializer |
FailedToRunPipeline | -13 | failed to run pipeline |
UnhandledException | -14 | an unhandled exception was encountered |
FileError | -15 | a file read/write failed. |
InvalidPath | -16 | a path is invalid or a file/directory is missing. |
DependencyMissing | -17 | a needed dependency is missing. see log for info on what is missing. |
UnexpectedError | -18 | an unexpected error happened. |
FailedToUploadFreeLicenseAsset | -50 | failed to upload free license asset |
ExceptionalError | -1000 | An exceptional and fatal error occurred, and has been reported to the error handler. The library is placed in an exceptional state, and you should unload and reload the Simplygon library to avoid memory leaks. |
FailedToResolveLicenseServerHostName | -10001 | cannot reach the licensing server, cant look up server, check DNS |
FailedToConnectToLicenseServer | -10002 | cannot contact the licensing server, check firewall/proxy server |
FailedToConnectToLicenseServerAndSendData | -10003 | Failed to connect to the license server. Please check that your internet connection is working and outgoing connections to license.simplygon.com port 443 are not blocked by a firewall or proxy. |
FailedToConnectToLicenseServerAndReceiveData | -10004 | cannot receive data from the licensing server, check firewall/proxy server |
DataFromLicenseServerIsCorrupt | -10005 | data from licensing server is corrupted, try again, check connection |
LicenseHasExpired | -10006 | the license has expired |
LicenseIsInvalid | -10007 | the license data is corrupted, please reinstall the license key |
LicenseNotForThisProduct | -10008 | the license is not for this product, please contact licensing, and replace license key |
NoNetworkCardFound | -10009 | no network card was found on the machine |
LicenseDecodeFailed | -10010 | could not decode license, it is corrupted |
LicenseLockNotMatchingMachine | -10011 | the license is locked to another machine |
ConnectionToLicenseServerLost | -10012 | Connection to license server lost |
LicenseHashDataCorrupt | -10013 | could not decode license, it is corrupted |
LicenseExpired | -10014 | the license is invalid, please contact licensing |
LicenseNotLockedForThisMachine | -10020 | the license is locked to another machine |
YourLicenseRequiresLatestWindows10 | -10024 | your license requires latest Windows 10 version |
LicenseServerReturnedBadRequest | -10400 | Bad license request. Please reach out to SimplygonSupport[at]microsoft.com for support |
ProcessingCap | -10403 | You have reached the maximum number of processings for your license. Please try again in 24 hours or reach out to SimplygonSales@microsoft.com for support.. |
UnknownLicenseKey | -10404 | You are using an unknown license key. Please verify so you typed in the license key correctly and try again |
LicenseIsNotActive | -10410 | You are using an inactive license key. Please reach out to SimplygonSales[at]microsoft.com for support |
MaxNodesReachForThisLicense | -10409 | You have reached the maximum number of nodes for your license. After 48 hours of not using Simplygon on a machine the license will be released and can be installed on another machine |
YourLicenseRequiresLatestSimplygon | -10426 | The license key you are using requires you to update to the latest version before you can use Simplygon |
LicenseServerReturnServerError | -10501 | Bad license request. Please reach out to SimplygonSupport[at]microsoft.com for support |
ProcessingValidationError | -20001 | The process was aborted, because of a validation error. Either the process settings or the input data was invalid, or a combination thereof. Use GetErrorMessages in the main Simplygon object to retrieve error messages, and see the log for details. Note that the library is not left in an exceptional state, and it is safe to continue processing other scenes. |
Syntax
EErrorCodes_* InjectDisplacementDataIntoScene(scene: spScene, settings: spAttributeTessellationSamplingSettings, materials: spMaterialTable, textures: spTextureTable)
Parameters
Name | Type | Min | Max | Description |
---|---|---|---|---|
scene | Scene | The scene which is being processed and has data injected into | ||
settings | AttributeTessellationSamplingSettings | Settings for data injection sampling and format. | ||
materials | MaterialTable | Material table used for lookup of displacement channels. | ||
textures | TextureTable | Texture table used for lookup of displacement images. |
Return value
Type: EErrorCodes
Key | Value | Comment |
---|---|---|
EErrorCodes_NoError | 0 | No error, the initialization or process has finished, and with no errors |
EErrorCodes_NoLicense | -1 | no license was found (or licence expired) |
EErrorCodes_NotInitialized | -2 | the SDK is not initialized, or no process object has been loaded/created |
EErrorCodes_AlreadyInitialized | -3 | the SDK is already initialized |
EErrorCodes_DLLOrDependenciesNotFound | -4 | the specified file was not found. This might also mean that a .dll cannot be loaded because there is a missing dependency, such as the runtime environment. |
EErrorCodes_InvalidInputParam | -5 | an invalid parameter was passed to the method |
EErrorCodes_FailedTesting | -6 | the reduction failed post-testing |
EErrorCodes_DLLAndHeaderFileIsNotMatching | -7 | the Simplygon DLL and header file interface versions do not match |
EErrorCodes_DLLFailedToLoad | -8 | the Simplygon DLL failed loading, probably because of a missing dependency |
EErrorCodes_LicenseNotForThisApplication | -9 | the license is not made for this application of Simplygon |
EErrorCodes_LicenseNotForThisPlatform | -10 | the license is not made for this platform of Simplygon |
EErrorCodes_LicenseNotForThisVersion | -11 | the license is not made for this version of Simplygon |
EErrorCodes_FailedToCreatePipelineSerializer | -12 | failed to create pipeline serializer |
EErrorCodes_FailedToRunPipeline | -13 | failed to run pipeline |
EErrorCodes_UnhandledException | -14 | an unhandled exception was encountered |
EErrorCodes_FileError | -15 | a file read/write failed. |
EErrorCodes_InvalidPath | -16 | a path is invalid or a file/directory is missing. |
EErrorCodes_DependencyMissing | -17 | a needed dependency is missing. see log for info on what is missing. |
EErrorCodes_UnexpectedError | -18 | an unexpected error happened. |
EErrorCodes_FailedToUploadFreeLicenseAsset | -50 | failed to upload free license asset |
EErrorCodes_ExceptionalError | -1000 | An exceptional and fatal error occurred, and has been reported to the error handler. The library is placed in an exceptional state, and you should unload and reload the Simplygon library to avoid memory leaks. |
EErrorCodes_FailedToResolveLicenseServerHostName | -10001 | cannot reach the licensing server, cant look up server, check DNS |
EErrorCodes_FailedToConnectToLicenseServer | -10002 | cannot contact the licensing server, check firewall/proxy server |
EErrorCodes_FailedToConnectToLicenseServerAndSendData | -10003 | Failed to connect to the license server. Please check that your internet connection is working and outgoing connections to license.simplygon.com port 443 are not blocked by a firewall or proxy. |
EErrorCodes_FailedToConnectToLicenseServerAndReceiveData | -10004 | cannot receive data from the licensing server, check firewall/proxy server |
EErrorCodes_DataFromLicenseServerIsCorrupt | -10005 | data from licensing server is corrupted, try again, check connection |
EErrorCodes_LicenseHasExpired | -10006 | the license has expired |
EErrorCodes_LicenseIsInvalid | -10007 | the license data is corrupted, please reinstall the license key |
EErrorCodes_LicenseNotForThisProduct | -10008 | the license is not for this product, please contact licensing, and replace license key |
EErrorCodes_NoNetworkCardFound | -10009 | no network card was found on the machine |
EErrorCodes_LicenseDecodeFailed | -10010 | could not decode license, it is corrupted |
EErrorCodes_LicenseLockNotMatchingMachine | -10011 | the license is locked to another machine |
EErrorCodes_ConnectionToLicenseServerLost | -10012 | Connection to license server lost |
EErrorCodes_LicenseHashDataCorrupt | -10013 | could not decode license, it is corrupted |
EErrorCodes_LicenseExpired | -10014 | the license is invalid, please contact licensing |
EErrorCodes_LicenseNotLockedForThisMachine | -10020 | the license is locked to another machine |
EErrorCodes_YourLicenseRequiresLatestWindows10 | -10024 | your license requires latest Windows 10 version |
EErrorCodes_LicenseServerReturnedBadRequest | -10400 | Bad license request. Please reach out to SimplygonSupport[at]microsoft.com for support |
EErrorCodes_ProcessingCap | -10403 | You have reached the maximum number of processings for your license. Please try again in 24 hours or reach out to SimplygonSales@microsoft.com for support.. |
EErrorCodes_UnknownLicenseKey | -10404 | You are using an unknown license key. Please verify so you typed in the license key correctly and try again |
EErrorCodes_LicenseIsNotActive | -10410 | You are using an inactive license key. Please reach out to SimplygonSales[at]microsoft.com for support |
EErrorCodes_MaxNodesReachForThisLicense | -10409 | You have reached the maximum number of nodes for your license. After 48 hours of not using Simplygon on a machine the license will be released and can be installed on another machine |
EErrorCodes_YourLicenseRequiresLatestSimplygon | -10426 | The license key you are using requires you to update to the latest version before you can use Simplygon |
EErrorCodes_LicenseServerReturnServerError | -10501 | Bad license request. Please reach out to SimplygonSupport[at]microsoft.com for support |
EErrorCodes_ProcessingValidationError | -20001 | The process was aborted, because of a validation error. Either the process settings or the input data was invalid, or a combination thereof. Use GetErrorMessages in the main Simplygon object to retrieve error messages, and see the log for details. Note that the library is not left in an exceptional state, and it is safe to continue processing other scenes. |
InjectOpacityDataIntoScene
Fetch opacity data from the supplied material table and texture table, and inject into the opacity data tessellated attribute. Attribute format will always be U8.
Syntax
Simplygon::EErrorCodes InjectOpacityDataIntoScene( const spScene & scene , const spAttributeTessellationSamplingSettings & settings , const spMaterialTable & materials , const spTextureTable & textures ) const;
Parameters
Type | Name | Min | Max | Description |
---|---|---|---|---|
Scene | scene | The scene which is being processed and has data injected into | ||
AttributeTessellationSamplingSettings | settings | Settings for data injection sampling and format. | ||
MaterialTable | materials | Material table used for lookup of opacity channels. | ||
TextureTable | textures | Texture table used for lookup of opacity images. |
Return value
Type: EErrorCodes
Key | Value | Comment |
---|---|---|
NoError | 0 | No error, the initialization or process has finished, and with no errors |
NoLicense | -1 | no license was found (or licence expired) |
NotInitialized | -2 | the SDK is not initialized, or no process object has been loaded/created |
AlreadyInitialized | -3 | the SDK is already initialized |
DLLOrDependenciesNotFound | -4 | the specified file was not found. This might also mean that a .dll cannot be loaded because there is a missing dependency, such as the runtime environment. |
InvalidInputParam | -5 | an invalid parameter was passed to the method |
FailedTesting | -6 | the reduction failed post-testing |
DLLAndHeaderFileIsNotMatching | -7 | the Simplygon DLL and header file interface versions do not match |
DLLFailedToLoad | -8 | the Simplygon DLL failed loading, probably because of a missing dependency |
LicenseNotForThisApplication | -9 | the license is not made for this application of Simplygon |
LicenseNotForThisPlatform | -10 | the license is not made for this platform of Simplygon |
LicenseNotForThisVersion | -11 | the license is not made for this version of Simplygon |
FailedToCreatePipelineSerializer | -12 | failed to create pipeline serializer |
FailedToRunPipeline | -13 | failed to run pipeline |
UnhandledException | -14 | an unhandled exception was encountered |
FileError | -15 | a file read/write failed. |
InvalidPath | -16 | a path is invalid or a file/directory is missing. |
DependencyMissing | -17 | a needed dependency is missing. see log for info on what is missing. |
UnexpectedError | -18 | an unexpected error happened. |
FailedToUploadFreeLicenseAsset | -50 | failed to upload free license asset |
ExceptionalError | -1000 | An exceptional and fatal error occurred, and has been reported to the error handler. The library is placed in an exceptional state, and you should unload and reload the Simplygon library to avoid memory leaks. |
FailedToResolveLicenseServerHostName | -10001 | cannot reach the licensing server, cant look up server, check DNS |
FailedToConnectToLicenseServer | -10002 | cannot contact the licensing server, check firewall/proxy server |
FailedToConnectToLicenseServerAndSendData | -10003 | Failed to connect to the license server. Please check that your internet connection is working and outgoing connections to license.simplygon.com port 443 are not blocked by a firewall or proxy. |
FailedToConnectToLicenseServerAndReceiveData | -10004 | cannot receive data from the licensing server, check firewall/proxy server |
DataFromLicenseServerIsCorrupt | -10005 | data from licensing server is corrupted, try again, check connection |
LicenseHasExpired | -10006 | the license has expired |
LicenseIsInvalid | -10007 | the license data is corrupted, please reinstall the license key |
LicenseNotForThisProduct | -10008 | the license is not for this product, please contact licensing, and replace license key |
NoNetworkCardFound | -10009 | no network card was found on the machine |
LicenseDecodeFailed | -10010 | could not decode license, it is corrupted |
LicenseLockNotMatchingMachine | -10011 | the license is locked to another machine |
ConnectionToLicenseServerLost | -10012 | Connection to license server lost |
LicenseHashDataCorrupt | -10013 | could not decode license, it is corrupted |
LicenseExpired | -10014 | the license is invalid, please contact licensing |
LicenseNotLockedForThisMachine | -10020 | the license is locked to another machine |
YourLicenseRequiresLatestWindows10 | -10024 | your license requires latest Windows 10 version |
LicenseServerReturnedBadRequest | -10400 | Bad license request. Please reach out to SimplygonSupport[at]microsoft.com for support |
ProcessingCap | -10403 | You have reached the maximum number of processings for your license. Please try again in 24 hours or reach out to SimplygonSales@microsoft.com for support.. |
UnknownLicenseKey | -10404 | You are using an unknown license key. Please verify so you typed in the license key correctly and try again |
LicenseIsNotActive | -10410 | You are using an inactive license key. Please reach out to SimplygonSales[at]microsoft.com for support |
MaxNodesReachForThisLicense | -10409 | You have reached the maximum number of nodes for your license. After 48 hours of not using Simplygon on a machine the license will be released and can be installed on another machine |
YourLicenseRequiresLatestSimplygon | -10426 | The license key you are using requires you to update to the latest version before you can use Simplygon |
LicenseServerReturnServerError | -10501 | Bad license request. Please reach out to SimplygonSupport[at]microsoft.com for support |
ProcessingValidationError | -20001 | The process was aborted, because of a validation error. Either the process settings or the input data was invalid, or a combination thereof. Use GetErrorMessages in the main Simplygon object to retrieve error messages, and see the log for details. Note that the library is not left in an exceptional state, and it is safe to continue processing other scenes. |
Syntax
EErrorCodes InjectOpacityDataIntoScene(spScene scene, spAttributeTessellationSamplingSettings settings, spMaterialTable materials, spTextureTable textures);
Parameters
Type | Name | Min | Max | Description |
---|---|---|---|---|
Scene | scene | The scene which is being processed and has data injected into | ||
AttributeTessellationSamplingSettings | settings | Settings for data injection sampling and format. | ||
MaterialTable | materials | Material table used for lookup of opacity channels. | ||
TextureTable | textures | Texture table used for lookup of opacity images. |
Return value
Type: EErrorCodes
Key | Value | Comment |
---|---|---|
NoError | 0 | No error, the initialization or process has finished, and with no errors |
NoLicense | -1 | no license was found (or licence expired) |
NotInitialized | -2 | the SDK is not initialized, or no process object has been loaded/created |
AlreadyInitialized | -3 | the SDK is already initialized |
DLLOrDependenciesNotFound | -4 | the specified file was not found. This might also mean that a .dll cannot be loaded because there is a missing dependency, such as the runtime environment. |
InvalidInputParam | -5 | an invalid parameter was passed to the method |
FailedTesting | -6 | the reduction failed post-testing |
DLLAndHeaderFileIsNotMatching | -7 | the Simplygon DLL and header file interface versions do not match |
DLLFailedToLoad | -8 | the Simplygon DLL failed loading, probably because of a missing dependency |
LicenseNotForThisApplication | -9 | the license is not made for this application of Simplygon |
LicenseNotForThisPlatform | -10 | the license is not made for this platform of Simplygon |
LicenseNotForThisVersion | -11 | the license is not made for this version of Simplygon |
FailedToCreatePipelineSerializer | -12 | failed to create pipeline serializer |
FailedToRunPipeline | -13 | failed to run pipeline |
UnhandledException | -14 | an unhandled exception was encountered |
FileError | -15 | a file read/write failed. |
InvalidPath | -16 | a path is invalid or a file/directory is missing. |
DependencyMissing | -17 | a needed dependency is missing. see log for info on what is missing. |
UnexpectedError | -18 | an unexpected error happened. |
FailedToUploadFreeLicenseAsset | -50 | failed to upload free license asset |
ExceptionalError | -1000 | An exceptional and fatal error occurred, and has been reported to the error handler. The library is placed in an exceptional state, and you should unload and reload the Simplygon library to avoid memory leaks. |
FailedToResolveLicenseServerHostName | -10001 | cannot reach the licensing server, cant look up server, check DNS |
FailedToConnectToLicenseServer | -10002 | cannot contact the licensing server, check firewall/proxy server |
FailedToConnectToLicenseServerAndSendData | -10003 | Failed to connect to the license server. Please check that your internet connection is working and outgoing connections to license.simplygon.com port 443 are not blocked by a firewall or proxy. |
FailedToConnectToLicenseServerAndReceiveData | -10004 | cannot receive data from the licensing server, check firewall/proxy server |
DataFromLicenseServerIsCorrupt | -10005 | data from licensing server is corrupted, try again, check connection |
LicenseHasExpired | -10006 | the license has expired |
LicenseIsInvalid | -10007 | the license data is corrupted, please reinstall the license key |
LicenseNotForThisProduct | -10008 | the license is not for this product, please contact licensing, and replace license key |
NoNetworkCardFound | -10009 | no network card was found on the machine |
LicenseDecodeFailed | -10010 | could not decode license, it is corrupted |
LicenseLockNotMatchingMachine | -10011 | the license is locked to another machine |
ConnectionToLicenseServerLost | -10012 | Connection to license server lost |
LicenseHashDataCorrupt | -10013 | could not decode license, it is corrupted |
LicenseExpired | -10014 | the license is invalid, please contact licensing |
LicenseNotLockedForThisMachine | -10020 | the license is locked to another machine |
YourLicenseRequiresLatestWindows10 | -10024 | your license requires latest Windows 10 version |
LicenseServerReturnedBadRequest | -10400 | Bad license request. Please reach out to SimplygonSupport[at]microsoft.com for support |
ProcessingCap | -10403 | You have reached the maximum number of processings for your license. Please try again in 24 hours or reach out to SimplygonSales@microsoft.com for support.. |
UnknownLicenseKey | -10404 | You are using an unknown license key. Please verify so you typed in the license key correctly and try again |
LicenseIsNotActive | -10410 | You are using an inactive license key. Please reach out to SimplygonSales[at]microsoft.com for support |
MaxNodesReachForThisLicense | -10409 | You have reached the maximum number of nodes for your license. After 48 hours of not using Simplygon on a machine the license will be released and can be installed on another machine |
YourLicenseRequiresLatestSimplygon | -10426 | The license key you are using requires you to update to the latest version before you can use Simplygon |
LicenseServerReturnServerError | -10501 | Bad license request. Please reach out to SimplygonSupport[at]microsoft.com for support |
ProcessingValidationError | -20001 | The process was aborted, because of a validation error. Either the process settings or the input data was invalid, or a combination thereof. Use GetErrorMessages in the main Simplygon object to retrieve error messages, and see the log for details. Note that the library is not left in an exceptional state, and it is safe to continue processing other scenes. |
Syntax
EErrorCodes_* InjectOpacityDataIntoScene(scene: spScene, settings: spAttributeTessellationSamplingSettings, materials: spMaterialTable, textures: spTextureTable)
Parameters
Name | Type | Min | Max | Description |
---|---|---|---|---|
scene | Scene | The scene which is being processed and has data injected into | ||
settings | AttributeTessellationSamplingSettings | Settings for data injection sampling and format. | ||
materials | MaterialTable | Material table used for lookup of opacity channels. | ||
textures | TextureTable | Texture table used for lookup of opacity images. |
Return value
Type: EErrorCodes
Key | Value | Comment |
---|---|---|
EErrorCodes_NoError | 0 | No error, the initialization or process has finished, and with no errors |
EErrorCodes_NoLicense | -1 | no license was found (or licence expired) |
EErrorCodes_NotInitialized | -2 | the SDK is not initialized, or no process object has been loaded/created |
EErrorCodes_AlreadyInitialized | -3 | the SDK is already initialized |
EErrorCodes_DLLOrDependenciesNotFound | -4 | the specified file was not found. This might also mean that a .dll cannot be loaded because there is a missing dependency, such as the runtime environment. |
EErrorCodes_InvalidInputParam | -5 | an invalid parameter was passed to the method |
EErrorCodes_FailedTesting | -6 | the reduction failed post-testing |
EErrorCodes_DLLAndHeaderFileIsNotMatching | -7 | the Simplygon DLL and header file interface versions do not match |
EErrorCodes_DLLFailedToLoad | -8 | the Simplygon DLL failed loading, probably because of a missing dependency |
EErrorCodes_LicenseNotForThisApplication | -9 | the license is not made for this application of Simplygon |
EErrorCodes_LicenseNotForThisPlatform | -10 | the license is not made for this platform of Simplygon |
EErrorCodes_LicenseNotForThisVersion | -11 | the license is not made for this version of Simplygon |
EErrorCodes_FailedToCreatePipelineSerializer | -12 | failed to create pipeline serializer |
EErrorCodes_FailedToRunPipeline | -13 | failed to run pipeline |
EErrorCodes_UnhandledException | -14 | an unhandled exception was encountered |
EErrorCodes_FileError | -15 | a file read/write failed. |
EErrorCodes_InvalidPath | -16 | a path is invalid or a file/directory is missing. |
EErrorCodes_DependencyMissing | -17 | a needed dependency is missing. see log for info on what is missing. |
EErrorCodes_UnexpectedError | -18 | an unexpected error happened. |
EErrorCodes_FailedToUploadFreeLicenseAsset | -50 | failed to upload free license asset |
EErrorCodes_ExceptionalError | -1000 | An exceptional and fatal error occurred, and has been reported to the error handler. The library is placed in an exceptional state, and you should unload and reload the Simplygon library to avoid memory leaks. |
EErrorCodes_FailedToResolveLicenseServerHostName | -10001 | cannot reach the licensing server, cant look up server, check DNS |
EErrorCodes_FailedToConnectToLicenseServer | -10002 | cannot contact the licensing server, check firewall/proxy server |
EErrorCodes_FailedToConnectToLicenseServerAndSendData | -10003 | Failed to connect to the license server. Please check that your internet connection is working and outgoing connections to license.simplygon.com port 443 are not blocked by a firewall or proxy. |
EErrorCodes_FailedToConnectToLicenseServerAndReceiveData | -10004 | cannot receive data from the licensing server, check firewall/proxy server |
EErrorCodes_DataFromLicenseServerIsCorrupt | -10005 | data from licensing server is corrupted, try again, check connection |
EErrorCodes_LicenseHasExpired | -10006 | the license has expired |
EErrorCodes_LicenseIsInvalid | -10007 | the license data is corrupted, please reinstall the license key |
EErrorCodes_LicenseNotForThisProduct | -10008 | the license is not for this product, please contact licensing, and replace license key |
EErrorCodes_NoNetworkCardFound | -10009 | no network card was found on the machine |
EErrorCodes_LicenseDecodeFailed | -10010 | could not decode license, it is corrupted |
EErrorCodes_LicenseLockNotMatchingMachine | -10011 | the license is locked to another machine |
EErrorCodes_ConnectionToLicenseServerLost | -10012 | Connection to license server lost |
EErrorCodes_LicenseHashDataCorrupt | -10013 | could not decode license, it is corrupted |
EErrorCodes_LicenseExpired | -10014 | the license is invalid, please contact licensing |
EErrorCodes_LicenseNotLockedForThisMachine | -10020 | the license is locked to another machine |
EErrorCodes_YourLicenseRequiresLatestWindows10 | -10024 | your license requires latest Windows 10 version |
EErrorCodes_LicenseServerReturnedBadRequest | -10400 | Bad license request. Please reach out to SimplygonSupport[at]microsoft.com for support |
EErrorCodes_ProcessingCap | -10403 | You have reached the maximum number of processings for your license. Please try again in 24 hours or reach out to SimplygonSales@microsoft.com for support.. |
EErrorCodes_UnknownLicenseKey | -10404 | You are using an unknown license key. Please verify so you typed in the license key correctly and try again |
EErrorCodes_LicenseIsNotActive | -10410 | You are using an inactive license key. Please reach out to SimplygonSales[at]microsoft.com for support |
EErrorCodes_MaxNodesReachForThisLicense | -10409 | You have reached the maximum number of nodes for your license. After 48 hours of not using Simplygon on a machine the license will be released and can be installed on another machine |
EErrorCodes_YourLicenseRequiresLatestSimplygon | -10426 | The license key you are using requires you to update to the latest version before you can use Simplygon |
EErrorCodes_LicenseServerReturnServerError | -10501 | Bad license request. Please reach out to SimplygonSupport[at]microsoft.com for support |
EErrorCodes_ProcessingValidationError | -20001 | The process was aborted, because of a validation error. Either the process settings or the input data was invalid, or a combination thereof. Use GetErrorMessages in the main Simplygon object to retrieve error messages, and see the log for details. Note that the library is not left in an exceptional state, and it is safe to continue processing other scenes. |
IsA
Returns true if AttributeTessellation is a or is a descendant of the class named as the type parameter. (Inherited from Object)
Syntax
bool IsA( const char * type ) const;
Parameters
Type | Name | Min | Max | Description |
---|---|---|---|---|
const char * | type | Name of the class to check if AttributeTessellation 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 AttributeTessellation 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 AttributeTessellation is, or is a descendant of. |
Return value
Type: bool
IsNull
Returns true if the AttributeTessellation object is invalid. (Inherited from Object)
IsSameObjectAs
Returns true if the AttributeTessellation object is valid. (Inherited from Object)
Syntax
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
NewTessellatedGeometry
Generates a new tessellated geometry with tessellated attributes applied.
Syntax
spGeometryData NewTessellatedGeometry( const spGeometryData & sourceGeometry ) const;
Parameters
Type | Name | Min | Max | Description |
---|---|---|---|---|
GeometryData | sourceGeometry | The source geometry that is the basis of the tessellation. |
Return value
Type: GeometryData
Syntax
spGeometryData NewTessellatedGeometry(spGeometryData sourceGeometry);
Parameters
Type | Name | Min | Max | Description |
---|---|---|---|---|
GeometryData | sourceGeometry | The source geometry that is the basis of the tessellation. |
Return value
Type: GeometryData
Syntax
spGeometryData NewTessellatedGeometry(sourceGeometry: spGeometryData)
Parameters
Name | Type | Min | Max | Description |
---|---|---|---|---|
sourceGeometry | GeometryData | The source geometry that is the basis of the tessellation. |
Return value
Type: GeometryData
NewTessellatedScene
Generates a new copy of the scene with tessellated geometries which have tessellated attributes applied.
Syntax
spScene NewTessellatedScene( const spScene & scene ) const;
Parameters
Type | Name | Min | Max | Description |
---|---|---|---|---|
Scene | scene | The source scene that is the basis of the tessellation. |
Return value
Type: Scene
Syntax
spScene NewTessellatedScene(spScene scene);
Parameters
Type | Name | Min | Max | Description |
---|---|---|---|---|
Scene | scene | The source scene that is the basis of the tessellation. |
Return value
Type: Scene
Syntax
spScene NewTessellatedScene(scene: spScene)
Parameters
Name | Type | Min | Max | Description |
---|---|---|---|---|
scene | Scene | The source scene that is the basis of the tessellation. |
Return value
Type: Scene
NonNull
Returns true if the AttributeTessellation object is valid. (Inherited from Object)
PrintInfo
Prints the content/info of the AttributeTessellation object to the log. (Inherited from Object)
RemoveObserver
Removes a previously added observer object. (Inherited from Object)
Syntax
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. |
SetupAttributeTessellationOnGeometry
Sets up attribute tessellation setup and primitive tessellation on a single geometry.
Syntax
bool SetupAttributeTessellationOnGeometry( const spGeometryData & geometry , const spAttributeTessellationSettings & settings ) const;
Parameters
Type | Name | Min | Max | Description |
---|---|---|---|---|
GeometryData | geometry | The geometry which will receive attribute tessellation basic setup. | ||
AttributeTessellationSettings | settings | An attribute tessellation setting to apply to all geometries in the scene |
Return value
Type: bool
Syntax
bool SetupAttributeTessellationOnGeometry(spGeometryData geometry, spAttributeTessellationSettings settings);
Parameters
Type | Name | Min | Max | Description |
---|---|---|---|---|
GeometryData | geometry | The geometry which will receive attribute tessellation basic setup. | ||
AttributeTessellationSettings | settings | An attribute tessellation setting to apply to all geometries in the scene |
Return value
Type: bool
Syntax
bool SetupAttributeTessellationOnGeometry(geometry: spGeometryData, settings: spAttributeTessellationSettings)
Parameters
Name | Type | Min | Max | Description |
---|---|---|---|---|
geometry | GeometryData | The geometry which will receive attribute tessellation basic setup. | ||
settings | AttributeTessellationSettings | An attribute tessellation setting to apply to all geometries in the scene |
Return value
Type: bool
SetupAttributeTessellationOnScene
Sets up attribute tessellation and primitive tessellation on a scene.
Syntax
bool SetupAttributeTessellationOnScene( const spScene & scene , const spAttributeTessellationSettings & settings ) const;
Parameters
Type | Name | Min | Max | Description |
---|---|---|---|---|
Scene | scene | The scene whose geometries will receive attribute tessellation setup. | ||
AttributeTessellationSettings | settings | An attribute tessellation setting to apply to all geometries in the scene |
Return value
Type: bool
Syntax
bool SetupAttributeTessellationOnScene(spScene scene, spAttributeTessellationSettings settings);
Parameters
Type | Name | Min | Max | Description |
---|---|---|---|---|
Scene | scene | The scene whose geometries will receive attribute tessellation setup. | ||
AttributeTessellationSettings | settings | An attribute tessellation setting to apply to all geometries in the scene |
Return value
Type: bool
Syntax
bool SetupAttributeTessellationOnScene(scene: spScene, settings: spAttributeTessellationSettings)
Parameters
Name | Type | Min | Max | Description |
---|---|---|---|---|
scene | Scene | The scene whose geometries will receive attribute tessellation setup. | ||
settings | AttributeTessellationSettings | An attribute tessellation setting to apply to all geometries in the scene |
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 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 spAttributeTessellation, and if this is the case, returns the object cast into spAttributeTessellation. (Inherited from Object)
Syntax
static spAttributeTessellation SafeCast( const spObject & object ) const;
Parameters
Type | Name | Min | Max | Description |
---|---|---|---|---|
Object | object | Object to cast. |
Return value
Type: AttributeTessellation
Syntax
static spAttributeTessellation SafeCast(spObject object);
Parameters
Type | Name | Min | Max | Description |
---|---|---|---|---|
Object | object | Object to cast. |
Return value
Type: AttributeTessellation
Syntax
@staticmethod
spAttributeTessellation SafeCast(object: spObject)
Parameters
Name | Type | Min | Max | Description |
---|---|---|---|---|
object | Object | Object to cast. |
Return value
Type: AttributeTessellation