public sealed class GroundPlane : DocumentOrFreeFloatingBase, IDisposable
Represents an infinite plane for implementation by renderers. See SupportsFeature.

Constructors

GroundPlane

#Since v6.0
Create a utility object not associated with any document
public GroundPlane()

GroundPlane

#Since v6.0
Create a utility object not associated with any document from another object
public GroundPlane(
GroundPlane
g
)

Finalizer

~GroundPlane

#
~GroundPlane()

Properties

Altitude

#Since v5.0
Height above world XY plane in model units. Auto-altitude is computed if enabled.
public double Altitude { get; set; }

AutoAltitude

#Since v6.0
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 bool AutoAltitude { get; set; }

Enabled

#Since v5.0
Determines whether the document ground plane is enabled.
public bool Enabled { get; set; }

MaterialInstanceId

#Since v5.0
Id of material in material table for this ground plane.
public Guid MaterialInstanceId { get; set; }

ShadowOnly

#Since v6.0
Determines whether the ground plane shows the material assigned, or whether it is transparent, but captures shadows.
public bool ShadowOnly { get; set; }

ShowUnderside

#Since v6.0
If this is off, the ground plane will not be visible when seen from below.
public bool ShowUnderside { get; set; }

TextureOffset

#Since v5.0
Texture mapping offset in world units.
public Vector2d TextureOffset { get; set; }

TextureOffsetLocked

#Since v6.0
Texture offset locked.
public bool TextureOffsetLocked { get; set; }

TextureRotation

#Since v5.0
Texture mapping rotation around world origin + offset in degrees.
public double TextureRotation { get; set; }

TextureSize

#Since v5.0
Texture mapping single UV span size in world units.
public Vector2d TextureSize { get; set; }

TextureSizeLocked

#Since v6.0
Texture size locked.
public bool TextureSizeLocked { get; set; }

Methods

BeginChange

public void BeginChange()
inherited fromDocumentOrFreeFloatingBase

CopyFrom

#Since v6.0
public override void CopyFrom()

Dispose

#Since v8.0
public void Dispose()

Events

Changed

#Since v5.10
This event is raised when a GroundPlane property value is changed.
public static event EventHandler<RenderPropertyChangedEvent> Changed