GroundPlane

Public Class

Represents an infinite plane for implementation by renderers. See

SupportsFeature

.

Inheritance Hierarchy

System.Object
Rhino.Render.FreeFloatingBase
Rhino.Render.DocumentOrFreeFloatingBase
Rhino.Render.GroundPlane

Namespace: Rhino.Render

Assembly: RhinoCommon (in RhinoCommon.dll)

Syntax

public sealed class GroundPlane : DocumentOrFreeFloatingBase,
  IDisposable

The GroundPlane type exposes the following members.

Constructors

Name

Description

---

Public Method

GroundPlane.

Create a utility object not associated with any document

---

Public Method

GroundPlane(GroundPlane)

Create a utility object not associated with any document from another object

---

Properties

Name

Description

---

Public Property

Altitude

Height above world XY plane in model units. Auto-altitude is computed if enabled.

---

Public Property

AutoAltitude

Determines whether the ground plane is fixed by the Altitude property, or whether it is automatically placed at the lowest point in the model.

---

Public Property

Enabled

Determines whether the document ground plane is enabled.

---

Public Property

MaterialInstanceId

Id of material in material table for this ground plane.

---

Public Property

ShadowOnly

Determines whether the ground plane shows the material assigned, or whether it is transparent, but captures shadows.

---

Public Property

ShowUnderside

If this is off, the ground plane will not be visible when seen from below.

---

Public Property

TextureOffset

Texture mapping offset in world units.

---

Public Property

TextureOffsetLocked

Texture offset locked.

---

Public Property

TextureRotation

Texture mapping rotation around world origin + offset in degrees.

---

Public Property

TextureSize

Texture mapping single UV span size in world units.

---

Public Property

TextureSizeLocked

Texture size locked.

---

Methods

Name

Description

---

Public Method

BeginChange

(Inherited from DocumentOrFreeFloatingBase.)

---

Public Method

CopyFrom

(Overrides

FreeFloatingBase.CopyFrom(FreeFloatingBase)

.)

---

Public Method

Dispose

Releases all resources used by the GroundPlane

---

Public Method

EndChange

(Inherited from DocumentOrFreeFloatingBase.)

---

Public Method

Equals

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

(Inherited from Object.)

---

Protected Method

Finalize

(Overrides

FreeFloatingBase.Finalize.

.)

---

Public Method

GetHashCode

Serves as the default hash function.

(Inherited from Object.)

---

Public Method

GetType

Gets the Type of the current instance.

(Inherited from Object.)

---

Public Method

ToString

Returns a string that represents the current object.

(Inherited from Object.)

---

Events

Name

Description

---

Public Event
Static Member

Changed

This event is raised when a GroundPlane property value is changed.

---