DraftAnalysis Object

Derived from: Analysis Object
Defined in namespace "adsk::fusion" and the header file is <Fusion/Fusion/DraftAnalysis.h>

Description

Represents any existing Draft Analysis that exist in the design.

Methods

Name Description
classType

Static function that all classes support that returns the type of the class as a string. The returned string matches the string returned by the objectType property. For example if you have a reference to an object and you want to check if it's a SketchLine you can use myObject.objectType == fusion.SketchLine.classType().

deleteMe

A method that deletes this Analysis.

Properties

Name Description
attributes A property that returns the collection of attributes associated with this Analysis.
directionEntity A property that gets and sets the entity that defines the pull direction used by the analysis. Valid entities are a planar, cylindrical, or conical BRepFace, a linear BRepEdge, a ConstructionPlane, or a ConstructionAxis.

The analysis stores a persistent reference to this entity. When getting this property, the reference is resolved to the corresponding live object in the current design state. The entity is only available if the timeline marker is at or after the feature that created it.
draftAngleNegative A property that gets and sets the negative draft angle in radians. This is the lower value of the draft angle range shown in the command dialog. Valid values are from -15 to 15 degrees.
draftAnglePositive A property that gets and sets the positive draft angle in radians. This is the upper value of the draft angle range shown in the command dialog. Valid values are from -15 to 15 degrees.
entityToken Returns a token for the Analysis object. The token can be saved and used later with the Design.findEntityByToken method to get back the same Analysis.

When using entity tokens, it's crucial to understand that the token string returned for a specific entity can be different over time. For example, you can have two different token strings obtained from the same entity at different times, and when you use findEntityByToken they will both return the same entity. Because of that, you should never compare entity tokens as a way to determine what the token represents. Instead, you need to use the findEntityByToken method to get the two entities identified by the tokens and then compare them.
inputEntities A property that gets and sets the entities being analyzed. Valid entities are solid and surface BRepBody objects, T-Spline surface bodies, and mesh bodies.

The analysis stores persistent references to the entities. When getting this property, the references are resolved to the corresponding live objects in the current design state. Entities are only available if the timeline marker is at or after the feature that created them. Draft analyses are not timeline features and do not have a timeline position.
isHighQuality A property that gets and sets if the analysis is displayed using higher quality rendering.
isLightBulbOn A property that gets and sets if the display is enabled for this Analysis object. If false, this analysis will be hidden. If true and the IsLightBulbOn property of the Analyses object is True the Analysis will be visible.
isToleranceShown A property that gets and sets if a tolerance zone is displayed around the draft angles.
isValid Indicates if this object is still valid, i.e. hasn't been deleted or some other action done to invalidate the reference.
isVisible Gets if this Analysis is currently visible in the graphics window. The visibility is controlled by a combination of the isLightBulbOn properties of the Analyses collection object and the Analysis object. If both are true, the Analysis will be visible.
name A property that gets and sets the name of the analysis. If you use a name that is not unique, Fusion will automatically append a number to the name to make it unique.
objectType This property is supported by all objects in the API and returns a string that contains the full name (namespace::objecttype) describing the type of the object.

It's often useful to use this in combination with the classType method to see if an object is a certain type. For example: if obj.objectType == adsk.core.Point3D.classType():
opacity A property that gets and sets the opacity of the analysis as an integer in the range of 0 to 100, where 100 is fully opaque.
toleranceAngleNegative A property that gets and sets the negative tolerance angle in radians that is added to the negative draft angle to define the tolerance zone. Valid values are from -5 to 5 degrees. This value is only used when isToleranceShown is true.
toleranceAnglePositive A property that gets and sets the positive tolerance angle in radians that is added to the positive draft angle to define the tolerance zone. Valid values are from -5 to 5 degrees. This value is only used when isToleranceShown is true.

Accessed From

DraftAnalyses.add, DraftAnalyses.item, DraftAnalyses.itemByName

Version

Introduced in version January 2023