EffectInstance
Description:
An effect instance that controls the appearance of geometry.
An effect instance that controls the appearance of geometry.
Remarks:
Each effect instance should be used with geometry of a matching vertex format. Only a subset of effect instance parameters is relevant to geometry of a particular vertex format. If the vertex format does not specify vertex color (VertexPosition or VertexPositionNormal) the following parameters should be set: If the vertex format specifies vertex normals (VertexPositionNormal or VertexPositionNormalColored) the following parameters should be set: If the vertex format specifies a color, then the geometry will be colored according to the color of each vertex. Otherwise, the geometry's color will come from the effect instance parameters. Similarly, the transparency parameter affects all of the geometry associated with the effect, while the transparency of the individual vertices can also be controlled via the transparency component of their colors.
Each effect instance should be used with geometry of a matching vertex format. Only a subset of effect instance parameters is relevant to geometry of a particular vertex format. If the vertex format does not specify vertex color (VertexPosition or VertexPositionNormal) the following parameters should be set: If the vertex format specifies vertex normals (VertexPositionNormal or VertexPositionNormalColored) the following parameters should be set: If the vertex format specifies a color, then the geometry will be colored according to the color of each vertex. Otherwise, the geometry's color will come from the effect instance parameters. Similarly, the transparency parameter affects all of the geometry associated with the effect, while the transparency of the individual vertices can also be controlled via the transparency component of their colors.
Inheritance Hierarchy:
System.Object
Autodesk.Revit.DB.DirectContext3D.EffectInstance
System.Object
Autodesk.Revit.DB.DirectContext3D.EffectInstance
public class EffectInstance : IDisposable| Name | Return Type | Description |
|---|---|---|
| EffectInstance(VertexFormatBits) | None | Constructs the effect instance for geometry having the specified vertex format. |
| Name | Return Type | Description |
|---|---|---|
| Dispose() | None | Releases all resources used by the |
| IsValid() | bool | Tests whether the effect instance is valid for rendering. |
| MatchesFormat(VertexFormat) | bool | Tests whether the effect instance is appropriate for the given vertex format. |
| SetAmbientColor(Color) | None | Sets the ambient color parameter of the effect instance. |
| SetColor(Color) | None | Sets the color parameter of the effect instance. |
| SetDiffuseColor(Color) | None | Sets the diffuse color parameter of the effect instance. |
| SetEmissiveColor(Color) | None | Sets the emissive color parameter of the effect instance. |
| SetGlossiness(Double) | None | Sets the glossiness parameter of the effect instance. |
| SetSpecularColor(Color) | None | Sets the specular color parameter of the effect instance. |
| SetTransparency(Double) | None | Sets the transparency parameter of the effect instance. |
| Name | Return Type | Description |
|---|---|---|
| IsValidObject | bool | Specifies whether the .NET object represents a valid Revit entity. |