GroundPlane

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

Constructors

GroundPlane

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

GroundPlane

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

Finalizer

~GroundPlane

#
~GroundPlane()

Properties

Altitude

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

AutoAltitude

#Since v6.0
public bool AutoAltitude { get; set; }
Determines whether the ground plane is fixed by the Altitude property, or whether it is automatically placed at the lowest point in the model.

Enabled

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

MaterialInstanceId

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

ShadowOnly

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

ShowUnderside

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

TextureOffset

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

TextureOffsetLocked

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

TextureRotation

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

TextureSize

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

TextureSizeLocked

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

Methods

BeginChange

public void BeginChange(ChangeContexts cc)
inherited fromDocumentOrFreeFloatingBase
Parameters:
cc (RenderContent.ChangeContexts)

CopyFrom

#Since v6.0
public override void CopyFrom(FreeFloatingBase src)
Parameters:
src (FreeFloatingBase)
Overrides: FreeFloatingBase.CopyFrom

Dispose

#Since v8.0
public void Dispose()

Events

Changed

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