RhinoCommon API
Decal Class |
Represents a decal, or a picture that can be moved on an object.
Inheritance HierarchyNamespace: Rhino.Render
Assembly: RhinoCommon (in RhinoCommon.dll)
SyntaxThe Decal type exposes the following members.
Properties| Name | Description | |
|---|---|---|
 | CRC |
The decal CRC identifies a decal by its state. Multiple decals which would be
exactly the same would have the same CRC and are culled from the system.
If you store this value with the intention of using it to find the decal again
later, you must update your stored value whenever the decal state changes.
You can detect when a decal changes by watching for the OnUserDataTransformed event.
|
| DecalMapping |
Gets the mapping of the decal.
|
| DecalProjection |
Gets the decal's projection. Used only when mapping is planar.
|
| EndLatitude |
Gets the end angle of the decal's arc of latitude or 'horizontal sweep'. This is actually a LONGITUDINAL angle. Only used when mapping is cylindrical or spherical.
|
| EndLongitude |
Gets the end angle of the decal's arc of longitude or 'vertical sweep'. This is actually a LATITUDINAL angle. Only used when mapping is spherical.
|
| Height |
Gets the height of the decal. Only used when mapping is cylindrical.
|
| MapToInside |
Used only when mapping is cylindrical or spherical.
|
| Origin |
Gets the origin of the decal in world space.
|
| Radius |
Gets the radius of the decal. Only used when mapping is cylindrical or spherical.
|
| StartLatitude |
Gets the start angle of the decal's arc of latitude or 'horizontal sweep'. This is actually a LONGITUDINAL angle. Only used when mapping is cylindrical or spherical.
|
| StartLongitude |
Gets the start angle of the decal's arc of longitude or 'vertical sweep'. This is actually a LATITUDINAL angle. Only used when mapping is spherical.
|
| TextureInstanceId |
Gets the texture ID for this decal.
|
| Transparency |
Gets the decal's transparency in the range 0 to 1.
|
| VectorAcross |
Gets the vector across. For cylindrical and spherical mapping, the vector is unitized.
|
| VectorUp |
For cylindrical and spherical mapping, the vector is unitized.
|
Methods| Name | Description | |
|---|---|---|
 | ConstPointer | |
 | Create | |
| CustomData |
Gets custom data associated with this decal - see Rhino.Plugins.RenderPlugIn.ShowDecalProperties.
|
| Dispose | Releases all resources used by the Decal |
| Dispose(Boolean) | Releases the unmanaged resources used by the Decal and optionally releases the managed resources |
| Equals | Determines whether the specified object is equal to the current object. (Inherited from Object.) |
 | Finalize | (Overrides ObjectFinalize.) |
| GetHashCode | Serves as the default hash function. (Inherited from Object.) |
| GetTextureMapping |
The TextureMapping of the decal.
|
| GetType | Gets the Type of the current instance. (Inherited from Object.) |
| MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object.) |
| NonConstPointer | |
| TextureRenderCRC(TextureRenderHashFlags) |
Get the texture render CRC for the referenced texture using the TextureRenderHashFlags
given
|
| TextureRenderCRC(TextureRenderHashFlags, LinearWorkflow) |
Get the texture render CRC for the referenced texture using the TextureRenderHashFlags
given along with the LinearWorkflow
|
| ToString | Returns a string that represents the current object. (Inherited from Object.) |
| TryGetColor |
Blend color with the decal color at a given point.
|
| UVBounds |
The UV bounds of the decal. Only used when mapping is UV.
|
See Also