Design.areaProperties Method

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

Description

Returns the AreaProperties object that has properties for getting the area, perimeter, centroid, etc for a collection of 2D sketch profiles and/or planar surfaces that all lie on the same plane.

Syntax

"design_var" is a variable referencing a Design object.
# Uses no optional arguments.
returnValue = design_var.areaProperties(inputs)

# Uses optional arguments.
returnValue = design_var.areaProperties(inputs, accuracy)
"design_var" is a variable referencing a Design object.

#include <Fusion/Fusion/Design.h>

// Uses no optional arguments.
returnValue = design_var->areaProperties(inputs);

// Uses optional arguments.
returnValue = design_var->areaProperties(inputs, accuracy);

Return Value

Type Description
AreaProperties Returns an AreaProperties object that can be used to examine the area results.

Parameters

Name Type Description
inputs ObjectCollection A collection of one or more 2D sketch profile and/or planar surface input objects to perform the calculations on. Supported input object types are 2D closed sketch profiles and planar surfaces. Object must all lie on the same plane. Calculation results reflect the sums of the input objects (i.e. total area of multiple sketch profiles)
accuracy CalculationAccuracy Specifies the desired level of computational accuracy of the property calculations. The default value of 'LowCalculationAccuracy' returns results within a +/- 1% error margin.

This is an optional argument whose default value is CalculationAccuracy.LowCalculationAccuracy.

Samples

Name Description
API Sample for AreaProperties Demonstrates how to use AreaProperties

Version

Introduced in version March 2016