WorkPlane Object
Description
Represents a work plane. See here for an overview.Methods
| Name | Description |
| Delete | Method that deletes the work plane. Optionally the dependent objects will be deleted. This method will fail in the case where this object was created as a result of a derived part. The HasReferenceComponent property can be used to determine when this is the case. |
| FlipNormal | Method that reverses the normal of the work plane. The current normal direction can be determined by using the Plane object returned by Plane property of the work plane. |
| GetPosition | Method that returns the position and orientation of a work plane. When sketches are created on a work plane they inherit the work plane's origin and orientation. This method is useful to predetermine what the orientation will be before the sketch is created. |
| GetReferenceKey | Method that generates and returns the reference key for this entity. |
| GetSize | Method that gets the current size of the displayed graphics for the work plane. The returned points are in the coordinate space of the workplane. |
| SetByLineAndTangent | Method that redefines the work plane to be through the input line and tangent to the input surface. |
| SetByLinePlaneAndAngle | Method that redefines the work plane to be through the input line at the specified angle from the input plane. |
| SetByNormalToCurve | Method that redefines the work plane to pass through the input point and normal to the input curve. |
| SetByPlaneAndOffset | Method that redefines the work plane to be parallel to the input plane at a specified distance in the specified direction. |
| SetByPlaneAndPoint | Method that redefines the work plane to be parallel to the input plane and passing through the input point. |
| SetByPlaneAndTangent | Method that redefines the work plane to be parallel to the input plane and tangent to the input surface. |
| SetByPointAndTangent | Method that redefines the work plane to pass through the input point and tangent to the input surface. |
| SetByThreePoints | Method that redefines the work plane to be based on the three input points. |
| SetByTorusMidPlane | Method that redefines the work plane to be at the mid-plane of the torus specified by the input face. |
| SetByTwoLines | Method that redefines the work plane to be based on the two input lines. |
| SetByTwoPlanes | Method that redefines a bisection work plane to be based on the two planes. |
| SetEndOfPart | Method that repositions the end-of-part marker relative to the object this method is called from. The argument defines if the end-of-part marker will be positioned just before or just after the object. If the object is contained within another object and is not in the top level of the browser, the positioning of the marker will be relative to the top-level object the calling object is contained within. An example of this case is a sketch that has not been shared and has been consumed by a feature. Another example is a nested work feature. |
| SetFixed | Method that redefines the work plane at the position and orientation defined by the point and X and Y axis vectors. |
| SetSize | Method that sets the current size of the displayed graphics for the work plane. |
Properties
| Name | Description |
| Adaptive | Specifies whether the work plane is adaptive. |
| 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. |
| AttributeSets | Property that returns the AttributeSets collection object associated with this object. |
| AutoResize | Gets and sets whether this work plane should be resized automatically based on the component size. |
| Construction | Boolean property that returns whether the work plane is a construction work plane or not. A construction work plane is hidden from the user and is not displayed graphically or listed in the browser. Some properties and methods of the WorkPlane object will behave differently for a construction work plane. These are Adaptive, Name, Visible, GetSize, and SetSize. |
| Consumed | Gets whether the WorkPlane is consumed or not. |
| ConsumeInputs | Gets and sets whether the inputs to this feature should be nested under this feature in the browser. |
| Definition | Property that returns one of the work plane definition objects. Which definition object returned will depend on how the work plane is defined. The DefinitionType property can be used to determine the type of definition the Definition property will return. |
| DefinitionType | Property that returns the type of definition that is used to define the work plane. This can be kThreePointsWorkPlane, kTwoLinesWorkPlane, kLineAndPointWorkPlane, kPlaneAndPointWorkPlane, kLinePlaneAndAngleWorkPlane, kPlaneAndOffsetWorkPlane, kLineAndTangentWorkPlane, kPlaneAndTangentWorkPlane, kSketchWorkPlane, kFixedWorkPlane, kNormalToCurveWorkPlane, kTwoPlanesWorkPlane, kTorusMidPlaneWorkPlane, or AssemblyWorkPlane. |
| Dependents | Property that returns the collection of objects that have a direct dependency on the work plane. |
| DrivenBy | Property that returns the collection of objects that the work plane is dependent on. |
| Exported | Read-write property that gets and sets whether the object is exported. Objects must be marked for export in order for them to be derived. |
| Grounded | Gets/Sets the Boolean flag that specifies whether this work plane is grounded or not. |
| HasReferenceComponent | Property that specifies if the object was created as the result of a derived part. |
| HealthStatus | Property that returns an enum indicating the current state of the object. |
| IsCoordinateSystemElement | Property that returns whether the work plane belongs to a coordinate system. If so, edits and delete are not allowed. |
| IsOwnedByFeature | Property that returns whether this object is owned by a feature. If True, the OwnedBy property returns the owning feature. |
| IsParentSketch | Property that indicates whether the work plane belongs to a 3d sketch. |
| IsPatternElement | Property that gets whether the work plane was created by a pattern. If so, edits and delete are not allowed. |
| Name | Specifies the name of the work plane. |
| OwnedBy | Read-only property that returns the client feature that owns this object. This property returns Nothing if the IsOwnedByFeature property returns False. |
| Parent | Property returning the parent object. |
| ParentSketch | Gets the parent 3d sketch if this work plane belongs to a 3d sketch, Gets Nothing otherwise. |
| Plane | Property that returns a Plane's geometry. The Plane object returned provides information about the position and normal of the work plane. |
| ReferenceComponent | Property that returns the ReferenceComponent that resulted in the creation of this feature. |
| ReferencedEntity | Property that returns the referenced WorkPlane in the case where this work plane was created using a referenced component. An example of this is when a work plane is selected as part of a derived part. The HasReferenceComponent property indicates if this work plane is based on a referenced component or not. This property returns Nothing in the case where it is not based on a referenced component. |
| Shared | Gets and sets whether the work plane is shared or not. |
| Type | Returns an ObjectTypeEnum indicating this object's type. |
| Visible | Specifies the visibility of the work plane. |
Accessed From
AssemblyWorkPlaneDef.Parent, FixedWorkPlaneDef.Parent, LineAndPointWorkPlaneDef.Parent, LineAndTangentWorkPlaneDef.Parent, LinePlaneAndAngleWorkPlaneDef.Parent, NormalToCurveWorkPlaneDef.Parent, PlaneAndOffsetWorkPlaneDef.Parent, PlaneAndPointWorkPlaneDef.Parent, PlaneAndTangentWorkPlaneDef.Parent, PointAndTangentWorkPlaneDef.Parent, ThreePointsWorkPlaneDef.Parent, TorusMidPlaneWorkPlaneDef.Parent, TwoLinesWorkPlaneDef.Parent, TwoPlanesWorkPlaneDef.Parent, UserCoordinateSystem.XYPlane, UserCoordinateSystem.XZPlane, UserCoordinateSystem.YZPlane, UserCoordinateSystemProxy.XYPlane, UserCoordinateSystemProxy.XZPlane, UserCoordinateSystemProxy.YZPlane, WorkPlane.ReferencedEntity, WorkPlaneProxy.NativeObject, WorkPlaneProxy.ReferencedEntity, WorkPlanes.AddByLineAndTangent, WorkPlanes.AddByLinePlaneAndAngle, WorkPlanes.AddByNormalToCurve, WorkPlanes.AddByPlaneAndOffset, WorkPlanes.AddByPlaneAndPoint, WorkPlanes.AddByPlaneAndTangent, WorkPlanes.AddByPointAndTangent, WorkPlanes.AddByThreePoints, WorkPlanes.AddByTorusMidPlane, WorkPlanes.AddByTwoLines, WorkPlanes.AddByTwoPlanes, WorkPlanes.AddFixed, WorkPlanes.ItemDerived Classes
WorkPlaneProxySamples
| Name | Description |
| Add mate constraint using work planes in parts | This sample demonstrates creating a mate constraint between two occurrences using the work planes within those occurrences. |
| Navigation between browser and data | This sample demonstrates the navigation between a browser node and it's corresponding data model object and vice versa. This sample creates a work plane, finds its browser node and gets the work plane object back from the browser node. |
| SurfaceBody Copy | This sample demonstrates copying a surface body from one part to another. This is equivalent to the Promote command, but the API is much more flexible. In order for the sample to be self-contained, it creates two parts on the fly that will be used to demonstrate copying a body from one part to another. When copying a body into a part, you provide the surface body and a matrix to define its position in the new part. This sample creates a matrix based on the position of these parts within an assembly. |
| Create sheet metal lofted flange feature | The following sample demonstrates the creation of a sheet metal lofted flange feature. |
| Spline - create NURBS | This sample demonstrates the creation of a sketch spline using a geometry definition (a NURB). The API also supports creation of 3D sketch splines in a similar way. |
| Sweep Feature Add | This sample demonstrates the creation of a sweep feature. The profile is a circle, but the path is made up of a 3D sketch and a 2D sketch. |