SheetMetalRule Object

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

Description

A sheet metal rule.

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 Deletes the rule from the design or library. If the rule is in the library and set as the default rule, you cannot delete it. If the rule is in a design and is used by a component you cannot use it.

Properties

Name Description
bendRadius The interior radius of the bends. Use the returned SheetMetalRuleValue object to get and set the current value of the radius.
gap The value used for miter, rip, and seam, gaps. Use the returned SheetMetalRuleValue object to get and set the current value of the gap.
isDefault This gets and sets which rule in a library is the default rule. This is only valid for rules in a library and will fail for rules in a design.
isUsed Indicates if this rule is currently being used by a component. This is only valid for rules in a design.
isValid Indicates if this object is still valid, i.e. hasn't been deleted or some other action done to invalidate the reference.
kFactor The K Factor value that is used when calculating the flat pattern. It must be a value between 0 and 1.
name The name of the sheet metal rule. When setting the name, it should be unique with respect to other sheet metal rules in the design or library.
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():
parentDesign Returns the parent design for a sheet metal rule in a design or it returns null if the sheet metal rule is in the library.
reliefDepth The relief depth used in the flat pattern. Use the returned SheetMetalRuleValue object to get and set the current value of the relief depth.
reliefRemnant The relief remnant used in the flat pattern. Use the returned SheetMetalRuleValue object to get and set the current value of the relief remnant.
reliefShape Gets and sets the bend relief shape to use.
reliefWidth The relief width used in the flat pattern. Use the returned SheetMetalRuleValue object to get and set the current value of the relief width.
thickness The thickness of the part. Use the returned SheetMetalRuleValue object to get and set the current value of the thickness.
threeBendReliefRadius The relief size used when three bends meet in the flat pattern and the relief shape is "round with radius". Use the returned SheetMetalRuleValue object to get and set the current value of the relief size.
threeBendReliefShape Gets and sets the relief shape to use when three bends intersect.
twoBendReliefPlacement Gets and sets the relief placement for a two bend relief shape. When the relief shape is round, both intersection and tangent are valid placements. For square shape, only intersection is valid. For all other shapes, this property will return NoTwoBendReliefPlacement because the placement option is not used.
twoBendReliefShape Gets and sets the relief shape to use when two bends intersect.

When set to square or round relief shape, the value of the twoBendReliefPlacement property will be set to IntersectionTwoBendReliefPlacement. For a round relief shape you can change the twoBendReliefPlacment property to TangentTwoBendReliefPlacement.
twoBendReliefSize The relief size used when two bends meet in the flat pattern and the relief shape is round or square. Use the returned SheetMetalRuleValue object to get and set the current value of the relief size.
units Gets the units this rule uses to display values in the dialog. Rules currently only use mm or inch and the units are permanently associated with a rule and cannot be modified.

Accessed From

Component.activeSheetMetalRule, ConfigurationSheetMetalRuleCell.sheetMetalRule, FlatPatternComponent.activeSheetMetalRule, SheetMetalRules.addByCopy, SheetMetalRules.item, SheetMetalRules.itemByName

Version

Introduced in version November 2022