SketchControlPointSpline.isControlFrameDisplayed Property

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

Description

Gets and sets if the control frame of the curve is currently displayed. Using this property is useful to be able to determine if the controlPoints and controlFrameLines properties will return useful information or not and if the addControlPoint method will succeed or not.

Remarks

There are cases where Fusion creates a control point spline but does not display the control frame. An example is when you create an offset of a spline.

If the value of the property is false, you can set it to true to cause the control frame to be displayed. If the curve is being controlled by any existing constraints, setting this property to true will fail. For example, if the curve is the result of an offset and the offset constraint still exists, you cannot turn on the control frame. However, if you first delete the constrains so the curve is now independent you can set this property to true and display the control frame.

Setting this property to false will always fail. Turning off the display of the control frame is not supported by Fusion.

Syntax

"sketchControlPointSpline_var" is a variable referencing a SketchControlPointSpline object.

# Get the value of the property.
propertyValue = sketchControlPointSpline_var.isControlFrameDisplayed

# Set the value of the property.
sketchControlPointSpline_var.isControlFrameDisplayed = propertyValue
"sketchControlPointSpline_var" is a variable referencing a SketchControlPointSpline object.
#include <Fusion/Sketch/SketchControlPointSpline.h>

// Get the value of the property.
boolean propertyValue = sketchControlPointSpline_var->isControlFrameDisplayed();

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

Property Value

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

Version

Introduced in version October 2022