Canvas.planarEntity Property

Parent Object: Canvas
Defined in namespace "adsk::fusion" and the header file is <Fusion/Image/Canvas.h>

Description

Gets and sets the plane the canvas is associated with. This can be either a planar Face or a construction plane. In the case where the design history is not being captured or the canvas is being created in a base feature, this can be a Plane object.

Syntax

"canvas_var" is a variable referencing a Canvas object.

# Get the value of the property.
propertyValue = canvas_var.planarEntity

# Set the value of the property.
canvas_var.planarEntity = propertyValue
"canvas_var" is a variable referencing a Canvas object.
#include <Fusion/Image/Canvas.h>

// Get the value of the property.
Ptr<Base> propertyValue = canvas_var->planarEntity();

// Set the value of the property, where value_var is a Base.
bool returnValue = canvas_var->planarEntity(value_var);

Property Value

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

Version

Introduced in version May 2023