EdgeFlangeFeatureDefinition.setToObjectExtent Method

EdgeFlangeFeatureDefinition

This functionality is provided as a preview of intended future API capabilities. You are encouraged to use it and report any problems or suggestions using the Fusion API and Scripts forum.

Because this is a preview of future functionality, there is the possibility that it will change, which will possibly break any existing programs that use this functionality. Because of that, you should never deliver any programs that use any preview capabilities. For a distributed program, you should wait until it has moved from preview to released state.

Description

If the current extent type is a distance extent, this method changes it to a to entity extent.

Syntax

Python
C++
TypeScript 🧪

"edgeFlangeFeatureDefinition_var" is a variable referencing an EdgeFlangeFeatureDefinition object.

returnValue = edgeFlangeFeatureDefinition_var.setToObjectExtent(toEntity, offset)

"edgeFlangeFeatureDefinition_var" is a variable referencing an EdgeFlangeFeatureDefinition object.

#include <Fusion/SheetMetal/EdgeFlangeFeatureDefinition.h>

returnValue = edgeFlangeFeatureDefinition_var->setToObjectExtent(toEntity, offset);

"edgeFlangeFeatureDefinition_var" is a variable referencing an EdgeFlangeFeatureDefinition object.

returnValue = edgeFlangeFeatureDefinition_var.setToObjectExtent(toEntity, offset);

Parameters

toEntity

Base

A planar BRepFace, ConstructionPlane that is parallel to the edge being extended or a BRepVertex or ConstructionPoint that defines the entity to extend to. The flange will extend to this entity with an offset defined by the offset parameter.

offset

ValueInput

Defines an offset value from the toEntity. A positive value will make the flange longer. A value of 0 means the flange will extend exactly to the toEntity. This value is used to create the parameter that defines the offset. If it is a real value it will be interpreted as centimeters. If it is a string it behaves the same as entering the value in the command dialog. A string like "1.5" will be 1.5 of whatever the current design units are. You can also specify the units as part of the string so "1.5 in" is valid. You can also define equations like "length / 2" where length is the name of an existing parameter.

EdgeFlangeFeatureDefinition.setToObjectExtent Method

Description

Syntax

Return Value

Parameters

Version

Type	Description
boolean	Returns true if setting the extent type was successful.

Name	Type	Description
toEntity	Base	A planar BRepFace, ConstructionPlane that is parallel to the edge being extended or a BRepVertex or ConstructionPoint that defines the entity to extend to. The flange will extend to this entity with an offset defined by the offset parameter.
offset	ValueInput	Defines an offset value from the toEntity. A positive value will make the flange longer. A value of 0 means the flange will extend exactly to the toEntity. This value is used to create the parameter that defines the offset. If it is a real value it will be interpreted as centimeters. If it is a string it behaves the same as entering the value in the command dialog. A string like "1.5" will be 1.5 of whatever the current design units are. You can also specify the units as part of the string so "1.5 in" is valid. You can also define equations like "length / 2" where length is the name of an existing parameter.