Click or drag to resize

GroundPlane Class

Represents an infinite plane for implementation by renderers. See SupportsFeature.
Inheritance Hierarchy

Namespace:  Rhino.Render
Assembly:  RhinoCommon (in RhinoCommon.dll)
Syntax
public class GroundPlane : DocumentOrFreeFloatingBase

The GroundPlane type exposes the following members.

Constructors
  NameDescription
Public methodGroundPlane
Create an utility object not associated with any document
Public methodGroundPlane(GroundPlane)
Create an utility object not associated with any document from another object
Top
Properties
  NameDescription
Public propertyAltitude
Height above world XY plane in model units.
Public propertyAutoAltitude
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 propertyEnabled
Determines whether the document ground plane is enabled.
Public propertyMaterialInstanceId
Id of material in material table for this ground plane.
Public propertyShadowOnly
Determines whether the ground plane shows the material assigned, or whether it is transparent, but captures shadows.
Public propertyShowUnderside
If this is off, the ground plane will not be visible when seen from below.
Public propertyTextureOffset
Texture mapping offset in world units.
Public propertyTextureOffsetLocked
Texture offset locked.
Public propertyTextureRotation
Texture mapping rotation around world origin + offset in degrees.
Public propertyTextureSize
Texture mapping single UV span size in world units.
Public propertyTextureSizeLocked
Texture size locked.
Top
Methods
  NameDescription
Public methodBeginChange
Call this function before making any change to this object (calling a setter) otherwise undo will not work correctly. Calls to BeginChange must be paired with a call to EndChange.
(Inherited from DocumentOrFreeFloatingBase.)
Public methodCopyFrom (Overrides FreeFloatingBaseCopyFrom(FreeFloatingBase).)
Public methodEndChange
See BeginChange
(Inherited from DocumentOrFreeFloatingBase.)
Public methodEquals
Determines whether the specified object is equal to the current object.
(Inherited from Object.)
Protected methodFinalize
Handle destruction of the un-managed CPP object.
(Inherited from FreeFloatingBase.)
Public methodGetHashCode
Serves as the default hash function.
(Inherited from Object.)
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Protected methodMemberwiseClone
Creates a shallow copy of the current Object.
(Inherited from Object.)
Public methodToString
Returns a string that represents the current object.
(Inherited from Object.)
Top
Events
  NameDescription
Public eventStatic memberChanged
This event is raised when a GroundPlane property value is changed.
Top
Version Information

Rhino for Windows

Supported in: 6.27
See Also