Share

GroundPlaneSettings Object


Description

Methods

Name Description
GetSize Method that gets the current size of the displayed graphics for the ground plane. The plane is functionally infinite but has a plane that is displayed to allow the user to visualize it.
SetSize Method that sets the current size of the displayed graphics for the ground plane. The plane is functionally infinite but has a plane that is displayed to allow the user to visualize it. This method will fail if the AutoResize property is set to True.

Properties

Name Description
Application Returns the top-level parent application object. When used the context of Inventor, an Application object is returned. When used in the context of Apprentice, an ApprenticeServer object is returned.
AutoResize Gets or sets whether the ground plane should be resized automatically based on the component size.
Color Read-write property that gets and sets the color for the ground plane for the area inside the margin.
DisplayGridLines Read-write property that specifies whether to display grid lines.
FrontDirection Gets front directon of the ground plane.
HeightOffset Gets and sets the offset of the ground plane from the specified position.
MinorGridLineSpacing Gets and sets the spacing between minor grid lines in centimeters.
MinorLinesPerMajorGridLine Gets and sets the number of minor lines to appear between major lines.
Opacity Gets and sets the opacity of the ground plane.
Plane Property that returns the geometry of the ground plane. The returned Plane object provides information about the position and normal of the work plane.
Position Gets and sets the position of the ground plane.
ReflectionBlur Gets and sets the reflection’s blurriness, specifying the amount of blur the ground plane surface will produce.
ReflectionBlurFalloff Gets and sets where the model reflection seems to fade away.
Reflectivity Gets and sets the reflectivity of the ground plane.
Type Returns an ObjectTypeEnum indicating this object's type.
UpDirection Gets up directon of the ground plane.

Accessed From

DisplaySettings.GroundPlaneSettings

Version

Introduced in version 2011

Was this information helpful?