CanvasEffects.isGroundPlaneEnabled Property

Parent Object: CanvasEffects
Defined in namespace "adsk::core" and the header file is <Core/Application/CanvasEffects.h>

Description

Gets and sets if the ground plane is enabled. Setting this property is only valid when the graphics preset is set to "custom" and will fail if it is set to "quality" or "performance". The graphics preset can be determined by using the graphicsPreset property, as shown below.

Application.preferences.graphicsPreferences.graphicsPreset

Syntax

"canvasEffects_var" is a variable referencing a CanvasEffects object.

# Get the value of the property.
propertyValue = canvasEffects_var.isGroundPlaneEnabled

# Set the value of the property.
canvasEffects_var.isGroundPlaneEnabled = propertyValue
"canvasEffects_var" is a variable referencing a CanvasEffects object.
#include <Core/Application/CanvasEffects.h>

// Get the value of the property.
boolean propertyValue = canvasEffects_var->isGroundPlaneEnabled();

// Set the value of the property, where value_var is a boolean.
bool returnValue = canvasEffects_var->isGroundPlaneEnabled(value_var);

Property Value

This is a read/write property whose value is a boolean.

Version

Introduced in version May 2025