就业培训     下载中心     Wiki     联络 登录   注册

---

Add Assets

A Substance asset can be imported using the Filename of a Substance archive file (.sbsar).

• ImportSubstance() : Imports the referenced Substance archive file into the given BaseDocument .
• InsertLastSubstance() Inserts the given Substance asset into the given BaseDocument .

// import Substance const SUBSTANCE_IMPORT_RESULT res = ImportSubstance (doc, filename, copy, false , false , true , &substance);

// check if the Substance was imported successfully const Bool importFailure = res != SUBSTANCE_IMPORT_RESULT::SUCCESS ; const Bool invalidSubstance = substance == nullptr ; if (importFailure || invalidSubstance) return maxon::UnexpectedError( MAXON_SOURCE_LOCATION );

// copy Substance BaseList2D * const copySubstance = static_cast< BaseList2D * > (substance-> GetClone ( COPYFLAGS::NONE , nullptr )); if (copySubstance == nullptr ) return maxon::OutOfMemoryError( MAXON_SOURCE_LOCATION ); const String originalName = substance-> GetName (); const String copyName = originalName + " Copy" ; copySubstance-> SetName (copyName);

// insert copy if (! InsertLastSubstance (doc, copySubstance)) return maxon::UnknownError( MAXON_SOURCE_LOCATION );

Get Assets

A Substance asset can contain one or multiple graphs, input parameters and output bitmaps.

• GetSubstanceGraph() : Returns an asset graph and can be used to iterate over the graphs.
• GetSubstanceInput() Returns an asset input and can be used to iterate over the inputs.
• GetSubstanceOutput() : Returns an asset output and can be used to iterate over the outputs. The output IDs are needed to use CreateSubstanceShader() and AssignChannelToMaterial() .

// loop through graphs do { String name; graph = GetSubstanceGraph (substance, graph, name); if (graph != nullptr ) { ApplicationOutput ( "Graph Name: " + name);

// loop through inputs

// loop through outputs

Materials and Shaders

Substance assets are used in shaders and are typically applied (but not limited) to materials:

• CreateMaterial() : Creates a standard material based on the given asset. See also Substance Preferences .
• CreateSubstanceShader() : Creates a Substance shader based on the given asset. The created shader can be configured using the output IDs delivered by GetSubstanceOutput() .
• AssignChannelToMaterial() : Creates a Substance shader in the given channel of the given 材质 . This function needs the output IDs delivered by GetSubstanceOutput() .

An example how to configure a Substance shader can be found on Substance Elements Manual .

Substance Preferences

These utility functions allow fast access to the most important Substance preferences.

• PrefsGetMaterialModeSetting() : Returns how the automatically created material is set up (see CreateMaterial() ).
• SUBSTANCE_MATERIAL_MODE : The creation mode.
  • SUBSTANCE_MATERIAL_MODE::STANDARD : Create standard material.
  • SUBSTANCE_MATERIAL_MODE::METALLIC : Create metallic material.
  • SUBSTANCE_MATERIAL_MODE::GLOSSY : Create glossy material.
  • SUBSTANCE_MATERIAL_MODE::AUTO : Use heuristic to choose one of the three above (see Cinema 4D 's user manual).
  • SUBSTANCE_MATERIAL_MODE::NONE : Do not create material.
• PrefsGetPreviewSetting() : Returns the preview mode for the Content Browser.

Utility

Further utility functions are:

• MaterialUsesSubstance() : Returns true if the given BaseMaterial uses Substances.
• GetSubstanceMosaicPreview() : Returns an image with previews of the output channels of the given asset.

// get first material BaseMaterial * material = doc-> GetFirstMaterial ();

// check all materials

延伸阅读

• Substance Elements Manual
• BaseDocument Manual
• BaseMaterial Manual
• Material Manual
• BaseShader Manual
• AtomArray Manual
• Filename Manual