Autodesk Creative Platform Core Version 1.19.0
A broad and deep collection of 2D and 3D capabilities.

IShapeGeneratorExporter Overview

This interface describes the different functions that a library that supports shape generation can export. Since these are all reserved keywords, a developer only need declare members with this name in their library. The interface is quite flexible, allowing a developer to choose one of 3 different techniques for implementing a shape generator:



Introduced in Version: 1.0.0

Interface Summary

Interface Details

Array [ ParameterJSON , ... ] params | Optional

Declares a set of parameters that users can interact with and modify. This member is preceded by shapeGeneratorDefaults or shapeGenerator.

See Also: shapeGeneratorDefaults, shapeGenerator

Solid3D process (parameters) | Optional

A synchronous method that should compute geometry from a set of user-defined parameters. This method is preceded by shapeGeneratorEvaluate or shapeGenerator.
  • parameters: Object [ String , Object ] - A Key-Value dictionary that contains the parameter values, where the key is equivalent to ParameterJSON.id and the value is the value of the parameter.
See Also: shapeGeneratorEvaluate, shapeGenerator

IShapeGenerator shapeGenerator() | Optional

Implementing this function takes higher precedent over the following members:

If this method is not implemented by the developer, it will be automatically implemented by the platform for the developer and it will wrap the other methods to standardize the entry points.

• shapeGeneratorDefaults (callback) | Optional , Asynchronous

An asynchronous version of params. This method takes higher precedent than params but is preceded by shapeGenerator.
  • callback: Function ( Array [ Object ] ) - A callback that's invoked with information about what parameters are available.


See Also: shapeGenerator, params

• shapeGeneratorEvaluate (parameters, callback) | Optional , Asynchronous

An asynchronous version of process. This method takes higher precedent than process but is preceded by shapeGenerator.
  • parameters: Object [ String , Object ] - A Key-Value dictionary that contains the parameter values, where the key is equivalent to ParameterJSON.id and the value is the value of the parameter.
  • callback: Function ( Solid3D ) - A callback function that accepts a single Solid3D as an argument.


See Also: shapeGenerator, process