UnfoldMethod Object
Derived from:
Style Object
Description
The UnfoldMethod object provides access to the information associated with a specific unfold method. This object derives from the Style object.
Methods
| ConvertToLocal |
Method that creates a local cached copy of a global style and returns the local style. |
| Copy |
Method that creates a new local Style object. The newly created style is returned. |
| Delete |
Method that deletes the Style/Layer/UnfoldMethod. |
| DeleteEquation |
Method that deletes the specified equation. An equation unfold method always needs to have at least one equation. Deleting the last equation will cause a default equation to be created. |
| GetEquation |
Method that sets this unfold method to be an equation type of unfold method and defines the associated equation and limits. |
| GetReferenceKey |
Method that generates and returns the reference key for this entity. |
| SaveToGlobal |
Method that saves this style to the global repository. If a style with the same name is found in the repository, that style is updated. |
| SetEquation |
Method that creates or edits an equation associated with this unfold method. Creating the first equation will change the unfold method be to a custom equation type of unfold method. |
| UpdateFromGlobal |
Method that updates this style from the global repository. |
| WriteBendTableToFile |
Method that writes the bend table information of the UnfoldMethod object into an external file. This method is only valid in the case where UnfoldMethodType is kBendTableUnfoldMethod. |
Properties
| Application |
Returns the top-level parent application object. When used the context of Inventor, an Application object is returned. When used in the context of Apprentice, an ApprenticeServer object is returned. |
| BendAngleType |
Gets and sets whether the bend or open angle value is to be used for the angle in equations. |
| Comments |
Gets and sets comments associated with the style. |
| EquationCount |
Property that reports the number of equations currently associated with this unfold method. This property is only used in the case where the UnfoldMethodType property returns kCustomEquationUnfoldMethod and will return 0 for other unfold method types. |
| EquationType |
Property that specifies the type of equation defined for the unfold method. This property is only valid in the case where the UnfoldMethodType property returns kCustomEquationUnfoldMethod. In all other cases the value of this property should be ignored. |
| InternalName |
Property that returns the internal name of the style. The name is the internal English name of the standard style. This name will remain constant and is not affected by locale. This name is never displayed to the user. Note that this name is not guaranteed to be unique. |
| InUse |
Property that indicates if this style is in use. |
| kFactor |
Gets/sets the kFactor associated with this unfold method. |
| Name |
Gets/Sets the name of the Style. |
| Parent |
Property returning the parent of this object. |
| SplineFactor |
Gets and sets the factor used when unfolding ruled surfaces defined using ellipses and splines. |
| StyleLocation |
Property that returns the location of this style, i.e. local to the document, cached locally in the document, exists in the library. Styles that exist in the library cannot be edited. |
| StyleType |
Gets the type of the style. |
| Type |
Returns an ObjectTypeEnum indicating this object's type. |
| UnfoldMethodType |
Property that returns the type of unfold method used by this UnfoldMethod object. kLinearUnfoldMethod, kBendTableUnfoldMethod, and kCustomEquationUnfoldMethod are possible return values. |
| UpToDate |
Property that gets the up-to-date status of the style against the global repository. |
Accessed From
BendDefinition.UnfoldMethod,
ContourFlangeDefinition.UnfoldMethod,
FlangeDefinition.UnfoldMethod,
FoldDefinition.UnfoldMethod,
HemDefinition.UnfoldMethod,
LoftedFlangeDefinition.UnfoldMethod,
SheetMetalComponentDefinition.UnfoldMethod,
SheetMetalStyle.UnfoldMethod,
UnfoldMethods.AddBendTableFromFile,
UnfoldMethods.AddEquationUnfoldMethod,
UnfoldMethods.AddLinearUnfoldMethod,
UnfoldMethods.Item
Samples
| Sheet Metal Style Display |
This sample illustrates getting information about sheet metal styles. |
| Sheet Metal Style Creation |
This sample illustrates creating a new sheet metal style. It uses a bend table and assumes the sample bend table delivered with Inventor is available. You can edit the path below to reference any existing bend table. To use the sample make sure a bend table is available at the specified path, open a sheet metal document, and run the sample. |
Version
Introduced in version 5.3
