Share

WorkAxis Object


Description

Represents a work axis. See here for an overview.

Methods

Name Description
Delete Method that deletes the work axis. 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.
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 axis. The returned points are in model coordinate space.
SetByAnalyticEdge Method that redefines the work axis to be based on the input edge.
SetByLine Method that redefines the work axis to be based on the input line. This method is not valid when the work axis exists in an Assembly component definition.
SetByLineAndPlane Method that redefines the work axis so that it is along a line defined by projecting the input line onto the input plane along the plane normal.
SetByLineAndPoint Method that redefines the work axis so that it is parallel to a line and passes through the input point.
SetByNormalToSurface Method that redefines the work axis to pass through the input point and be normal to the input surface.
SetByRevolvedFace Method that redefines the work axis to be at the axis of the input revolved face.
SetByTwoPlanes Method that redefines the work axis to be at the intersection of the two input planes.
SetByTwoPoints Method that redefines the work axis to go between the two input points.
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 axis so it passes through the input point in the direction of the input vector.
SetSize Method that sets the current size of the displayed graphics for the work axis.

Properties

Name Description
Adaptive Specifies whether the work axis 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 or sets whether this work axis should be resized automatically based on the component size.
Construction Boolean property that returns whether the work axis is a construction work axis or not. A construction work axis is hidden from the user and is not displayed graphically or listed in the browser. Some properties and methods of the WorkAxis object will behave differently for a construction work axis. These are Adaptive, Name, and Visible.
Consumed Gets whether the WorkAxis 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 axis definition objects. Which definition object returned will depend on how the work axis 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 axis. This can be kLineWorkAxis, kTwoPlanesWorkAxis, kTwoPointsWorkAxis, kRevolvedFaceWorkAxis, kNormalToSurfaceWorkAxis, kLineAndPlaneWorkAxis, kLineAndPointWorkAxis, kAnalyticEdgeWorkAxis, kFixedWorkAxis, or kAssemblyWorkAxis.
Dependents Property that returns the collection of objects that have a direct dependency on the work axis.
DrivenBy Property that returns the collection of objects that the work axis 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 axis 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 axis 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 axis belongs to a 3d sketch.
IsPatternElement Property that gets whether the work axis was created by a pattern. If so, edits and delete are not allowed.
Line Property that returns a Line geometry. The Line object returned provides information about the position and direction of the work axis.
Name Specifies the name of the work axis.
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 Property that returns the parent ComponentDefinition object.
ReferenceComponent Property that returns the ReferenceComponent that resulted in the creation of this feature.
ReferencedEntity Property indicating the object this entity is dependent on.
Shared Gets and sets whether the work axis is shared or not.
Type Returns an ObjectTypeEnum indicating this object's type.
Visible Specifies the visibility of the work axis.

Accessed From

AnalyticEdgeWorkAxisDef.Parent, AssemblyWorkAxisDef.Parent, FixedWorkAxisDef.Parent, LineAndPlaneWorkAxisDef.Parent, LineAndPointWorkAxisDef.Parent, LineWorkAxisDef.Parent, NormalToSurfaceWorkAxisDef.Parent, PointAndPlaneWorkAxisDef.Parent, RevolvedFaceWorkAxisDef.Parent, TwoPlanesWorkAxisDef.Parent, TwoPointsWorkAxisDef.Parent, UserCoordinateSystem.XAxis, UserCoordinateSystem.YAxis, UserCoordinateSystem.ZAxis, UserCoordinateSystemProxy.XAxis, UserCoordinateSystemProxy.YAxis, UserCoordinateSystemProxy.ZAxis, WorkAxes.AddByAnalyticEdge, WorkAxes.AddByLine, WorkAxes.AddByLineAndPlane, WorkAxes.AddByLineAndPoint, WorkAxes.AddByNormalToSurface, WorkAxes.AddByRevolvedFace, WorkAxes.AddByTwoPlanes, WorkAxes.AddByTwoPoints, WorkAxes.AddFixed, WorkAxes.Item, WorkAxis.ReferencedEntity, WorkAxisProxy.NativeObject, WorkAxisProxy.ReferencedEntity

Derived Classes

WorkAxisProxy

Version

Introduced in version 4

Was this information helpful?