new Material()
Materials are objects that control how the visual 'surfaces' defined in a Geometry are configured and ultimately rendered by WebGL. This visual configuration is managed through the EffectNodes and EffectControllers on each Material.
MEMBERS
-
auxShaderSegment_postMatrixMath :string
-
An auxiliary shader support string that enables for the insertion of GLSL shader code after the 'matrix math' segment of the vertex shader. This can be used to add custom functionality to this Material's vertex shader beyond the standard built-in functionality.
- Default Value:
- ""
-
auxShaderSegment_vertexSupport :string
-
An auxiliary shader support string that enables for the insertion of GLSL shader code before the vertex shader main. This can be used to add custom functionality to this Material's vertex shader beyond the built-in EffectNode functionality.
- Default Value:
- ""
-
blending :string
-
String determining the blending mode that is applied to this Material. For a list of available blending options, see nc.constants.blendingModes.
- Default Value:
- nc.constants.blendingModes.standard
-
colorMultiply :Color
-
The EffectController for the 'ColorMultiply' EffectNode, which multiplies the red, green, blue, and alpha color values of the Material it is applied to.
-
readonly compiledFragmentShader :string
-
The the compiled GLSL fragment shader string for this Material, resulting from combining this Material's EffectNodes. This property is generally only meant for troubleshooting, and is read-only.
-
readonly compiledVertexShader :string
-
The the compiled GLSL vertex shader string for this Material, resulting from combining this Material's EffectNodes. This property is generally only meant for troubleshooting, and is read-only.
-
readonly effectNodesLedger :Array.<string>
-
A list of the names of this Material's EffectNodes for quick-reference while debugging or inspecting. To access and manipulate the actual EffectNodes, use Material.getEffectNodes, Material.setEffectNodes, or Material.addEffectNodes.
-
fillColor :Color
-
The EffectController for the 'FillColor' EffectNode, which entirely fills the associated Geometry with the red, green, blue, and alpha color values provided.
-
inheritedTypes :object
-
Dictionary object listing all of the types this object is compatible with.
-
particleSystemParameters :particleSystemParameters
-
The particleSystemParameters EffectController. This is an instance of the dynamically defined EffectController 'particleSystemParameters' (base type: 'Vector4'). To get a new instance, use 'nc.effectControllers['particleSystemParameters'].new()'.
-
shaderSegment_matrixMath :string
-
A shader segment string, determining the GLSL code used in the 'matrix math' segment at the end of the vertex shader. This can be used to customize the vertex shader matrix math.
- Default Value:
- "gl_Position=projectionMatrix*(modelViewMatrix*vec4(vertex,1.0));"
-
shapify :shapify
-
The EffectController for the 'Shapify' EffectNode. The Shapify EffectNode converts edge data stored in a 'shapified' Texture into a presentable image with edges that stay sharp regardless of the scale of the associated GraphicObject. This is an instance of the dynamically defined EffectController 'shapify' (base type: 'Vector2'). To get a new instance, use 'nc.effectControllers['shapify'].new()'.
-
type :string
-
Type identifier.
METHODS
-
addEffectNodes(effectNodes)
-
Adds the given EffectNodes to this Material. EffectNodes are GPU-driven visual effects assigned to SceneObjects, GraphicObjects, and ultimately Materials. Each EffectNode can be manipulated dynamically by one or more EffectControllers, which are accessable as direct members of the given SceneObject or Material. When a GraphicObject is set to a particular GraphicAsset, it's Materials adopt the GraphicAsset's EffectNode and EffectController presets by default, but they can be customized at any time.
Parameters:
Name Type Attributes Default Description effectNodesArray.<EffectNode> | EffectNode The EffectNodes to add to this Material.
-
dispose()
-
Disposes this Material, and removes internal Incisor® references to it to aid memory management.
-
getEffectNodes() returns {Array.<EffectNode>}
-
Returns this Material's current EffectNodes. EffectNodes are GPU-driven visual effects assigned to SceneObjects, GraphicObjects, and ultimately Materials. Each EffectNode can be manipulated dynamically by one or more EffectControllers, which are accessable as direct members of the given SceneObject or Material. When a GraphicObject is set to a particular GraphicAsset, it's Materials adopt the GraphicAsset's EffectNode and EffectController presets by default, but they can be customized at any time.
Returns:
Array.<EffectNode> -
setEffectNodes(effectNodes)
-
Sets the EffectNodes for this Material. EffectNodes are GPU-driven visual effects assigned to SceneObjects, GraphicObjects, and ultimately Materials. Each EffectNode can be manipulated dynamically by one or more EffectControllers, which are accessable as direct members of the given SceneObject or Material. When a GraphicObject is set to a particular GraphicAsset, it's Materials adopt the GraphicAsset's EffectNode and EffectController presets by default, but they can be customized at any time.
Parameters:
Name Type Attributes Default Description effectNodesArray.<EffectNode> | EffectNode The new list of EffectNodes that will apply to this SceneObject and all of its Materials.