Click or drag to resize

Decal Class

Represents a decal, or a picture that can be moved on an object.
Inheritance Hierarchy
SystemObject
  Rhino.RenderDecal

Namespace:  Rhino.Render
Assembly:  RhinoCommon (in RhinoCommon.dll)
Syntax
public class Decal : IDisposable

The Decal type exposes the following members.

Properties
  NameDescription
Public propertyCRC
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.
Public propertyDecalMapping Obsolete.
Gets the decal's mapping.
Public propertyDecalProjection Obsolete.
Gets the decal's projection. Used only when mapping is planar.
Public propertyEndLatitude
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. This is deprecated in favor of HorzSweep().
Public propertyEndLongitude
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. This is deprecated in favor of VertSweep().
Public propertyHeight
Gets the height of the decal. Only used when mapping is cylindrical.
Public propertyMapping
Gets the decal's mapping.
Public propertyMapToInside
Used only when mapping is cylindrical or spherical.
Public propertyOrigin
Gets the origin of the decal in world space.
Public propertyProjection
Gets the decal's projection. Used only when mapping is planar.
Public propertyRadius
Gets the radius of the decal. Only used when mapping is cylindrical or spherical.
Public propertyStartLatitude
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. This is deprecated in favor of HorzSweep().
Public propertyStartLongitude
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. This is deprecated in favor of VertSweep().
Public propertyTextureInstanceId
Gets the texture ID for this decal.
Public propertyTransparency
Gets the decal's transparency in the range 0 to 1.
Public propertyVectorAcross
Gets the vector across. For cylindrical and spherical mapping, the vector is unitized.
Public propertyVectorUp
For cylindrical and spherical mapping, the vector is unitized.
Top
Methods
  NameDescription
Public methodConstPointer
Public methodStatic memberCreate
Public methodCustomData
Gets decal custom data for the current renderer. See Rhino.Plugins.RenderPlugIn.ShowDecalProperties.
Public methodCustomData(Guid)
Gets decal custom data for a specified renderer. See Rhino.Plugins.RenderPlugIn.ShowDecalProperties.
Public methodDispose
Releases all resources used by the Decal
Public methodDispose(Boolean)
Releases the unmanaged resources used by the Decal and optionally releases the managed resources
Public methodEquals
Determines whether the specified object is equal to the current object.
(Inherited from Object.)
Protected methodFinalize (Overrides ObjectFinalize.)
Public methodGetHashCode
Serves as the default hash function.
(Inherited from Object.)
Public methodGetTextureMapping
The TextureMapping of the decal.
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Public methodHorzSweep
Gets the angles of the decal's arc of 'horizontal sweep'. Replaces StartLatitude and EndLatitude.
Protected methodMemberwiseClone
Creates a shallow copy of the current Object.
(Inherited from Object.)
Public methodNonConstPointer
Public methodTextureRenderCRC(TextureRenderHashFlags) Obsolete.
This method is deprecated in favor of TextureRenderHash below.
Public methodTextureRenderCRC(TextureRenderHashFlags, LinearWorkflow) Obsolete.
This method is deprecated in favor of TextureRenderHash below.
Public methodTextureRenderHash(CrcRenderHashFlags) Obsolete.
Get the texture render hash for the referenced texture using the specified CrcRenderHashFlags.
Public methodTextureRenderHash(CrcRenderHashFlags, LinearWorkflow) Obsolete.
Get the texture render hash for the referenced texture using the specified CrcRenderHashFlags and linear workflow.
Public methodToString
Returns a string that represents the current object.
(Inherited from Object.)
Public methodTryGetColor Obsolete.
Blend color with the decal color at a given point.
Public methodUVBounds
The UV bounds of the decal. Only used when mapping is UV.
Public methodVertSweep
Gets the angles of the decal's arc of 'vertical sweep'. Replaces StartLongitude and EndLongitude.
Top
See Also