Share

FlatPattern Object

Derived from: ComponentDefinition Object

Description

The FlatPattern object represents the unfolded model in a sheet metal document.

Methods

Name Description
CreateGeometryIntent Method that creates a GeometryIntent object. GeometryIntent objects are used as input when creating annotations in the model. They are used to identify geometry and optionally specific locations on that geometry.
Delete Method that deletes the FlatPattern.
DeleteObjects Method that deletes a collection of objects that belong to the flat pattern.
Edit Method that puts the FlatPattern in edit mode.
ExitEdit Method that causes the FlatPattern editing environment to be closed and the user interface to return to sheet metal editing environment.
FindUsingPoint Method that finds all the entities of the specified type at the specified location.
FindUsingRay Method that fires a ray through the flat pattern and returns the entities intersected by the ray. The objects intersected by the ray are returned in the order in which they are intersected, with the first entities returned being those closest to the clipping plane.
FindUsingVector Method that finds all the entities of the specified type along the specified vector using either a cylinder or cone that to define the tolerance within the defined vector.
GetEdgesOfType Method that returns edges of the specified type from the flat pattern body.
GetEndOfPartPosition Method that returns the current end of part position in the browser in parts and assemblies.
GetFlatPatternEntity Method that returns the corresponding BRep entity (face, edge, etc.) in the flat pattern body given a BRep entity in the sheet metal body.
GetSheetMetalEntity Returns the corresponding BRep entity (face, edge, etc.) in the sheet metal body given a BRep entity in the flat pattern body. If an entity is not found, the method returns Nothing. If multiple matches are found, an ObjectsEnumerator is returned.
GetUnusedGeometries Method that gets the unused sketches and work features.
PurgeUnusedGeometries Method that purges unused sketches and work features.
RepositionObject Method that repositions the specifies object(s) to the new position within the collection of the object in the document.
SetEndOfPartToTopOrBottom Inventor::PartComponentDefinition::SetEndOfPartToTopOrBottom
SuppressFeatures Method that suppresses the specified features. This is limited to the features created in the flat pattern.
UnsuppressFeatures Method that unsuppresses the specified features. This is limited to the features created in the flat pattern.

Properties

Name Description
AnnotationPlanes Read-only property that returns the AnnotationPlanes collection object. This object provides access to all of the annotation planes in the part.
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.
ASideFace Read-only property that returns the ASideFaceDefinition from the folded model that was used to create the flat pattern.
AttributeSets Property that returns the AttributeSets collection object associated with this object.
BaseFace Property that returns the base face from the folded model that was used to create the flat pattern.
BendAngleReportType Gets and sets which angle is reported in the flat pattern.
Body Property that returns the corresponding SurfaceBody.
BOMQuantity Property that returns the BOMQuantity object.
BOMStructure Gets and sets how the component is used/viewed in a BOM.
BottomFace Property that returns the bottom face of the flat pattern.
ClientGraphicsCollection Property that returns the ClientGraphicsCollection object.
DataIO Gets the object that directly deals with I/O to and from a storage-medium, including Streams(IStream).
Document Property that returns the containing Document object.
Features Property that returns the collection object that provides access to the features associated with the flat pattern.
FlatBendResults Property that returns the FlatBendResults collection object that contains information about all the bends in the flat pattern.
FlatPatternOrientations Gets the FlatPatternOrientations collection object.
FlatPunchResults Property that returns the FlatPunchResults collection object that contains information about all the punches in the flat pattern.
GraphicsDataSetsCollection Inventor::ComponentDefinition::GraphicsDataSetsCollection
IgnorePunchToolFeaturesRepresentationOverrides Gets and sets whether to ignore the punch tool features representation overrides in flat pattern.
Length Property that returns the length of the flat pattern.
MassProperties Property that returns the MassProperties object for the flat pattern.
ModelAnnotations Read-only property that returns the ModelAnnotations collection object. This object provides access to all of the model annotations in the part.
ModelGeometryVersion Property that returns a string that can be used to determine if the document has been modified. This version string is changed every time the assembly is modified. By saving a previous version string, you can compare the current version string to see if the assembly has been modified.
ModelToleranceFeatures Returns the ModelToleranceFeatures collection object. This object provides access to all of the model annotations in the part.
Occurrences Property that returns the collection object.
OrientedMinimumRangeBox Read-only property that returns the oriented minimum range box for this object.
Parameters Property that returns the set of parameters for the flat pattern.
Parent Property that returns the parent SheetMetalComponentDefinition object.
PartEvents Property that returns the PartEvents object associated with the flat pattern. This object will fire events for changes that occur to the flat pattern.
PreciseRangeBox Gets a bounding box that tightly encloses all the solid and surface bodies under the ComponentDefinition.
PunchRepresentationType Gets and sets the punch representation to use for the flat pattern.
RangeBox Property that returns a Box object which contains the opposing points of a rectangular box that is guaranteed to enclose this object.
RepresentationsManager Read-only property that returns the RepresentationsManager object.
RolledBackForEdit Property that gets whether the flat pattern model is currently rolled back to a previous point in the feature history.
SketchBlockDefinitions Inventor::PartComponentDefinition::SketchBlockDefinitions
Sketches Inventor::PartComponentDefinition::Sketches
Sketches3D Inventor::PartComponentDefinition::Sketchs3D
SurfaceBodies Property that returns all of the result SurfaceBody objects contained within this ComponentDefinition.
TopFace Property that returns top face of the flat pattern.
Type Returns an ObjectTypeEnum indicating this object's type.
UserCoordinateSystems Property that returns the UserCoordinateSystems collection object.
Width Property that returns the width of the flat pattern.
WorkAxes Property that returns that collection object that provides access to all of the existing work axis objects in the flat pattern and provides the functionality to create new work axis objects.
WorkPlanes Property that returns that collection object that provides access to all of the existing work plane objects in the flat pattern and provides the functionality to create new work plane objects.
WorkPoints Property that returns that collection object that provides access to all of the existing work point objects in the flat pattern and provides the functionality to create new work point objects.

Accessed From

FlatBendResult.Parent, FlatPatternOrientation.Parent, FlatPatternPlate.Parent, FlatPunchResult.Parent, SheetMetalComponentDefinition.FlatPattern

Samples

Name Description
Publish FlatPattern to STEP This sample demonstrates how to save a FlatPattern file using the STEP translator add-in.
Finding Bend Extent (Tangent) Edges This sample demonstrates how to retrieve the bend extent edges (a.k.a. tangent edges) associated with the selected bend edge on a flat pattern.
Publish FlatPattern to DXF This sample demonstrates how to save a FlatPattern file using the DXF translator add-in.

Version

Introduced in version 6

Was this information helpful?