Decal

Public Class

Represents a decal, or a picture that can be moved on an object.

Inheritance Hierarchy

System.Object
Rhino.Render.Decal

Namespace: Rhino.Render

Assembly: RhinoCommon (in RhinoCommon.dll)

Syntax

public class Decal : IDisposable

The Decal type exposes the following members.

Properties

Name

Description

---

Public Property

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.

---

Public Property

DecalMapping

Obsolete.

Gets the decal’s mapping.

---

Public Property

DecalProjection

Obsolete.

Gets the decal’s projection. Used only when mapping is planar.

---

Public Property

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. This is deprecated in favor of HorzSweep().

---

Public Property

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. This is deprecated in favor of VertSweep().

---

Public Property

Height

Gets the height of the decal. Only used when mapping is cylindrical.

---

Public Property

Mapping

Gets the decal’s mapping.

---

Public Property

MapToInside

Used only when mapping is cylindrical or spherical.

---

Public Property

Origin

Gets the origin of the decal in world space.

---

Public Property

Projection

Gets the decal’s projection. Used only when mapping is planar.

---

Public Property

Radius

Gets the radius of the decal. Only used when mapping is cylindrical or spherical.

---

Public Property

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. This is deprecated in favor of HorzSweep().

---

Public Property

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. This is deprecated in favor of VertSweep().

---

Public Property

TextureInstanceId

Gets the texture ID for this decal.

---

Public Property

Transparency

Gets the decal’s transparency in the range 0 to 1.

---

Public Property

VectorAcross

Gets the vector across. For cylindrical and spherical mapping, the vector is unitized.

---

Public Property

VectorUp

For cylindrical and spherical mapping, the vector is unitized.

---

Methods

Name

Description

---

Public Method

ConstPointer

---

Public Method
Static Member

Create

---

Public Method

CustomData.

Gets decal custom data for the current renderer. See Rhino.Plugins.RenderPlugIn.ShowDecalProperties.

---

Public Method

CustomData(Guid)

Gets decal custom data for a specified renderer. See Rhino.Plugins.RenderPlugIn.ShowDecalProperties.

---

Public Method

Dispose.

Releases all resources used by the Decal

---

Public Method

Dispose(Boolean)

Releases the unmanaged resources used by the Decal and optionally releases the managed resources

---

Public Method

Equals

Determines whether the specified object is equal to the current object.

(Inherited from Object.)

---

Protected Method

Finalize

(Overrides Object.Finalize..)

---

Public Method

GetHashCode

Serves as the default hash function.

(Inherited from Object.)

---

Public Method

GetTextureMapping

The TextureMapping of the decal.

---

Public Method

GetType

Gets the Type of the current instance.

(Inherited from Object.)

---

Public Method

HorzSweep

Gets the angles of the decal’s arc of ‘horizontal sweep’. Replaces StartLatitude and EndLatitude.

---

Protected Method

MemberwiseClone

Creates a shallow copy of the current Object.

(Inherited from Object.)

---

Public Method

NonConstPointer

---

Public Method

TextureRenderCRC(TextureRenderHashFlags)

Obsolete.

This method is deprecated in favor of TextureRenderHash below.

---

Public Method

TextureRenderCRC(TextureRenderHashFlags, LinearWorkflow)

Obsolete.

This method is deprecated in favor of TextureRenderHash below.

---

Public Method

TextureRenderHash(CrcRenderHashFlags)

Obsolete.

Get the texture render hash for the referenced texture using the specified CrcRenderHashFlags.

---

Public Method

TextureRenderHash(CrcRenderHashFlags, LinearWorkflow)

Obsolete.

Get the texture render hash for the referenced texture using the specified CrcRenderHashFlags and linear workflow.

---

Public Method

ToString

Returns a string that represents the current object.

(Inherited from Object.)

---

Public Method

TryGetColor

Obsolete.

Blend color with the decal color at a given point.

---

Public Method

UVBounds

The UV bounds of the decal. Only used when mapping is UV.

---

Public Method

VertSweep

Gets the angles of the decal’s arc of ‘vertical sweep’. Replaces StartLongitude and EndLongitude.

---