Simplygon 9 Documentation

# class Simplygon

# Properties

Property Description
GlobalAllowDirectXSetting Sets global AllowDirectX setting
GlobalAllowDistributionLocalFallbackSetting Sets global AllowDistributionLocalFallback setting
GlobalAllowGPUAccelerationSetting Sets global AllowGPUAcceleration setting
GlobalAllowShadingNetworkCachingSetting Sets global AllowShadingNetworkCaching setting
GlobalAllowTextureSamplingInterpolationSetting Sets global AllowTextureSamplingInterpolation setting
GlobalAutomaticGuidGenerationSetting Sets global AutomaticGuidGeneration setting
GlobalCacheToDiskSetting Sets global CacheToDisk setting
GlobalDefaultTangentCalculatorTypeSetting Sets global DefaultTangentCalculatorType setting
GlobalEnableLogSetting Sets global EnableLog setting
GlobalFlushLogPerRowSetting Sets global FlushLogPerRow setting
GlobalLogicalCoreLimitSetting Sets global LogicalCoreLimit setting
GlobalLogOutputToTraceWindowSetting Sets global LogOutputToTraceWindow setting
GlobalLogToFileSetting Sets global LogToFile setting
GlobalMaskFPExceptionsSetting Sets global MaskFPExceptions setting
GlobalPreventDirectXThreadingOptimizationsSetting Sets global PreventDirectXThreadingOptimizations setting
GlobalValidateProcessingAssertOnErrorSetting Sets global ValidateProcessingAssertOnError setting
GlobalValidateProcessingDebugLevelSetting Sets global ValidateProcessingDebugLevel setting
GlobalValidateProcessingOutputDirectorySetting Sets global ValidateProcessingOutputDirectory setting
GlobalValidateProcessingSetting Sets global ValidateProcessing setting
GlobalValidRealThresholdSetting Sets global ValidRealThreshold setting
ThreadLocalLogFileNameSetting Sets thread local LogFileName setting

# Methods

Method Description
CreateAggregationPipeline AggregationPipeline provides a pipeline for a single aggregation processor to be applied on the input scene.
CreateAggregationProcessor AggregationProcessor combines all specified geometries in the scene into one geometry. All materials are combined and receive a new shared texture atlas.
CreateAggregationSettings Settings for the AggregationSettings class. The AggregationProcessor converts entire scenes containing multiple draw calls into a single new object with a single texture per material channel. The user can set whether or not the AggregationProcessor should create new UVs based on the old UVs or create a completely new UV parameterization.
CreateAmbientOcclusionCaster AmbientOcclusionCaster generates an ambient occlusion map based on the original geometry, and casts it.
CreateAmbientOcclusionCasterSettings AmbientOcclusionCasterSettings manages settings for an ambient occlusion caster.
CreateArray Array is the base class for the array objects. The object contains a dynamically allocated list of tuples of the same length, which can be specified before the list is filled with values.
CreateBillboardCloudPipeline BillboardCloudPipeline provides a pipeline for a billboard cloud impostor processor to be applied on the input scene.
CreateBillboardCloudSettings Settings for the ImpostorType: BillboardCloud
CreateBillboardCloudVegetationPipeline BillboardCloudPipeline provides a pipeline for a billboard cloud vegetation impostor processor to be applied on the input scene.
CreateBinaryExporter BinaryExporter stores the geometry data into a binary file, that is specific for Simplygon. Please note that the binary file is only intended for temporary storage, and that no compatibility between versions of Simplygon is guaranteed.
CreateBinaryImporter BinaryImporter loads the geometry data from a binary file, that is specific for Simplygon. Please note that the binary file is only intended for temporary storage, and that no compatibility between versions of Simplygon is guaranteed.
CreateBoneSettings Settings for the Simplygon Reduction/Remeshing classes With the BoneSettings object, the user can setup all the parameters for how the BoneLOD processor should simplify the links between geometries and bones. Bones can be un-linked from the geometry either with a set ratio or depending on a selected pixel size on screen.
CreateBoolArray BoolArray is the bool implementation of ValueArray. See ValueArray for a description.
CreateCharArray CharArray is the char implementation of ValueArray. See ValueArray for a description.
CreateChartAggregator Computes new texture coordinates for a geometry with overlapping UV charts.
CreateChartAggregatorSettings Settings for the chart aggregator.
CreateChunkedImageData ChunkedImageData holds chunks for ImageData objects. ImageData objects can be referenced, and swapped in/out of memory, to secondary storage. This is useful for very large images that cannot be stored in-memory. ImageData objects can be indexed in 1-,2- or 3D, and each ImageData chunk is cloned from a source ImageData object, at setup. Fields added to ImageData chunks after setup will only be added into that chunk, and is not recommended.
CreateColorCaster ColorCaster is the interface used to cast basic color values. Currently supported material color value types are Ambient, Diffuse and Specular + Shininess.
CreateColorCasterSettings ColorCasterSettings is the interface for basic color caster settings.
CreateDirectXRenderer A Renderer using DirectX 11 that can be used to preview a scene object containing geometry data by rendering it from selected SceneCamera nodes within the given scene and then storing the frames to disc. If using a Shading Node Network (having an IShadingNode assigned to the IMaterial), then the material can be previewed with the generated HLSL shader.
CreateDisplacementCaster DisplacementCaster is used to store the delta-values between the original and processed geometries. The values are divided by a scaling value, and clamped into the -1 -> 1 range before being stored into an image.
CreateDisplacementCasterSettings DisplacementCasterSettings is used to store the settings for a displacement caster
CreateDoubleArray DoubleArray is the double implementation of ValueArray. See ValueArray for a description.
CreateFBXExporter FBX scene exporter.
CreateFBXImporter FBX scene importer
CreateFieldData FieldData represents multiple fields of data. Each field is implemented as an ValueArray object, that has a unique name, and can have complex components (such as scalars, vectors, quaternions, tensors or matrices). All fields are assumed to be of the same length. IFieldData can be seen as an array with complex tuples, where the component can be of different types.
CreateFlipbookPipeline FlipbookPipeline provides a pipeline for a flipbook impostor processor to be applied on the input scene.
CreateFlipbookSettings Settings for the ImpostorType: FlipBook
CreateFloatArray FloatArray is the float implementation of ValueArray. See ValueArray for a description.
CreateFoliageSettings Settings for the BillboardMode: Foliage
CreateGenerateLightmapTexCoordSettings GenerateLightmapTexCoordSettings is the interface used to manage light map uv generation.
CreateGeometryCullingSettings Settings for volumetric triangle culling functionality. These settings control the clipping planes and geometries that are used for triangle culling the output of Simplygon scene processors.
CreateGeometryData GeometryData represents a geometric structure consisting of point data (Vertices) and topological data (Triangles). GeometryData may represent a whole geometric object, but can also be used by streaming data filters, and in this way, only represents a part of the object. Different fields in the Vertices and Triangles fields data objects will contain point data and topological data. The standard naming convention used in the filters/renderers are as follows: (Case sensitive naming, other fields may also be present) 'Coords' Positional coordinates of a vertex, expressed with a 3-component real field (XYZ). 'TexCoords0' - 'TexCoords255' Texture coordinates of a vertex, expressed with a 2 components real field. By convention, the existing fields must be sequential, and must start with 'TexCoord0'. 'Normals' Normal vector for the vertex, expressed with a 3-component real field, a normalized (XYZ) vector. 'VertexIds' The id of the current vertex in the primitive. This field is present even if the vertex data is directly specified in the primitive data, to specify topology. The field is of type rid. 'MaterialIds' The material of the primitive. The field is of type rid. The 'Coords' and 'VertexIds' fields always exist in the object, but the other fields are optional. Also, there can exist user fields.
CreateGeometryDataCaster GeometryDataCaster is used to cast original GeometryData information to an image using mapping image
CreateGeometryDataCasterSettings GeometryDataCasterSettings is the interface used to manage settings for GeometryDataCaster
CreateGeometryDataCollection GeometryDataCollection holds a number of GeometryData objects. The objects can be looked up by their names (if they have been named with a call to SetName).
CreateGeometryValidator Checks the geometry for consistent indices, number of triangles etc.
CreateGLTFExporter glTF geometry exporter capable of exporting both glTF and GLB files determined by output path extension. Textures and binary blob files for glTF export will be placed alongside the glTF file and have names prefixed by the output file name. Note that any normal textures for the scene must be in tangent space, as generated by a normal caster with SetGenerateTangentSpaceNormals set to true.
CreateGLTFImporter glTF scene importer
CreateGraphicsExporter Base class for graphics export classes
CreateGraphicsImporter Base class for graphics import classes
CreateImageComparer Compares images.
CreateImageData ImageData holds unpacked image data. The data is stored in an FieldData object as value fields. For simplicity all images are implemented as 3D images, but has an extent of 1 in Z for 2D images, and an extent of 1 in both Y and Z for 1D images. Cube maps are stored as a 3D image with Z-depth of 6 (one for each side)
CreateImageDataExporter Class for saving image data to different file formats.
CreateImageDataImporter Class for loading image data from different file formats.
CreateImpostorFromSingleViewPipeline ImpostorFromSingleViewPipeline provides a pipeline for a impostor from single view impostor processor to be applied on the input scene.
CreateImpostorFromSingleViewSettings Settings for the ImpostorType: ImpostorFromSingleView.
CreateImpostorProcessor The ImpostorProcessor generates an impostor of one of these impostor types: BillboardCloud, Flipbook or ImpostorFromSingleView.
CreateImpostorSettings Settings for the ImpostorProccessor
CreateIntArray IntArray is the int implementation of ValueArray. See ValueArray for a description.
CreateLongArray LongArray is the long implementation of ValueArray. See ValueArray for a description.
CreateMappingImage MappingImage stores the mapping between a processed geometry and the source geometry it is based on. The mapping image object also stores multisampling settings. It can be used to cast information from the original geometry to the processed geometry, such as surface transfer or calculating normal maps. See IMaterialCaster and subclasses for casting uses.
CreateMappingImageInputMaterialSettings Settings for the Simplygon mapping input.
CreateMappingImageMeshData MappingImageMeshData stores the mapped meshes and their paths in the original scene. This can be used to find a specific triangle on the original mesh in the scene from the combined id in the mapping image.
CreateMappingImageOutputMaterialSettings Settings for the Simplygon mapping output.
CreateMappingImageSettings Settings for the Simplygon mapping classes These settings control the properties of the mapping image that will be generated in the current simplification processor (reducer/remesher etc). The mapping image will be used when casting a new texture on the simplified geometry. In the settings object, the user is able to set the dimensions of the image (width/height) as well as whether the LOD should have new texture coordinates and some parameters for how they should be generated and all other settings regarding the mapping image.
CreateMaterial Material object that keeps material information used while rendering.
CreateMaterialCaster MaterialCaster is the base interface for material casting interfaces. The interface exports methods for defining input geometries & mapping image, materials, output image paths & formats
CreateMaterialCasterSettings MaterialCasterSettings is the base interface for material casting settings
CreateMaterialTable MaterialTable keeps information on materials used while rendering.
CreateMatrix4x4 Matrix4x4 is used to represent and manipulate 4x4 transformation matrices, which can be either standard matrices, or homogeneous 4x4 matrices used to transform 3D homogeneous coordinates [x y z w]. The transformations are defined in row-major order.
CreateNormalCalculationSettings Settings for the normal recalculation
CreateNormalCaster NormalCaster is the interface used to cast normals data onto the receiving geometry.
CreateNormalCasterSettings NormalCasterSettings is the interface used to manage settings for a normal caster
CreateNormalRepairer Repairs normals on a processed geometry.
CreateObjectCollection ObjectCollection and its specializations handles a collection of Objects. There are methods for adding, removing and iterating through the objects.
CreateOcclusionMeshProcessor The occlusion mesh processor creates a reconstruction of the input mesh from its silhouette. This means concavities and internal geometry disappear. WARNING: Experimental. Generates nice meshes, but currently very slow at high settings. Recommended onscreens size ~100
CreateOcclusionMeshSettings Settings for occlusion meshes
CreateOpacityCaster OpacityCaster is the interface used to cast opacity values. To be used when opacity is needed as a separate texture. IMPORTANT: Make sure to set OpacityChannel to the channel you want to cast, since this caster bakes opacity rather than the channel set in the MaterialChannel setting like most other casters.
CreateOpacityCasterSettings OpacityCasterSettings is the interface used to manage settings for an opacity caster. IMPORTANT: Make sure to set the OpacityChannel setting to the channel you want to cast, since this caster bakes opacity rather than the channel set in the MaterialChannel setting like most other casters.
CreatePackedGeometryData PackedGeometryData keeps the same information as GeometryData, but with all corner data fields moved into per-vertex fields. No per-corner fields exist, apart from the VertexIds field. Please note that the number of vertices in an PackedGeometryData is commonly higher than in an GeometryData, as vertices must be split to accommodate for different corner data.
CreateParameterizer Computes texture coordinates for arbitrary geometry.
CreateParameterizerSettings Settings for the parameterizer.
CreatePartRemover The PartRemover tool can identify unconnected sub-meshes, and remove meshes that fall below a set size threshold. This size threshold can be set globally for the entire geometry, or per-material to be able to remove things like decals effectively.
CreatePassthroughPipeline PassthroughPipeline provides an empty pipeline for creating a cascading pipeline using a single dummy root node. It does not process the input scene in any way.
CreatePipeline Pipeline is the interface for a processing pipeline, which applies a number of processing opearations on an input scene to generate an output scene. The input and output scenes can be any file format supported by Simplygon.
CreatePipelineBatch Control object to launch pipelines in batches, both locally and distributed
CreatePipelineSerializer
CreatePipelineSettings PipelineSettings is the interface used to manage settings for a pipeline
CreateProcessingObject ProcessingObject is the abstract base class for all processing objects in Simplygon. Processing objects take parameters, exports the RunProcessing to run the main processing and Clear to clear the internal states of the processing object. All processing objects also export information on how far the process has moved and the possibility to cancel long running processings.
CreateRealArray RealArray is the real implementation of ValueArray. See ValueArray for a description.
CreateRecommendedTextureSizeCalculator Estimates a coarse recommended UV size (width and height) for a geometry based on only its surface area and either the distance it is allowed to deviate or its intended on screen size. The UVs are assumed to be unique i.e. not tiled/repeated. RecommendedWidth and RecommendedHeight will only differ from each other if ForcePower2Texture is enabled.
CreateReductionPipeline ReductionPipeline provides a pipeline for a single reduction processor to be applied on the input scene.
CreateReductionProcessor ReductionProcessor welds, removes t-junctions, removes double-triangles and reduces the triangle count of the Geometry. It also calculates new normals for the reduced and optimized Geometry.
CreateReductionSettings Settings for the ReductionProcessor class. Handles all the settings for Simplygons simplification algorithms. The user can tell the reduction processor which features are important by using the 'FeatureFlags' parameter, and also the relative importance of these features using the Set{feature}Importance methods. Also settings for things like symmetry are set here.
CreateRemeshingLegacyPipeline RemeshingLegacyPipeline provides a pipeline for a single remeshing legacy processor to be applied on the input scene.
CreateRemeshingLegacyProcessor RemeshingLegacyProcessor creates a new geometry that is based on the input geometry, but that is topologically based on the size of the input geometry rendered at a specific screen size, and allowed pixel error. The remesher will on demand also add texture coordinates and a mapping texture to the output remeshed geometry. The geometry that is to be remeshed can be defined either using an in-memory geometry data object, or using a geometry file placed on disk, the latter being the preferred method, if the source geometry is very large as it can be swapped in/out of memory as needed.
CreateRemeshingLegacySettings Remeshing settings for the RemeshingLegacyProcessor class. The remesher creates a completely new lightweight mesh from the input geometry, and is intended to be viewed from the outside. Here you will set the OnScreenSize (larger numbers means a more detailed mesh), merge distance (which fills in smaller gaps) and a cutting plane (where all parts of the input mesh on the far side of that plane will be culled).
CreateRemeshingPipeline RemeshingPipeline provides a pipeline for a single remeshing processor to be applied on the input scene.
CreateRemeshingProcessor The RemeshingProcessor takes an input scene and replaces it with a lightweight proxy geometry that resembles the original, but does not share vertex data or parts of the original mesh data. The remeshed object is created and optimized for a certain on-screen pixel size - which means that holes and parts that are close to each other will have their gaps filled if the distance is below a pixel. At default settings, the proxy mesh is assumed to be viewed from the outside. Any interior mesh that cannot be seen is removed. The result is a very light-weight mesh that is highly optimized for real-time viewing, or to speed up off-line rendering of small objects. Simplygon is capable of remeshing arbitrary geometry, including non-manifold surfaces.
CreateRemeshingSettings Remeshing settings for the RemeshingProcessor class.
CreateRepairSettings Settings for handling unconnected parts and unwanted gaps in the geometry. It consists of two parts, Welding and T-junction removal. Welding merges vertices that are closer than a set distance from each other. T-junction removal finds open edges that lies within a set distance from other open edges, but without matching vertices. It then splits those triangles into smaller, matching triangles and fuses them together.
CreateRidArray RidArray is the rid implementation of ValueArray. See ValueArray for a description.
CreateScene Scene is the main keeper of a scene and scene graph in simplygon. The scene is self-contained, with materials, textures, etc. to describe a full scene.
CreateSceneBone SceneBone is the bone node in the simplygon scene graph
CreateSceneBoneTable SceneBoneTable keeps information on bones used while rendering.
CreateSceneCamera SceneCamera is the camera node in the Simplygon scene graph. SceneCamera contains settings that specify how the camera works and it contains a number of views for that type of camera. A view is a combination of a CameraPosition and a TargetPosition. The SceneCamera can contain any number of views but every element in TargetPositions has to correspond to a tuple element in CameraPosition. TargetPositions is not needed if the camera is set to being omni directional.
CreateSceneExporter Class for saving scene data to different file formats depending on the extension of the set file name.
CreateSceneImporter Class for loading scene data from different file formats.
CreateSceneLodGroup SceneLodGroup is a LOD grouping for the scene graph
CreateSceneMesh SceneMesh is the mesh node in the simplygon scene graph
CreateSceneNode SceneNode is the base class for all scene graph nodes in simplygon. It has relative transformation to its parent, and functions to add children to the node.
CreateSceneNodeCollection SceneNodeCollection holds a number of SceneNode objects. The objects can be looked up by their names (if they have been named through SetName()).
CreateScenePlane ScenePlane is the plane node in the simplygon scene graph that can be used in various processes, for example as a cutting plane in the RemeshingProcessor.
CreateSelectionSet SelectionSet is a set of scene node GUIDs referencing scene nodes in a scene.
CreateSelectionSetTable SelectionSetTable keeps a table of SelectionSet.
CreateSettingsObject SettingsObject is the abstract base class for all settings objects in Simplygon. Settings objects contains parameters for processing objects to use. These settings objects will have their data set and reached from a ProcessingObject and then used therein.
CreateShaderGenerator Given a material, the shader data class keeps the relevant shader data and is able to generate a GLSL/HLSL shader.
CreateShadingAddNode AddNode describes a single addition shading node in a shading network. Input 1 and 2 are added per-component to produce the output.
CreateShadingClampNode ClampNode describes a single clamp shading node in a shading network. Input 1 is clamped per-component between Input 2 and 3.
CreateShadingColorNode ColorNode describes a single color source node in a shading network
CreateShadingCosNode This node describes cosine of the x,y,z,w components of the input.
CreateShadingCross3Node This node describes the cross of the x,y,z components of the input.
CreateShadingCustomNode CustomNode describes a custom shading node in a shading network. The output is produced based on customizable user specified operations. The custom node has a user specified amount of input parameters. Use SetInputCount() to specify the number of inputs. The user has to assign and implement event handlers (called observers) for the custom node to be able to evaluate to colors. See CustomNodeExample and API documentation for further explanations and code samples.
CreateShadingDivideNode DivideNode describes a single division shading node node in a shading network. Input 1 is divided by Input 2 per-component to produce the output.
CreateShadingDot3Node This node describes an dot of the x,y,z components of the inputs.
CreateShadingEqualNode ShadingEqualNode describes an "is equal to" operator, where the per-component output is either 1 or 0 depending on if input0 is equal to input1. Basically, (Input0 == Input1) ? 1 : 0
CreateShadingFilterNode FilterNode is the parent of all non-source nodes in a shading network.
CreateShadingGeometryFieldNode Geometry field node describes a source node for geometry field data in a shading network, such as normals and tangents.
CreateShadingGreaterThanNode GreaterThanNode describes the "is greater than" operator, where the per-component output is either 1 or 0 depending on if input0 is greater than input1. Basically, (Input0 > Input1) ? 1 : 0
CreateShadingInterpolateNode InterpolateNode describes a single interpolating shading node node in a shading network. Input 1 and Input 2 is interpolated per-component using Input 3. Blend values below 0 and over 1 will be clamped.
CreateShadingLayeredBlendNode LayeredBlendNode is a node with an arbitrary number of inputs that can be blended differently.
CreateShadingLessThanNode LessThanNode describes the "is less than" operator, where the per-component output is either 1 or 0 depending on if input0 is LessThan to input1. Basically, (Input0 < Input1) ? 1 : 0
CreateShadingMaxNode MaxNode describes a single max shading node in a shading network. The output has the per-channel max values of the two inputs.
CreateShadingMinNode MinNode describes a single min shading node in a shading network. The output has the per-channel min values of the two inputs.
CreateShadingMultiplyNode MultiplyNode describes a single multiplying shading node in a shading network. Input 1 and Input 2 is multiplied per-component.
CreateShadingNode ShadingNode is the parent of all nodes in a shading network.
CreateShadingNormalize3Node This node describes an normalization of the x,y,z components of the input.
CreateShadingNotEqualNode NotEqualNode describes the "is not equal" operator, where the per-component output is either 1 or 0 depending on if input0 is equal to input1. Basically, (Input0 != Input1) ? 1 : 0
CreateShadingPowNode This node describes an exponentiation. The output will be Input 1 to the power of Input 2, and it is calculated per-component.
CreateShadingSinNode This node describes Sin of the x,y,z components of the input.
CreateShadingSqrtNode This node describes a square root calculation. The output will be the per-component square root of input 1
CreateShadingStepNode StepNode describes a single step shading node, where the per-component output is either 1 or 0 depending on if input0 is larger or smaller than input1. Basically, (Input0 >= Input1) ? 1 : 0
CreateShadingSubtractNode SubtractNode describes a single subtracting shading node in a shading network. Input 2 is subtracted from input 1 per-component.
CreateShadingSwizzlingNode SwizzlingNode describes a node that can remap the input to the specified output.
CreateShadingTextureNode TextureNode describes a texture source node in a shading network.
CreateShadingVertexColorNode VertexColorNode describes a vertex color source node in a shading network.
CreateShortArray ShortArray is the short implementation of ValueArray. See ValueArray for a description.
CreateStringArray StringArray is the string implementation of ValueArray. See ValueArray for a description.
CreateSurfaceMapper ISurfaceMapper creates a mapping image between two user-defined geometries. The mapper basically looks for the source geometry in the inverse normal direction from the outwardly offset destination geometry, and maps pixels accordingly. This means that you can modify the normals of the destination geometry to adjust the search direction to your liking. The geometries can either be set as IGeometryDatas or as the root nodes of scenes. If both are set, the scene is used. If only a single source or a destination is set, or if the source and destination are the same scene or geometry, the surface mapper will map the mesh onto itself.
CreateTable Table is the base class for tables objects, where items are added into an id-indexed array of objects.
CreateTangentCalculator TangentCalculator calculates tangent vectors for geometry data objects. One corner field of texture coordinates must exist, as well as normals. The tangents are placed into two corner fields called "Tangents" and "Bitangents". If any of these fields already exists, it is replaced by the new field.
CreateTexture Texture describes a texture object, containing either image data or a path that is referenced by texture nodes in materials.
CreateTextureTable TextureTable keeps information on textures used while rendering.
CreateTJunctionEliminator Removes t-junctions by subdividing triangles and welding vertices
CreateTransform3 Transform3 handles homogeneous 4x4 transforms, i.e. transformations which can be represented by multiplying a 4x4 matrix with a homogeneous 3D coordinate. Transform3 can either pre-multiply a matrix onto the transformation, which will add a transform around the current transform, or it can post-multiply the matrix, which will add a transform inside the current transform. Post-multiply is the default mode.
CreateUnsignedCharArray UnsignedCharArray is the uchar implementation of ValueArray. See ValueArray for a description.
CreateUnsignedIntArray UnsignedIntArray is the uint implementation of ValueArray. See ValueArray for a description.
CreateUnsignedLongArray UnsignedLongArray is the ulong implementation of ValueArray. See ValueArray for a description.
CreateUnsignedShortArray UnsignedShortArray is the ushort implementation of ValueArray. See ValueArray for a description.
CreateValueArray ValueArray adds methods to arrays to generically add, set and get tuples, through real values.
CreateVertexColorCaster VertexColorCaster.
CreateVertexColorCasterSettings VertexColorCasterSettings is the interface for basic vertex color caster settings.
CreateVertexWeightSettings This settings object contains all settings related to how the user-set weighting field "VertexWeights" is setup and used in different contexts. The values in the field can be considered an "importance" factor. Generally, weights set to 1.0 are handled normally, values >1.0 are given greater importance, and values <1.0 are given less. These weights can either be manually set in the input geometry data or converted from vertex color sets using the WeightsFromColor settings. See the documentation of the WeightsFromColorMode property to see the details of how color intensity is mapped to vertex weight. Vertex weights can be used to reduce more or less aggressively on different parts of the mesh, or used to scale UV allocation in the parameterizers to give more or less texture area to different areas.
CreateVisibilitySettings Visibility settings contains the parameters for how to compute the visibility of a scene and how to use it, both in the ReductionProcessor and the RemeshingProcessor. The visibility information is computed for each part of the mesh determined by the visibility from the selected SceneCamera objects. Cameras are selected using the CameraSelectionSetID. The visibility can be used to guide the reducer and/or texture coordinates generator (parameterizer) with the flags UseVisibilityWeightsInReducer respective UseVisibilityWeightsInTexcoordGenerator. There is also an option to completely throw away triangles that are deemed not visible, using the CullOccludedGeometry flag.
CreateWavefrontExporter Wavefront .obj geometry exporter.
CreateWavefrontImporter OBJ scene importer
CreateWelder Welds vertices within the geometry or scene together.
GetVersion Get the current version of Simplygon

# Properties details

# GlobalAllowDirectXSetting

Sets global AllowDirectX setting

# Syntax

// Setter
void SetGlobalAllowDirectXSetting( bool value );

// Getter
bool GetGlobalAllowDirectXSetting();

# SetGlobalAllowDirectXSetting parameters

Type Name Min Max Description
bool value is the value we want to set the global AllowDirectX setting to.

# GetGlobalAllowDirectXSetting return value

Type: bool

# GlobalAllowDistributionLocalFallbackSetting

Sets global AllowDistributionLocalFallback setting

# Syntax

// Setter
void SetGlobalAllowDistributionLocalFallbackSetting( bool value );

// Getter
bool GetGlobalAllowDistributionLocalFallbackSetting();

# SetGlobalAllowDistributionLocalFallbackSetting parameters

Type Name Min Max Description
bool value is the value we want to set the global AllowDistributionLocalFallback setting to.

# GetGlobalAllowDistributionLocalFallbackSetting return value

Type: bool

# GlobalAllowGPUAccelerationSetting

Sets global AllowGPUAcceleration setting

# Syntax

// Setter
void SetGlobalAllowGPUAccelerationSetting( bool value );

// Getter
bool GetGlobalAllowGPUAccelerationSetting();

# SetGlobalAllowGPUAccelerationSetting parameters

Type Name Min Max Description
bool value is the value we want to set the global AllowGPUAcceleration setting to.

# GetGlobalAllowGPUAccelerationSetting return value

Type: bool

# GlobalAllowShadingNetworkCachingSetting

Sets global AllowShadingNetworkCaching setting

# Syntax

// Setter
void SetGlobalAllowShadingNetworkCachingSetting( bool value );

// Getter
bool GetGlobalAllowShadingNetworkCachingSetting();

# SetGlobalAllowShadingNetworkCachingSetting parameters

Type Name Min Max Description
bool value is the value we want to set the global AllowShadingNetworkCaching setting to.

# GetGlobalAllowShadingNetworkCachingSetting return value

Type: bool

# GlobalAllowTextureSamplingInterpolationSetting

Sets global AllowTextureSamplingInterpolation setting

# Syntax

// Setter
void SetGlobalAllowTextureSamplingInterpolationSetting( bool value );

// Getter
bool GetGlobalAllowTextureSamplingInterpolationSetting();

# SetGlobalAllowTextureSamplingInterpolationSetting parameters

Type Name Min Max Description
bool value is the value we want to set the global AllowTextureSamplingInterpolation setting to.

# GetGlobalAllowTextureSamplingInterpolationSetting return value

Type: bool

# GlobalAutomaticGuidGenerationSetting

Sets global AutomaticGuidGeneration setting

# Syntax

// Setter
void SetGlobalAutomaticGuidGenerationSetting( bool value );

// Getter
bool GetGlobalAutomaticGuidGenerationSetting();

# SetGlobalAutomaticGuidGenerationSetting parameters

Type Name Min Max Description
bool value is the value we want to set the global AutomaticGuidGeneration setting to.

# GetGlobalAutomaticGuidGenerationSetting return value

Type: bool

# GlobalCacheToDiskSetting

Sets global CacheToDisk setting

# Syntax

// Setter
void SetGlobalCacheToDiskSetting( bool value );

// Getter
bool GetGlobalCacheToDiskSetting();

# SetGlobalCacheToDiskSetting parameters

Type Name Min Max Description
bool value is the value we want to set the global CacheToDisk setting to.

# GetGlobalCacheToDiskSetting return value

Type: bool

# GlobalDefaultTangentCalculatorTypeSetting

Sets global DefaultTangentCalculatorType setting

# Syntax

// Setter
void SetGlobalDefaultTangentCalculatorTypeSetting( spETangentSpaceMethod value );

// Getter
spETangentSpaceMethod GetGlobalDefaultTangentCalculatorTypeSetting();

# SetGlobalDefaultTangentCalculatorTypeSetting parameters

Type Name Min Max Description
ETangentSpaceMethod value is the value we want to set the global DefaultTangentCalculatorType setting to.

# GetGlobalDefaultTangentCalculatorTypeSetting return value

Type: ETangentSpaceMethod

# GlobalEnableLogSetting

Sets global EnableLog setting

# Syntax

// Setter
void SetGlobalEnableLogSetting( bool value );

// Getter
bool GetGlobalEnableLogSetting();

# SetGlobalEnableLogSetting parameters

Type Name Min Max Description
bool value is the value we want to set the global EnableLog setting to.

# GetGlobalEnableLogSetting return value

Type: bool

# GlobalFlushLogPerRowSetting

Sets global FlushLogPerRow setting

# Syntax

// Setter
void SetGlobalFlushLogPerRowSetting( bool value );

// Getter
bool GetGlobalFlushLogPerRowSetting();

# SetGlobalFlushLogPerRowSetting parameters

Type Name Min Max Description
bool value is the value we want to set the global FlushLogPerRow setting to.

# GetGlobalFlushLogPerRowSetting return value

Type: bool

# GlobalLogicalCoreLimitSetting

Sets global LogicalCoreLimit setting

# Syntax

// Setter
void SetGlobalLogicalCoreLimitSetting( unsigned int value );

// Getter
unsigned int GetGlobalLogicalCoreLimitSetting();

# SetGlobalLogicalCoreLimitSetting parameters

Type Name Min Max Description
unsigned int value is the value we want to set the global LogicalCoreLimit setting to.

# GetGlobalLogicalCoreLimitSetting return value

Type: unsigned int

# GlobalLogOutputToTraceWindowSetting

Sets global LogOutputToTraceWindow setting

# Syntax

// Setter
void SetGlobalLogOutputToTraceWindowSetting( bool value );

// Getter
bool GetGlobalLogOutputToTraceWindowSetting();

# SetGlobalLogOutputToTraceWindowSetting parameters

Type Name Min Max Description
bool value is the value we want to set the global LogOutputToTraceWindow setting to.

# GetGlobalLogOutputToTraceWindowSetting return value

Type: bool

# GlobalLogToFileSetting

Sets global LogToFile setting

# Syntax

// Setter
void SetGlobalLogToFileSetting( bool value );

// Getter
bool GetGlobalLogToFileSetting();

# SetGlobalLogToFileSetting parameters

Type Name Min Max Description
bool value is the value we want to set the global LogToFile setting to.

# GetGlobalLogToFileSetting return value

Type: bool

# GlobalMaskFPExceptionsSetting

Sets global MaskFPExceptions setting

# Syntax

// Setter
void SetGlobalMaskFPExceptionsSetting( bool value );

// Getter
bool GetGlobalMaskFPExceptionsSetting();

# SetGlobalMaskFPExceptionsSetting parameters

Type Name Min Max Description
bool value is the value we want to set the global MaskFPExceptions setting to.

# GetGlobalMaskFPExceptionsSetting return value

Type: bool

# GlobalPreventDirectXThreadingOptimizationsSetting

Sets global PreventDirectXThreadingOptimizations setting

# Syntax

// Setter
void SetGlobalPreventDirectXThreadingOptimizationsSetting( bool value );

// Getter
bool GetGlobalPreventDirectXThreadingOptimizationsSetting();

# SetGlobalPreventDirectXThreadingOptimizationsSetting parameters

Type Name Min Max Description
bool value is the value we want to set the global PreventDirectXThreadingOptimizations setting to.

# GetGlobalPreventDirectXThreadingOptimizationsSetting return value

Type: bool

# GlobalValidateProcessingAssertOnErrorSetting

Sets global ValidateProcessingAssertOnError setting

# Syntax

// Setter
void SetGlobalValidateProcessingAssertOnErrorSetting( bool value );

// Getter
bool GetGlobalValidateProcessingAssertOnErrorSetting();

# SetGlobalValidateProcessingAssertOnErrorSetting parameters

Type Name Min Max Description
bool value is the value we want to set the global ValidateProcessingAssertOnError setting to.

# GetGlobalValidateProcessingAssertOnErrorSetting return value

Type: bool

# GlobalValidateProcessingDebugLevelSetting

Sets global ValidateProcessingDebugLevel setting

# Syntax

// Setter
void SetGlobalValidateProcessingDebugLevelSetting( unsigned int value );

// Getter
unsigned int GetGlobalValidateProcessingDebugLevelSetting();

# SetGlobalValidateProcessingDebugLevelSetting parameters

Type Name Min Max Description
unsigned int value is the value we want to set the global ValidateProcessingDebugLevel setting to.

# GetGlobalValidateProcessingDebugLevelSetting return value

Type: unsigned int

# GlobalValidateProcessingOutputDirectorySetting

Sets global ValidateProcessingOutputDirectory setting

# Syntax

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

// Getter
spString GetGlobalValidateProcessingOutputDirectorySetting();

# SetGlobalValidateProcessingOutputDirectorySetting parameters

Type Name Min Max Description
const char * value is the value we want to set the global ValidateProcessingOutputDirectory setting to.

# GetGlobalValidateProcessingOutputDirectorySetting return value

Type: spString

# GlobalValidateProcessingSetting

Sets global ValidateProcessing setting

# Syntax

// Setter
void SetGlobalValidateProcessingSetting( bool value );

// Getter
bool GetGlobalValidateProcessingSetting();

# SetGlobalValidateProcessingSetting parameters

Type Name Min Max Description
bool value is the value we want to set the global ValidateProcessing setting to.

# GetGlobalValidateProcessingSetting return value

Type: bool

# GlobalValidRealThresholdSetting

Sets global ValidRealThreshold setting

# Syntax

// Setter
void SetGlobalValidRealThresholdSetting( float value );

// Getter
float GetGlobalValidRealThresholdSetting();

# SetGlobalValidRealThresholdSetting parameters

Type Name Min Max Description
float value is the value we want to set the global ValidRealThreshold setting to.

# GetGlobalValidRealThresholdSetting return value

Type: float

# ThreadLocalLogFileNameSetting

Sets thread local LogFileName setting

# Syntax

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

// Getter
spString GetThreadLocalLogFileNameSetting();

# SetThreadLocalLogFileNameSetting parameters

Type Name Min Max Description
const char * value is the value we want to set the thread local LogFileName setting to.

# GetThreadLocalLogFileNameSetting return value

Type: spString

# Methods details

# CreateAggregationPipeline

AggregationPipeline provides a pipeline for a single aggregation processor to be applied on the input scene.

# Syntax

spAggregationPipeline CreateAggregationPipeline();

# Parameters

CreateAggregationPipeline takes no parameters.

# Return value

Type: AggregationPipeline

# CreateAggregationProcessor

AggregationProcessor combines all specified geometries in the scene into one geometry. All materials are combined and receive a new shared texture atlas.

# Syntax

spAggregationProcessor CreateAggregationProcessor();

# Parameters

CreateAggregationProcessor takes no parameters.

# Return value

Type: AggregationProcessor

# CreateAggregationSettings

Settings for the AggregationSettings class. The AggregationProcessor converts entire scenes containing multiple draw calls into a single new object with a single texture per material channel. The user can set whether or not the AggregationProcessor should create new UVs based on the old UVs or create a completely new UV parameterization.

# Syntax

spAggregationSettings CreateAggregationSettings();

# Parameters

CreateAggregationSettings takes no parameters.

# Return value

Type: AggregationSettings

# CreateAmbientOcclusionCaster

AmbientOcclusionCaster generates an ambient occlusion map based on the original geometry, and casts it.

# Syntax

spAmbientOcclusionCaster CreateAmbientOcclusionCaster();

# Parameters

CreateAmbientOcclusionCaster takes no parameters.

# Return value

Type: AmbientOcclusionCaster

# CreateAmbientOcclusionCasterSettings

AmbientOcclusionCasterSettings manages settings for an ambient occlusion caster.

# Syntax

spAmbientOcclusionCasterSettings CreateAmbientOcclusionCasterSettings();

# Parameters

CreateAmbientOcclusionCasterSettings takes no parameters.

# Return value

Type: AmbientOcclusionCasterSettings

# CreateArray

Array is the base class for the array objects. The object contains a dynamically allocated list of tuples of the same length, which can be specified before the list is filled with values.

# Syntax

spArray CreateArray();

# Parameters

CreateArray takes no parameters.

# Return value

Type: Array

# CreateBillboardCloudPipeline

BillboardCloudPipeline provides a pipeline for a billboard cloud impostor processor to be applied on the input scene.

# Syntax

spBillboardCloudPipeline CreateBillboardCloudPipeline();

# Parameters

CreateBillboardCloudPipeline takes no parameters.

# Return value

Type: BillboardCloudPipeline

# CreateBillboardCloudSettings

Settings for the ImpostorType: BillboardCloud

# Syntax

spBillboardCloudSettings CreateBillboardCloudSettings();

# Parameters

CreateBillboardCloudSettings takes no parameters.

# Return value

Type: BillboardCloudSettings

# CreateBillboardCloudVegetationPipeline

BillboardCloudPipeline provides a pipeline for a billboard cloud vegetation impostor processor to be applied on the input scene.

# Syntax

spBillboardCloudVegetationPipeline CreateBillboardCloudVegetationPipeline();

# Parameters

CreateBillboardCloudVegetationPipeline takes no parameters.

# Return value

Type: BillboardCloudVegetationPipeline

# CreateBinaryExporter

BinaryExporter stores the geometry data into a binary file, that is specific for Simplygon. Please note that the binary file is only intended for temporary storage, and that no compatibility between versions of Simplygon is guaranteed.

# Syntax

spBinaryExporter CreateBinaryExporter();

# Parameters

CreateBinaryExporter takes no parameters.

# Return value

Type: BinaryExporter

# CreateBinaryImporter

BinaryImporter loads the geometry data from a binary file, that is specific for Simplygon. Please note that the binary file is only intended for temporary storage, and that no compatibility between versions of Simplygon is guaranteed.

# Syntax

spBinaryImporter CreateBinaryImporter();

# Parameters

CreateBinaryImporter takes no parameters.

# Return value

Type: BinaryImporter

# CreateBoneSettings

Settings for the Simplygon Reduction/Remeshing classes With the BoneSettings object, the user can setup all the parameters for how the BoneLOD processor should simplify the links between geometries and bones. Bones can be un-linked from the geometry either with a set ratio or depending on a selected pixel size on screen.

# Syntax

spBoneSettings CreateBoneSettings();

# Parameters

CreateBoneSettings takes no parameters.

# Return value

Type: BoneSettings

# CreateBoolArray

BoolArray is the bool implementation of ValueArray. See ValueArray for a description.

# Syntax

spBoolArray CreateBoolArray();

# Parameters

CreateBoolArray takes no parameters.

# Return value

Type: BoolArray

# CreateCharArray

CharArray is the char implementation of ValueArray. See ValueArray for a description.

# Syntax

spCharArray CreateCharArray();

# Parameters

CreateCharArray takes no parameters.

# Return value

Type: CharArray

# CreateChartAggregator

Computes new texture coordinates for a geometry with overlapping UV charts.

# Syntax

spChartAggregator CreateChartAggregator();

# Parameters

CreateChartAggregator takes no parameters.

# Return value

Type: ChartAggregator

# CreateChartAggregatorSettings

Settings for the chart aggregator.

# Syntax

spChartAggregatorSettings CreateChartAggregatorSettings();

# Parameters

CreateChartAggregatorSettings takes no parameters.

# Return value

Type: ChartAggregatorSettings

# CreateChunkedImageData

ChunkedImageData holds chunks for ImageData objects. ImageData objects can be referenced, and swapped in/out of memory, to secondary storage. This is useful for very large images that cannot be stored in-memory. ImageData objects can be indexed in 1-,2- or 3D, and each ImageData chunk is cloned from a source ImageData object, at setup. Fields added to ImageData chunks after setup will only be added into that chunk, and is not recommended.

# Syntax

spChunkedImageData CreateChunkedImageData();

# Parameters

CreateChunkedImageData takes no parameters.

# Return value

Type: ChunkedImageData

# CreateColorCaster

ColorCaster is the interface used to cast basic color values. Currently supported material color value types are Ambient, Diffuse and Specular + Shininess.

# Syntax

spColorCaster CreateColorCaster();

# Parameters

CreateColorCaster takes no parameters.

# Return value

Type: ColorCaster

# CreateColorCasterSettings

ColorCasterSettings is the interface for basic color caster settings.

# Syntax

spColorCasterSettings CreateColorCasterSettings();

# Parameters

CreateColorCasterSettings takes no parameters.

# Return value

Type: ColorCasterSettings

# CreateDirectXRenderer

A Renderer using DirectX 11 that can be used to preview a scene object containing geometry data by rendering it from selected SceneCamera nodes within the given scene and then storing the frames to disc. If using a Shading Node Network (having an IShadingNode assigned to the IMaterial), then the material can be previewed with the generated HLSL shader.

# Syntax

spDirectXRenderer CreateDirectXRenderer();

# Parameters

CreateDirectXRenderer takes no parameters.

# Return value

Type: DirectXRenderer

# CreateDisplacementCaster

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

# Syntax

spDisplacementCaster CreateDisplacementCaster();

# Parameters

CreateDisplacementCaster takes no parameters.

# Return value

Type: DisplacementCaster

# CreateDisplacementCasterSettings

DisplacementCasterSettings is used to store the settings for a displacement caster

# Syntax

spDisplacementCasterSettings CreateDisplacementCasterSettings();

# Parameters

CreateDisplacementCasterSettings takes no parameters.

# Return value

Type: DisplacementCasterSettings

# CreateDoubleArray

DoubleArray is the double implementation of ValueArray. See ValueArray for a description.

# Syntax

spDoubleArray CreateDoubleArray();

# Parameters

CreateDoubleArray takes no parameters.

# Return value

Type: DoubleArray

# CreateFBXExporter

FBX scene exporter.

# Syntax

spFBXExporter CreateFBXExporter();

# Parameters

CreateFBXExporter takes no parameters.

# Return value

Type: FBXExporter

# CreateFBXImporter

FBX scene importer

# Syntax

spFBXImporter CreateFBXImporter();

# Parameters

CreateFBXImporter takes no parameters.

# Return value

Type: FBXImporter

# CreateFieldData

FieldData represents multiple fields of data. Each field is implemented as an ValueArray object, that has a unique name, and can have complex components (such as scalars, vectors, quaternions, tensors or matrices). All fields are assumed to be of the same length. IFieldData can be seen as an array with complex tuples, where the component can be of different types.

# Syntax

spFieldData CreateFieldData();

# Parameters

CreateFieldData takes no parameters.

# Return value

Type: FieldData

# CreateFlipbookPipeline

FlipbookPipeline provides a pipeline for a flipbook impostor processor to be applied on the input scene.

# Syntax

spFlipbookPipeline CreateFlipbookPipeline();

# Parameters

CreateFlipbookPipeline takes no parameters.

# Return value

Type: FlipbookPipeline

# CreateFlipbookSettings

Settings for the ImpostorType: FlipBook

# Syntax

spFlipbookSettings CreateFlipbookSettings();

# Parameters

CreateFlipbookSettings takes no parameters.

# Return value

Type: FlipbookSettings

# CreateFloatArray

FloatArray is the float implementation of ValueArray. See ValueArray for a description.

# Syntax

spFloatArray CreateFloatArray();

# Parameters

CreateFloatArray takes no parameters.

# Return value

Type: FloatArray

# CreateFoliageSettings

Settings for the BillboardMode: Foliage

# Syntax

spFoliageSettings CreateFoliageSettings();

# Parameters

CreateFoliageSettings takes no parameters.

# Return value

Type: FoliageSettings

# CreateGenerateLightmapTexCoordSettings

GenerateLightmapTexCoordSettings is the interface used to manage light map uv generation.

# Syntax

spGenerateLightmapTexCoordSettings CreateGenerateLightmapTexCoordSettings();

# Parameters

CreateGenerateLightmapTexCoordSettings takes no parameters.

# Return value

Type: GenerateLightmapTexCoordSettings

# CreateGeometryCullingSettings

Settings for volumetric triangle culling functionality. These settings control the clipping planes and geometries that are used for triangle culling the output of Simplygon scene processors.

# Syntax

spGeometryCullingSettings CreateGeometryCullingSettings();

# Parameters

CreateGeometryCullingSettings takes no parameters.

# Return value

Type: GeometryCullingSettings

# CreateGeometryData

GeometryData represents a geometric structure consisting of point data (Vertices) and topological data (Triangles). GeometryData may represent a whole geometric object, but can also be used by streaming data filters, and in this way, only represents a part of the object. Different fields in the Vertices and Triangles fields data objects will contain point data and topological data. The standard naming convention used in the filters/renderers are as follows: (Case sensitive naming, other fields may also be present) 'Coords' Positional coordinates of a vertex, expressed with a 3-component real field (XYZ). 'TexCoords0' - 'TexCoords255' Texture coordinates of a vertex, expressed with a 2 components real field. By convention, the existing fields must be sequential, and must start with 'TexCoord0'. 'Normals' Normal vector for the vertex, expressed with a 3-component real field, a normalized (XYZ) vector. 'VertexIds' The id of the current vertex in the primitive. This field is present even if the vertex data is directly specified in the primitive data, to specify topology. The field is of type rid. 'MaterialIds' The material of the primitive. The field is of type rid. The 'Coords' and 'VertexIds' fields always exist in the object, but the other fields are optional. Also, there can exist user fields.

# Syntax

spGeometryData CreateGeometryData();

# Parameters

CreateGeometryData takes no parameters.

# Return value

Type: GeometryData

# CreateGeometryDataCaster

GeometryDataCaster is used to cast original GeometryData information to an image using mapping image

# Syntax

spGeometryDataCaster CreateGeometryDataCaster();

# Parameters

CreateGeometryDataCaster takes no parameters.

# Return value

Type: GeometryDataCaster

# CreateGeometryDataCasterSettings

GeometryDataCasterSettings is the interface used to manage settings for GeometryDataCaster

# Syntax

spGeometryDataCasterSettings CreateGeometryDataCasterSettings();

# Parameters

CreateGeometryDataCasterSettings takes no parameters.

# Return value

Type: GeometryDataCasterSettings

# CreateGeometryDataCollection

GeometryDataCollection holds a number of GeometryData objects. The objects can be looked up by their names (if they have been named with a call to SetName).

# Syntax

spGeometryDataCollection CreateGeometryDataCollection();

# Parameters

CreateGeometryDataCollection takes no parameters.

# Return value

Type: GeometryDataCollection

# CreateGeometryValidator

Checks the geometry for consistent indices, number of triangles etc.

# Syntax

spGeometryValidator CreateGeometryValidator();

# Parameters

CreateGeometryValidator takes no parameters.

# Return value

Type: GeometryValidator

# CreateGLTFExporter

glTF geometry exporter capable of exporting both glTF and GLB files determined by output path extension. Textures and binary blob files for glTF export will be placed alongside the glTF file and have names prefixed by the output file name. Note that any normal textures for the scene must be in tangent space, as generated by a normal caster with SetGenerateTangentSpaceNormals set to true.

# Syntax

spGLTFExporter CreateGLTFExporter();

# Parameters

CreateGLTFExporter takes no parameters.

# Return value

Type: GLTFExporter

# CreateGLTFImporter

glTF scene importer

# Syntax

spGLTFImporter CreateGLTFImporter();

# Parameters

CreateGLTFImporter takes no parameters.

# Return value

Type: GLTFImporter

# CreateGraphicsExporter

Base class for graphics export classes

# Syntax

spGraphicsExporter CreateGraphicsExporter();

# Parameters

CreateGraphicsExporter takes no parameters.

# Return value

Type: GraphicsExporter

# CreateGraphicsImporter

Base class for graphics import classes

# Syntax

spGraphicsImporter CreateGraphicsImporter();

# Parameters

CreateGraphicsImporter takes no parameters.

# Return value

Type: GraphicsImporter

# CreateImageComparer

Compares images.

# Syntax

spImageComparer CreateImageComparer();

# Parameters

CreateImageComparer takes no parameters.

# Return value

Type: ImageComparer

# CreateImageData

ImageData holds unpacked image data. The data is stored in an FieldData object as value fields. For simplicity all images are implemented as 3D images, but has an extent of 1 in Z for 2D images, and an extent of 1 in both Y and Z for 1D images. Cube maps are stored as a 3D image with Z-depth of 6 (one for each side)

# Syntax

spImageData CreateImageData();

# Parameters

CreateImageData takes no parameters.

# Return value

Type: ImageData

# CreateImageDataExporter

Class for saving image data to different file formats.

# Syntax

spImageDataExporter CreateImageDataExporter();

# Parameters

CreateImageDataExporter takes no parameters.

# Return value

Type: ImageDataExporter

# CreateImageDataImporter

Class for loading image data from different file formats.

# Syntax

spImageDataImporter CreateImageDataImporter();

# Parameters

CreateImageDataImporter takes no parameters.

# Return value

Type: ImageDataImporter

# CreateImpostorFromSingleViewPipeline

ImpostorFromSingleViewPipeline provides a pipeline for a impostor from single view impostor processor to be applied on the input scene.

# Syntax

spImpostorFromSingleViewPipeline CreateImpostorFromSingleViewPipeline();

# Parameters

CreateImpostorFromSingleViewPipeline takes no parameters.

# Return value

Type: ImpostorFromSingleViewPipeline

# CreateImpostorFromSingleViewSettings

Settings for the ImpostorType: ImpostorFromSingleView.

# Syntax

spImpostorFromSingleViewSettings CreateImpostorFromSingleViewSettings();

# Parameters

CreateImpostorFromSingleViewSettings takes no parameters.

# Return value

Type: ImpostorFromSingleViewSettings

# CreateImpostorProcessor

The ImpostorProcessor generates an impostor of one of these impostor types: BillboardCloud, Flipbook or ImpostorFromSingleView.

# Syntax

spImpostorProcessor CreateImpostorProcessor();

# Parameters

CreateImpostorProcessor takes no parameters.

# Return value

Type: ImpostorProcessor

# CreateImpostorSettings

Settings for the ImpostorProccessor

# Syntax

spImpostorSettings CreateImpostorSettings();

# Parameters

CreateImpostorSettings takes no parameters.

# Return value

Type: ImpostorSettings

# CreateIntArray

IntArray is the int implementation of ValueArray. See ValueArray for a description.

# Syntax

spIntArray CreateIntArray();

# Parameters

CreateIntArray takes no parameters.

# Return value

Type: IntArray

# CreateLongArray

LongArray is the long implementation of ValueArray. See ValueArray for a description.

# Syntax

spLongArray CreateLongArray();

# Parameters

CreateLongArray takes no parameters.

# Return value

Type: LongArray

# CreateMappingImage

MappingImage stores the mapping between a processed geometry and the source geometry it is based on. The mapping image object also stores multisampling settings. It can be used to cast information from the original geometry to the processed geometry, such as surface transfer or calculating normal maps. See IMaterialCaster and subclasses for casting uses.

# Syntax

spMappingImage CreateMappingImage();

# Parameters

CreateMappingImage takes no parameters.

# Return value

Type: MappingImage

# CreateMappingImageInputMaterialSettings

Settings for the Simplygon mapping input.

# Syntax

spMappingImageInputMaterialSettings CreateMappingImageInputMaterialSettings();

# Parameters

CreateMappingImageInputMaterialSettings takes no parameters.

# Return value

Type: MappingImageInputMaterialSettings

# CreateMappingImageMeshData

MappingImageMeshData stores the mapped meshes and their paths in the original scene. This can be used to find a specific triangle on the original mesh in the scene from the combined id in the mapping image.

# Syntax

spMappingImageMeshData CreateMappingImageMeshData();

# Parameters

CreateMappingImageMeshData takes no parameters.

# Return value

Type: MappingImageMeshData

# CreateMappingImageOutputMaterialSettings

Settings for the Simplygon mapping output.

# Syntax

spMappingImageOutputMaterialSettings CreateMappingImageOutputMaterialSettings();

# Parameters

CreateMappingImageOutputMaterialSettings takes no parameters.

# Return value

Type: MappingImageOutputMaterialSettings

# CreateMappingImageSettings

Settings for the Simplygon mapping classes These settings control the properties of the mapping image that will be generated in the current simplification processor (reducer/remesher etc). The mapping image will be used when casting a new texture on the simplified geometry. In the settings object, the user is able to set the dimensions of the image (width/height) as well as whether the LOD should have new texture coordinates and some parameters for how they should be generated and all other settings regarding the mapping image.

# Syntax

spMappingImageSettings CreateMappingImageSettings();

# Parameters

CreateMappingImageSettings takes no parameters.

# Return value

Type: MappingImageSettings

# CreateMaterial

Material object that keeps material information used while rendering.

# Syntax

spMaterial CreateMaterial();

# Parameters

CreateMaterial takes no parameters.

# Return value

Type: Material

# CreateMaterialCaster

MaterialCaster is the base interface for material casting interfaces. The interface exports methods for defining input geometries & mapping image, materials, output image paths & formats

# Syntax

spMaterialCaster CreateMaterialCaster();

# Parameters

CreateMaterialCaster takes no parameters.

# Return value

Type: MaterialCaster

# CreateMaterialCasterSettings

MaterialCasterSettings is the base interface for material casting settings

# Syntax

spMaterialCasterSettings CreateMaterialCasterSettings();

# Parameters

CreateMaterialCasterSettings takes no parameters.

# Return value

Type: MaterialCasterSettings

# CreateMaterialTable

MaterialTable keeps information on materials used while rendering.

# Syntax

spMaterialTable CreateMaterialTable();

# Parameters

CreateMaterialTable takes no parameters.

# Return value

Type: MaterialTable

# CreateMatrix4x4

Matrix4x4 is used to represent and manipulate 4x4 transformation matrices, which can be either standard matrices, or homogeneous 4x4 matrices used to transform 3D homogeneous coordinates [x y z w]. The transformations are defined in row-major order.

# Syntax

spMatrix4x4 CreateMatrix4x4();

# Parameters

CreateMatrix4x4 takes no parameters.

# Return value

Type: Matrix4x4

# CreateNormalCalculationSettings

Settings for the normal recalculation

# Syntax

spNormalCalculationSettings CreateNormalCalculationSettings();

# Parameters

CreateNormalCalculationSettings takes no parameters.

# Return value

Type: NormalCalculationSettings

# CreateNormalCaster

NormalCaster is the interface used to cast normals data onto the receiving geometry.

# Syntax

spNormalCaster CreateNormalCaster();

# Parameters

CreateNormalCaster takes no parameters.

# Return value

Type: NormalCaster

# CreateNormalCasterSettings

NormalCasterSettings is the interface used to manage settings for a normal caster

# Syntax

spNormalCasterSettings CreateNormalCasterSettings();

# Parameters

CreateNormalCasterSettings takes no parameters.

# Return value

Type: NormalCasterSettings

# CreateNormalRepairer

Repairs normals on a processed geometry.

# Syntax

spNormalRepairer CreateNormalRepairer();

# Parameters

CreateNormalRepairer takes no parameters.

# Return value

Type: NormalRepairer

# CreateObjectCollection

ObjectCollection and its specializations handles a collection of Objects. There are methods for adding, removing and iterating through the objects.

# Syntax

spObjectCollection CreateObjectCollection();

# Parameters

CreateObjectCollection takes no parameters.

# Return value

Type: ObjectCollection

# CreateOcclusionMeshProcessor

The occlusion mesh processor creates a reconstruction of the input mesh from its silhouette. This means concavities and internal geometry disappear. WARNING: Experimental. Generates nice meshes, but currently very slow at high settings. Recommended onscreens size ~100

# Syntax

spOcclusionMeshProcessor CreateOcclusionMeshProcessor();

# Parameters

CreateOcclusionMeshProcessor takes no parameters.

# Return value

Type: OcclusionMeshProcessor

# CreateOcclusionMeshSettings

Settings for occlusion meshes

# Syntax

spOcclusionMeshSettings CreateOcclusionMeshSettings();

# Parameters

CreateOcclusionMeshSettings takes no parameters.

# Return value

Type: OcclusionMeshSettings

# CreateOpacityCaster

OpacityCaster is the interface used to cast opacity values. To be used when opacity is needed as a separate texture. IMPORTANT: Make sure to set OpacityChannel to the channel you want to cast, since this caster bakes opacity rather than the channel set in the MaterialChannel setting like most other casters.

# Syntax

spOpacityCaster CreateOpacityCaster();

# Parameters

CreateOpacityCaster takes no parameters.

# Return value

Type: OpacityCaster

# CreateOpacityCasterSettings

OpacityCasterSettings is the interface used to manage settings for an opacity caster. IMPORTANT: Make sure to set the OpacityChannel setting to the channel you want to cast, since this caster bakes opacity rather than the channel set in the MaterialChannel setting like most other casters.

# Syntax

spOpacityCasterSettings CreateOpacityCasterSettings();

# Parameters

CreateOpacityCasterSettings takes no parameters.

# Return value

Type: OpacityCasterSettings

# CreatePackedGeometryData

PackedGeometryData keeps the same information as GeometryData, but with all corner data fields moved into per-vertex fields. No per-corner fields exist, apart from the VertexIds field. Please note that the number of vertices in an PackedGeometryData is commonly higher than in an GeometryData, as vertices must be split to accommodate for different corner data.

# Syntax

spPackedGeometryData CreatePackedGeometryData();

# Parameters

CreatePackedGeometryData takes no parameters.

# Return value

Type: PackedGeometryData

# CreateParameterizer

Computes texture coordinates for arbitrary geometry.

# Syntax

spParameterizer CreateParameterizer();

# Parameters

CreateParameterizer takes no parameters.

# Return value

Type: Parameterizer

# CreateParameterizerSettings

Settings for the parameterizer.

# Syntax

spParameterizerSettings CreateParameterizerSettings();

# Parameters

CreateParameterizerSettings takes no parameters.

# Return value

Type: ParameterizerSettings

# CreatePartRemover

The PartRemover tool can identify unconnected sub-meshes, and remove meshes that fall below a set size threshold. This size threshold can be set globally for the entire geometry, or per-material to be able to remove things like decals effectively.

# Syntax

spPartRemover CreatePartRemover();

# Parameters

CreatePartRemover takes no parameters.

# Return value

Type: PartRemover

# CreatePassthroughPipeline

PassthroughPipeline provides an empty pipeline for creating a cascading pipeline using a single dummy root node. It does not process the input scene in any way.

# Syntax

spPassthroughPipeline CreatePassthroughPipeline();

# Parameters

CreatePassthroughPipeline takes no parameters.

# Return value

Type: PassthroughPipeline

# CreatePipeline

Pipeline is the interface for a processing pipeline, which applies a number of processing opearations on an input scene to generate an output scene. The input and output scenes can be any file format supported by Simplygon.

# Syntax

spPipeline CreatePipeline();

# Parameters

CreatePipeline takes no parameters.

# Return value

Type: Pipeline

# CreatePipelineBatch

Control object to launch pipelines in batches, both locally and distributed

# Syntax

spPipelineBatch CreatePipelineBatch();

# Parameters

CreatePipelineBatch takes no parameters.

# Return value

Type: PipelineBatch

# CreatePipelineSerializer

# Syntax

spPipelineSerializer CreatePipelineSerializer();

# Parameters

CreatePipelineSerializer takes no parameters.

# Return value

Type: PipelineSerializer

# CreatePipelineSettings

PipelineSettings is the interface used to manage settings for a pipeline

# Syntax

spPipelineSettings CreatePipelineSettings();

# Parameters

CreatePipelineSettings takes no parameters.

# Return value

Type: PipelineSettings

# CreateProcessingObject

ProcessingObject is the abstract base class for all processing objects in Simplygon. Processing objects take parameters, exports the RunProcessing to run the main processing and Clear to clear the internal states of the processing object. All processing objects also export information on how far the process has moved and the possibility to cancel long running processings.

# Syntax

spProcessingObject CreateProcessingObject();

# Parameters

CreateProcessingObject takes no parameters.

# Return value

Type: ProcessingObject

# CreateRealArray

RealArray is the real implementation of ValueArray. See ValueArray for a description.

# Syntax

spRealArray CreateRealArray();

# Parameters

CreateRealArray takes no parameters.

# Return value

Type: RealArray

# CreateRecommendedTextureSizeCalculator

Estimates a coarse recommended UV size (width and height) for a geometry based on only its surface area and either the distance it is allowed to deviate or its intended on screen size. The UVs are assumed to be unique i.e. not tiled/repeated. RecommendedWidth and RecommendedHeight will only differ from each other if ForcePower2Texture is enabled.

# Syntax

spRecommendedTextureSizeCalculator CreateRecommendedTextureSizeCalculator();

# Parameters

CreateRecommendedTextureSizeCalculator takes no parameters.

# Return value

Type: RecommendedTextureSizeCalculator

# CreateReductionPipeline

ReductionPipeline provides a pipeline for a single reduction processor to be applied on the input scene.

# Syntax

spReductionPipeline CreateReductionPipeline();

# Parameters

CreateReductionPipeline takes no parameters.

# Return value

Type: ReductionPipeline

# CreateReductionProcessor

ReductionProcessor welds, removes t-junctions, removes double-triangles and reduces the triangle count of the Geometry. It also calculates new normals for the reduced and optimized Geometry.

# Syntax

spReductionProcessor CreateReductionProcessor();

# Parameters

CreateReductionProcessor takes no parameters.

# Return value

Type: ReductionProcessor

# CreateReductionSettings

Settings for the ReductionProcessor class. Handles all the settings for Simplygons simplification algorithms. The user can tell the reduction processor which features are important by using the 'FeatureFlags' parameter, and also the relative importance of these features using the Set{feature}Importance methods. Also settings for things like symmetry are set here.

# Syntax

spReductionSettings CreateReductionSettings();

# Parameters

CreateReductionSettings takes no parameters.

# Return value

Type: ReductionSettings

# CreateRemeshingLegacyPipeline

RemeshingLegacyPipeline provides a pipeline for a single remeshing legacy processor to be applied on the input scene.

# Syntax

spRemeshingLegacyPipeline CreateRemeshingLegacyPipeline();

# Parameters

CreateRemeshingLegacyPipeline takes no parameters.

# Return value

Type: RemeshingLegacyPipeline

# CreateRemeshingLegacyProcessor

RemeshingLegacyProcessor creates a new geometry that is based on the input geometry, but that is topologically based on the size of the input geometry rendered at a specific screen size, and allowed pixel error. The remesher will on demand also add texture coordinates and a mapping texture to the output remeshed geometry. The geometry that is to be remeshed can be defined either using an in-memory geometry data object, or using a geometry file placed on disk, the latter being the preferred method, if the source geometry is very large as it can be swapped in/out of memory as needed.

# Syntax

spRemeshingLegacyProcessor CreateRemeshingLegacyProcessor();

# Parameters

CreateRemeshingLegacyProcessor takes no parameters.

# Return value

Type: RemeshingLegacyProcessor

# CreateRemeshingLegacySettings

Remeshing settings for the RemeshingLegacyProcessor class. The remesher creates a completely new lightweight mesh from the input geometry, and is intended to be viewed from the outside. Here you will set the OnScreenSize (larger numbers means a more detailed mesh), merge distance (which fills in smaller gaps) and a cutting plane (where all parts of the input mesh on the far side of that plane will be culled).

# Syntax

spRemeshingLegacySettings CreateRemeshingLegacySettings();

# Parameters

CreateRemeshingLegacySettings takes no parameters.

# Return value

Type: RemeshingLegacySettings

# CreateRemeshingPipeline

RemeshingPipeline provides a pipeline for a single remeshing processor to be applied on the input scene.

# Syntax

spRemeshingPipeline CreateRemeshingPipeline();

# Parameters

CreateRemeshingPipeline takes no parameters.

# Return value

Type: RemeshingPipeline

# CreateRemeshingProcessor

The RemeshingProcessor takes an input scene and replaces it with a lightweight proxy geometry that resembles the original, but does not share vertex data or parts of the original mesh data. The remeshed object is created and optimized for a certain on-screen pixel size - which means that holes and parts that are close to each other will have their gaps filled if the distance is below a pixel. At default settings, the proxy mesh is assumed to be viewed from the outside. Any interior mesh that cannot be seen is removed. The result is a very light-weight mesh that is highly optimized for real-time viewing, or to speed up off-line rendering of small objects. Simplygon is capable of remeshing arbitrary geometry, including non-manifold surfaces.

# Syntax

spRemeshingProcessor CreateRemeshingProcessor();

# Parameters

CreateRemeshingProcessor takes no parameters.

# Return value

Type: RemeshingProcessor

# CreateRemeshingSettings

Remeshing settings for the RemeshingProcessor class.

# Syntax

spRemeshingSettings CreateRemeshingSettings();

# Parameters

CreateRemeshingSettings takes no parameters.

# Return value

Type: RemeshingSettings

# CreateRepairSettings

Settings for handling unconnected parts and unwanted gaps in the geometry. It consists of two parts, Welding and T-junction removal. Welding merges vertices that are closer than a set distance from each other. T-junction removal finds open edges that lies within a set distance from other open edges, but without matching vertices. It then splits those triangles into smaller, matching triangles and fuses them together.

# Syntax

spRepairSettings CreateRepairSettings();

# Parameters

CreateRepairSettings takes no parameters.

# Return value

Type: RepairSettings

# CreateRidArray

RidArray is the rid implementation of ValueArray. See ValueArray for a description.

# Syntax

spRidArray CreateRidArray();

# Parameters

CreateRidArray takes no parameters.

# Return value

Type: RidArray

# CreateScene

Scene is the main keeper of a scene and scene graph in simplygon. The scene is self-contained, with materials, textures, etc. to describe a full scene.

# Syntax

spScene CreateScene();

# Parameters

CreateScene takes no parameters.

# Return value

Type: Scene

# CreateSceneBone

SceneBone is the bone node in the simplygon scene graph

# Syntax

spSceneBone CreateSceneBone();

# Parameters

CreateSceneBone takes no parameters.

# Return value

Type: SceneBone

# CreateSceneBoneTable

SceneBoneTable keeps information on bones used while rendering.

# Syntax

spSceneBoneTable CreateSceneBoneTable();

# Parameters

CreateSceneBoneTable takes no parameters.

# Return value

Type: SceneBoneTable

# CreateSceneCamera

SceneCamera is the camera node in the Simplygon scene graph. SceneCamera contains settings that specify how the camera works and it contains a number of views for that type of camera. A view is a combination of a CameraPosition and a TargetPosition. The SceneCamera can contain any number of views but every element in TargetPositions has to correspond to a tuple element in CameraPosition. TargetPositions is not needed if the camera is set to being omni directional.

# Syntax

spSceneCamera CreateSceneCamera();

# Parameters

CreateSceneCamera takes no parameters.

# Return value

Type: SceneCamera

# CreateSceneExporter

Class for saving scene data to different file formats depending on the extension of the set file name.

# Syntax

spSceneExporter CreateSceneExporter();

# Parameters

CreateSceneExporter takes no parameters.

# Return value

Type: SceneExporter

# CreateSceneImporter

Class for loading scene data from different file formats.

# Syntax

spSceneImporter CreateSceneImporter();

# Parameters

CreateSceneImporter takes no parameters.

# Return value

Type: SceneImporter

# CreateSceneLodGroup

SceneLodGroup is a LOD grouping for the scene graph

# Syntax

spSceneLodGroup CreateSceneLodGroup();

# Parameters

CreateSceneLodGroup takes no parameters.

# Return value

Type: SceneLodGroup

# CreateSceneMesh

SceneMesh is the mesh node in the simplygon scene graph

# Syntax

spSceneMesh CreateSceneMesh();

# Parameters

CreateSceneMesh takes no parameters.

# Return value

Type: SceneMesh

# CreateSceneNode

SceneNode is the base class for all scene graph nodes in simplygon. It has relative transformation to its parent, and functions to add children to the node.

# Syntax

spSceneNode CreateSceneNode();

# Parameters

CreateSceneNode takes no parameters.

# Return value

Type: SceneNode

# CreateSceneNodeCollection

SceneNodeCollection holds a number of SceneNode objects. The objects can be looked up by their names (if they have been named through SetName()).

# Syntax

spSceneNodeCollection CreateSceneNodeCollection();

# Parameters

CreateSceneNodeCollection takes no parameters.

# Return value

Type: SceneNodeCollection

# CreateScenePlane

ScenePlane is the plane node in the simplygon scene graph that can be used in various processes, for example as a cutting plane in the RemeshingProcessor.

# Syntax

spScenePlane CreateScenePlane();

# Parameters

CreateScenePlane takes no parameters.

# Return value

Type: ScenePlane

# CreateSelectionSet

SelectionSet is a set of scene node GUIDs referencing scene nodes in a scene.

# Syntax

spSelectionSet CreateSelectionSet();

# Parameters

CreateSelectionSet takes no parameters.

# Return value

Type: SelectionSet

# CreateSelectionSetTable

SelectionSetTable keeps a table of SelectionSet.

# Syntax

spSelectionSetTable CreateSelectionSetTable();

# Parameters

CreateSelectionSetTable takes no parameters.

# Return value

Type: SelectionSetTable

# CreateSettingsObject

SettingsObject is the abstract base class for all settings objects in Simplygon. Settings objects contains parameters for processing objects to use. These settings objects will have their data set and reached from a ProcessingObject and then used therein.

# Syntax

spSettingsObject CreateSettingsObject();

# Parameters

CreateSettingsObject takes no parameters.

# Return value

Type: SettingsObject

# CreateShaderGenerator

Given a material, the shader data class keeps the relevant shader data and is able to generate a GLSL/HLSL shader.

# Syntax

spShaderGenerator CreateShaderGenerator();

# Parameters

CreateShaderGenerator takes no parameters.

# Return value

Type: ShaderGenerator

# CreateShadingAddNode

AddNode describes a single addition shading node in a shading network. Input 1 and 2 are added per-component to produce the output.

# Syntax

spShadingAddNode CreateShadingAddNode();

# Parameters

CreateShadingAddNode takes no parameters.

# Return value

Type: ShadingAddNode

# CreateShadingClampNode

ClampNode describes a single clamp shading node in a shading network. Input 1 is clamped per-component between Input 2 and 3.

# Syntax

spShadingClampNode CreateShadingClampNode();

# Parameters

CreateShadingClampNode takes no parameters.

# Return value

Type: ShadingClampNode

# CreateShadingColorNode

ColorNode describes a single color source node in a shading network

# Syntax

spShadingColorNode CreateShadingColorNode();

# Parameters

CreateShadingColorNode takes no parameters.

# Return value

Type: ShadingColorNode

# CreateShadingCosNode

This node describes cosine of the x,y,z,w components of the input.

# Syntax

spShadingCosNode CreateShadingCosNode();

# Parameters

CreateShadingCosNode takes no parameters.

# Return value

Type: ShadingCosNode

# CreateShadingCross3Node

This node describes the cross of the x,y,z components of the input.

# Syntax

spShadingCross3Node CreateShadingCross3Node();

# Parameters

CreateShadingCross3Node takes no parameters.

# Return value

Type: ShadingCross3Node

# CreateShadingCustomNode

CustomNode describes a custom shading node in a shading network. The output is produced based on customizable user specified operations. The custom node has a user specified amount of input parameters. Use SetInputCount() to specify the number of inputs. The user has to assign and implement event handlers (called observers) for the custom node to be able to evaluate to colors. See CustomNodeExample and API documentation for further explanations and code samples.

# Syntax

spShadingCustomNode CreateShadingCustomNode();

# Parameters

CreateShadingCustomNode takes no parameters.

# Return value

Type: ShadingCustomNode

# CreateShadingDivideNode

DivideNode describes a single division shading node node in a shading network. Input 1 is divided by Input 2 per-component to produce the output.

# Syntax

spShadingDivideNode CreateShadingDivideNode();

# Parameters

CreateShadingDivideNode takes no parameters.

# Return value

Type: ShadingDivideNode

# CreateShadingDot3Node

This node describes an dot of the x,y,z components of the inputs.

# Syntax

spShadingDot3Node CreateShadingDot3Node();

# Parameters

CreateShadingDot3Node takes no parameters.

# Return value

Type: ShadingDot3Node

# CreateShadingEqualNode

ShadingEqualNode describes an "is equal to" operator, where the per-component output is either 1 or 0 depending on if input0 is equal to input1. Basically, (Input0 == Input1) ? 1 : 0

# Syntax

spShadingEqualNode CreateShadingEqualNode();

# Parameters

CreateShadingEqualNode takes no parameters.

# Return value

Type: ShadingEqualNode

# CreateShadingFilterNode

FilterNode is the parent of all non-source nodes in a shading network.

# Syntax

spShadingFilterNode CreateShadingFilterNode();

# Parameters

CreateShadingFilterNode takes no parameters.

# Return value

Type: ShadingFilterNode

# CreateShadingGeometryFieldNode

Geometry field node describes a source node for geometry field data in a shading network, such as normals and tangents.

# Syntax

spShadingGeometryFieldNode CreateShadingGeometryFieldNode();

# Parameters

CreateShadingGeometryFieldNode takes no parameters.

# Return value

Type: ShadingGeometryFieldNode

# CreateShadingGreaterThanNode

GreaterThanNode describes the "is greater than" operator, where the per-component output is either 1 or 0 depending on if input0 is greater than input1. Basically, (Input0 > Input1) ? 1 : 0

# Syntax

spShadingGreaterThanNode CreateShadingGreaterThanNode();

# Parameters

CreateShadingGreaterThanNode takes no parameters.

# Return value

Type: ShadingGreaterThanNode

# CreateShadingInterpolateNode

InterpolateNode describes a single interpolating shading node node in a shading network. Input 1 and Input 2 is interpolated per-component using Input 3. Blend values below 0 and over 1 will be clamped.

# Syntax

spShadingInterpolateNode CreateShadingInterpolateNode();

# Parameters

CreateShadingInterpolateNode takes no parameters.

# Return value

Type: ShadingInterpolateNode

# CreateShadingLayeredBlendNode

LayeredBlendNode is a node with an arbitrary number of inputs that can be blended differently.

# Syntax

spShadingLayeredBlendNode CreateShadingLayeredBlendNode();

# Parameters

CreateShadingLayeredBlendNode takes no parameters.

# Return value

Type: ShadingLayeredBlendNode

# CreateShadingLessThanNode

LessThanNode describes the "is less than" operator, where the per-component output is either 1 or 0 depending on if input0 is LessThan to input1. Basically, (Input0 < Input1) ? 1 : 0

# Syntax

spShadingLessThanNode CreateShadingLessThanNode();

# Parameters

CreateShadingLessThanNode takes no parameters.

# Return value

Type: ShadingLessThanNode

# CreateShadingMaxNode

MaxNode describes a single max shading node in a shading network. The output has the per-channel max values of the two inputs.

# Syntax

spShadingMaxNode CreateShadingMaxNode();

# Parameters

CreateShadingMaxNode takes no parameters.

# Return value

Type: ShadingMaxNode

# CreateShadingMinNode

MinNode describes a single min shading node in a shading network. The output has the per-channel min values of the two inputs.

# Syntax

spShadingMinNode CreateShadingMinNode();

# Parameters

CreateShadingMinNode takes no parameters.

# Return value

Type: ShadingMinNode

# CreateShadingMultiplyNode

MultiplyNode describes a single multiplying shading node in a shading network. Input 1 and Input 2 is multiplied per-component.

# Syntax

spShadingMultiplyNode CreateShadingMultiplyNode();

# Parameters

CreateShadingMultiplyNode takes no parameters.

# Return value

Type: ShadingMultiplyNode

# CreateShadingNode

ShadingNode is the parent of all nodes in a shading network.

# Syntax

spShadingNode CreateShadingNode();

# Parameters

CreateShadingNode takes no parameters.

# Return value

Type: ShadingNode

# CreateShadingNormalize3Node

This node describes an normalization of the x,y,z components of the input.

# Syntax

spShadingNormalize3Node CreateShadingNormalize3Node();

# Parameters

CreateShadingNormalize3Node takes no parameters.

# Return value

Type: ShadingNormalize3Node

# CreateShadingNotEqualNode

NotEqualNode describes the "is not equal" operator, where the per-component output is either 1 or 0 depending on if input0 is equal to input1. Basically, (Input0 != Input1) ? 1 : 0

# Syntax

spShadingNotEqualNode CreateShadingNotEqualNode();

# Parameters

CreateShadingNotEqualNode takes no parameters.

# Return value

Type: ShadingNotEqualNode

# CreateShadingPowNode

This node describes an exponentiation. The output will be Input 1 to the power of Input 2, and it is calculated per-component.

# Syntax

spShadingPowNode CreateShadingPowNode();

# Parameters

CreateShadingPowNode takes no parameters.

# Return value

Type: ShadingPowNode

# CreateShadingSinNode

This node describes Sin of the x,y,z components of the input.

# Syntax

spShadingSinNode CreateShadingSinNode();

# Parameters

CreateShadingSinNode takes no parameters.

# Return value

Type: ShadingSinNode

# CreateShadingSqrtNode

This node describes a square root calculation. The output will be the per-component square root of input 1

# Syntax

spShadingSqrtNode CreateShadingSqrtNode();

# Parameters

CreateShadingSqrtNode takes no parameters.

# Return value

Type: ShadingSqrtNode

# CreateShadingStepNode

StepNode describes a single step shading node, where the per-component output is either 1 or 0 depending on if input0 is larger or smaller than input1. Basically, (Input0 >= Input1) ? 1 : 0

# Syntax

spShadingStepNode CreateShadingStepNode();

# Parameters

CreateShadingStepNode takes no parameters.

# Return value

Type: ShadingStepNode

# CreateShadingSubtractNode

SubtractNode describes a single subtracting shading node in a shading network. Input 2 is subtracted from input 1 per-component.

# Syntax

spShadingSubtractNode CreateShadingSubtractNode();

# Parameters

CreateShadingSubtractNode takes no parameters.

# Return value

Type: ShadingSubtractNode

# CreateShadingSwizzlingNode

SwizzlingNode describes a node that can remap the input to the specified output.

# Syntax

spShadingSwizzlingNode CreateShadingSwizzlingNode();

# Parameters

CreateShadingSwizzlingNode takes no parameters.

# Return value

Type: ShadingSwizzlingNode

# CreateShadingTextureNode

TextureNode describes a texture source node in a shading network.

# Syntax

spShadingTextureNode CreateShadingTextureNode();

# Parameters

CreateShadingTextureNode takes no parameters.

# Return value

Type: ShadingTextureNode

# CreateShadingVertexColorNode

VertexColorNode describes a vertex color source node in a shading network.

# Syntax

spShadingVertexColorNode CreateShadingVertexColorNode();

# Parameters

CreateShadingVertexColorNode takes no parameters.

# Return value

Type: ShadingVertexColorNode

# CreateShortArray

ShortArray is the short implementation of ValueArray. See ValueArray for a description.

# Syntax

spShortArray CreateShortArray();

# Parameters

CreateShortArray takes no parameters.

# Return value

Type: ShortArray

# CreateStringArray

StringArray is the string implementation of ValueArray. See ValueArray for a description.

# Syntax

spStringArray CreateStringArray();

# Parameters

CreateStringArray takes no parameters.

# Return value

Type: StringArray

# CreateSurfaceMapper

ISurfaceMapper creates a mapping image between two user-defined geometries. The mapper basically looks for the source geometry in the inverse normal direction from the outwardly offset destination geometry, and maps pixels accordingly. This means that you can modify the normals of the destination geometry to adjust the search direction to your liking. The geometries can either be set as IGeometryDatas or as the root nodes of scenes. If both are set, the scene is used. If only a single source or a destination is set, or if the source and destination are the same scene or geometry, the surface mapper will map the mesh onto itself.

# Syntax

spSurfaceMapper CreateSurfaceMapper();

# Parameters

CreateSurfaceMapper takes no parameters.

# Return value

Type: SurfaceMapper

# CreateTable

Table is the base class for tables objects, where items are added into an id-indexed array of objects.

# Syntax

spTable CreateTable();

# Parameters

CreateTable takes no parameters.

# Return value

Type: Table

# CreateTangentCalculator

TangentCalculator calculates tangent vectors for geometry data objects. One corner field of texture coordinates must exist, as well as normals. The tangents are placed into two corner fields called "Tangents" and "Bitangents". If any of these fields already exists, it is replaced by the new field.

# Syntax

spTangentCalculator CreateTangentCalculator();

# Parameters

CreateTangentCalculator takes no parameters.

# Return value

Type: TangentCalculator

# CreateTexture

Texture describes a texture object, containing either image data or a path that is referenced by texture nodes in materials.

# Syntax

spTexture CreateTexture();

# Parameters

CreateTexture takes no parameters.

# Return value

Type: Texture

# CreateTextureTable

TextureTable keeps information on textures used while rendering.

# Syntax

spTextureTable CreateTextureTable();

# Parameters

CreateTextureTable takes no parameters.

# Return value

Type: TextureTable

# CreateTJunctionEliminator

Removes t-junctions by subdividing triangles and welding vertices

# Syntax

spTJunctionEliminator CreateTJunctionEliminator();

# Parameters

CreateTJunctionEliminator takes no parameters.

# Return value

Type: TJunctionEliminator

# CreateTransform3

Transform3 handles homogeneous 4x4 transforms, i.e. transformations which can be represented by multiplying a 4x4 matrix with a homogeneous 3D coordinate. Transform3 can either pre-multiply a matrix onto the transformation, which will add a transform around the current transform, or it can post-multiply the matrix, which will add a transform inside the current transform. Post-multiply is the default mode.

# Syntax

spTransform3 CreateTransform3();

# Parameters

CreateTransform3 takes no parameters.

# Return value

Type: Transform3

# CreateUnsignedCharArray

UnsignedCharArray is the uchar implementation of ValueArray. See ValueArray for a description.

# Syntax

spUnsignedCharArray CreateUnsignedCharArray();

# Parameters

CreateUnsignedCharArray takes no parameters.

# Return value

Type: UnsignedCharArray

# CreateUnsignedIntArray

UnsignedIntArray is the uint implementation of ValueArray. See ValueArray for a description.

# Syntax

spUnsignedIntArray CreateUnsignedIntArray();

# Parameters

CreateUnsignedIntArray takes no parameters.

# Return value

Type: UnsignedIntArray

# CreateUnsignedLongArray

UnsignedLongArray is the ulong implementation of ValueArray. See ValueArray for a description.

# Syntax

spUnsignedLongArray CreateUnsignedLongArray();

# Parameters

CreateUnsignedLongArray takes no parameters.

# Return value

Type: UnsignedLongArray

# CreateUnsignedShortArray

UnsignedShortArray is the ushort implementation of ValueArray. See ValueArray for a description.

# Syntax

spUnsignedShortArray CreateUnsignedShortArray();

# Parameters

CreateUnsignedShortArray takes no parameters.

# Return value

Type: UnsignedShortArray

# CreateValueArray

ValueArray adds methods to arrays to generically add, set and get tuples, through real values.

# Syntax

spValueArray CreateValueArray();

# Parameters

CreateValueArray takes no parameters.

# Return value

Type: ValueArray

# CreateVertexColorCaster

VertexColorCaster.

# Syntax

spVertexColorCaster CreateVertexColorCaster();

# Parameters

CreateVertexColorCaster takes no parameters.

# Return value

Type: VertexColorCaster

# CreateVertexColorCasterSettings

VertexColorCasterSettings is the interface for basic vertex color caster settings.

# Syntax

spVertexColorCasterSettings CreateVertexColorCasterSettings();

# Parameters

CreateVertexColorCasterSettings takes no parameters.

# Return value

Type: VertexColorCasterSettings

# CreateVertexWeightSettings

This settings object contains all settings related to how the user-set weighting field "VertexWeights" is setup and used in different contexts. The values in the field can be considered an "importance" factor. Generally, weights set to 1.0 are handled normally, values >1.0 are given greater importance, and values <1.0 are given less. These weights can either be manually set in the input geometry data or converted from vertex color sets using the WeightsFromColor settings. See the documentation of the WeightsFromColorMode property to see the details of how color intensity is mapped to vertex weight. Vertex weights can be used to reduce more or less aggressively on different parts of the mesh, or used to scale UV allocation in the parameterizers to give more or less texture area to different areas.

# Syntax

spVertexWeightSettings CreateVertexWeightSettings();

# Parameters

CreateVertexWeightSettings takes no parameters.

# Return value

Type: VertexWeightSettings

# CreateVisibilitySettings

Visibility settings contains the parameters for how to compute the visibility of a scene and how to use it, both in the ReductionProcessor and the RemeshingProcessor. The visibility information is computed for each part of the mesh determined by the visibility from the selected SceneCamera objects. Cameras are selected using the CameraSelectionSetID. The visibility can be used to guide the reducer and/or texture coordinates generator (parameterizer) with the flags UseVisibilityWeightsInReducer respective UseVisibilityWeightsInTexcoordGenerator. There is also an option to completely throw away triangles that are deemed not visible, using the CullOccludedGeometry flag.

# Syntax

spVisibilitySettings CreateVisibilitySettings();

# Parameters

CreateVisibilitySettings takes no parameters.

# Return value

Type: VisibilitySettings

# CreateWavefrontExporter

Wavefront .obj geometry exporter.

# Syntax

spWavefrontExporter CreateWavefrontExporter();

# Parameters

CreateWavefrontExporter takes no parameters.

# Return value

Type: WavefrontExporter

# CreateWavefrontImporter

OBJ scene importer

# Syntax

spWavefrontImporter CreateWavefrontImporter();

# Parameters

CreateWavefrontImporter takes no parameters.

# Return value

Type: WavefrontImporter

# CreateWelder

Welds vertices within the geometry or scene together.

# Syntax

spWelder CreateWelder();

# Parameters

CreateWelder takes no parameters.

# Return value

Type: Welder

# GetVersion

Get the current version of Simplygon

# Syntax

spString GetVersion();

# Parameters

GetVersion takes no parameters.

# Return value

Type: spString

← Consts →