WorkPlane Class¶
-
class
NXOpen.Preferences.
WorkPlane
¶ Bases:
NXOpen.NXObject
Represents the set of WorkPlanePreferences preferences applicable to part.
Sets parameters for the Graphics Window grid and the Work Plane Emphasis mode. An instance of this class can be obtained using
Preferences.SessionPreferences.WorkPlane
orPreferences.PartPreferences.Workplane
New in version NX3.0.0.
Properties¶
Property | Description |
---|---|
GridColor | Returns or sets the grid color. |
GridIsNonUniform | Returns or sets the grid non uniform flag. |
GridOnTop | Returns or sets the grid on top flag. |
GridType | Returns or sets the grid type. |
IsOccurrence | Returns whether this object is an occurrence or not. |
JournalIdentifier | Returns the identifier that would be recorded in a journal for this object. |
Name | Returns the custom name of the object. |
OwningComponent | Returns the owning component, if this object is an occurrence. |
OwningPart | Returns the owning part of this object |
PolarShowMajorLines | Returns or sets the show major lines flag for polar grid |
Prototype | Returns the prototype of this object if it is an occurrence. |
RectangularShowMajorLines | Returns or sets the show major lines flag for rectangular grid |
ShowGrid | Returns or sets the show and hide grid flag. |
ShowLabels | Returns or sets the show and hide grid labels flag. |
SnapToGrid | Returns or sets the snap to grid flag. |
Tag | Returns the Tag for this object. |
Methods¶
Method | Description |
---|---|
DeleteAllAttributesByType | Deletes all attributes of a specific type. |
DeleteAttributeByTypeAndTitle | Deletes an attribute by type and title. |
DeleteUserAttribute | Deletes the first attribute encountered with the given Type, Title. |
DeleteUserAttributes | Deletes the attributes encountered with the given Type with option to update or not. |
FindObject | Finds the NXOpen.NXObject with the given identifier as recorded in a journal. |
GetAttributeTitlesByType | Gets all the attribute titles of a specific type. |
GetBooleanUserAttribute | Gets a boolean attribute by Title and array Index. |
GetComputationalTimeUserAttribute | Gets a time attribute by Title and array Index. |
GetIntegerAttribute | Gets an integer attribute by title. |
GetIntegerUserAttribute | Gets an integer attribute by Title and array Index. |
GetPolarGridSize | Query the polar grid size parameters. |
GetRealAttribute | Gets a real attribute by title. |
GetRealUserAttribute | Gets a real attribute by Title and array Index. |
GetRectangularNonuniformGridSize | Query the rectangular nonuniform grid size parameters. |
GetRectangularUniformGridSize | Query the rectangular uniform grid size parameters. |
GetReferenceAttribute | Gets the reference string (not the calculated value) of a string attribute that uses a reference string. |
GetStringAttribute | Gets a string attribute value by title. |
GetStringUserAttribute | Gets a string attribute by Title and array Index. |
GetTimeAttribute | Gets a time attribute by title. |
GetTimeUserAttribute | Gets a time attribute by Title and array Index. |
GetUserAttribute | Gets the first attribute encountered on the object, if any, with a given Title, Type and array Index. |
GetUserAttributeAsString | Gets the first attribute encountered on the object, if any, with a given title, type and array index. |
GetUserAttributeCount | Gets the count of set attributes on the object, if any, of the given type. |
GetUserAttributeLock | Determine the lock of the given attribute. |
GetUserAttributeSize | Gets the size of the first attribute encountered on the object, if any, with a given Title and Type. |
GetUserAttributeSourceObjects | Returns an array of objects from which this object presents attributes. |
GetUserAttributes | Gets all the attributes that have been set on the given object. |
GetUserAttributesAsStrings | Gets all the attributes that have been set on the given object. |
HasUserAttribute | Determines if an attribute with the given Title, Type and array Index is present on the object Unset attributes will not be detected by this function, as its purpose is to test for the actual presence of the attribute on the object. |
Prints a representation of this object to the system log file. | |
SetAttribute | Creates or modifies an integer attribute. |
SetBooleanUserAttribute | Creates or modifies a boolean attribute with the option to update or not. |
SetName | Sets the custom name of the object. |
SetPolarGridSize | Set the polar grid size parameters. |
SetRectangularNonuniformGridSize | Set the rectangular nonuniform grid size parameters. |
SetRectangularUniformGridSize | Set the rectangular uniform grid size parameters. |
SetReferenceAttribute | Creates or modifies a string attribute which uses a reference string. |
SetTimeAttribute | Creates or modifies a time attribute. |
SetTimeUserAttribute | Creates or modifies a time attribute with the option to update or not. |
SetUserAttribute | Creates or modifies an attribute with the option to update or not. |
SetUserAttributeLock | Lock or unlock the given attribute. |
Enumerations¶
WorkPlaneGrid Enumeration | Describes whether the Grid type selected is Polar or Rectangular |
Structs¶
WorkPlaneGridSize_Struct Struct | Grid size parameters |
WorkPlaneNonuniformGridSize_Struct Struct | Nonuniform grid size parameters |
WorkPlanePolarGridSize_Struct Struct | Polar grid size parameters |
Property Detail¶
GridColor¶
-
WorkPlane.
GridColor
¶ Returns or sets the grid color.
Specifies the color of grid.
-------------------------------------
Getter Method
Signature
GridColor()
Returns: Return type: int New in version NX3.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
GridColor(gridColor)
Parameters: gridColor (int) – New in version NX3.0.0.
License requirements: None.
GridIsNonUniform¶
-
WorkPlane.
GridIsNonUniform
¶ Returns or sets the grid non uniform flag.
If true grid is non uniform. A uniform grid has the same spacing in X and Y. A non-uniform grid allows for different spacing in X and Y.
-------------------------------------
Getter Method
Signature
GridIsNonUniform()
Returns: Return type: bool New in version NX3.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
GridIsNonUniform(gridIsNonUniform)
Parameters: gridIsNonUniform (bool) – New in version NX3.0.0.
License requirements: None.
GridOnTop¶
-
WorkPlane.
GridOnTop
¶ Returns or sets the grid on top flag.
If true displays the grid on top of other graphics in the scene.
-------------------------------------
Getter Method
Signature
GridOnTop()
Returns: Return type: bool New in version NX6.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
GridOnTop(gridOnTop)
Parameters: gridOnTop (bool) – New in version NX6.0.0.
License requirements: None.
GridType¶
-
WorkPlane.
GridType
¶ Returns or sets the grid type.
It may be polar or rectangular
-------------------------------------
Getter Method
Signature
GridType()
Returns: Return type: NXOpen.Preferences.WorkPlaneGrid
New in version NX3.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
GridType(gridType)
Parameters: gridType ( NXOpen.Preferences.WorkPlaneGrid
) –New in version NX3.0.0.
License requirements: None.
IsOccurrence¶
-
WorkPlane.
IsOccurrence
¶ Returns whether this object is an occurrence or not.
-------------------------------------
Getter Method
Signature
IsOccurrence()
Returns: This object is an occurrence Return type: bool New in version NX3.0.0.
License requirements: None.
JournalIdentifier¶
-
WorkPlane.
JournalIdentifier
¶ Returns the identifier that would be recorded in a journal for this object.
This may not be the same across different releases of the software.
-------------------------------------
Getter Method
Signature
JournalIdentifier()
Returns: Return type: str New in version NX3.0.0.
License requirements: None.
Name¶
-
WorkPlane.
Name
¶ Returns the custom name of the object.
-------------------------------------
Getter Method
Signature
Name()
Returns: Return type: str New in version NX3.0.0.
License requirements: None.
OwningComponent¶
-
WorkPlane.
OwningComponent
¶ Returns the owning component, if this object is an occurrence.
-------------------------------------
Getter Method
Signature
OwningComponent()
Returns: Return type: NXOpen.Assemblies.Component
New in version NX3.0.0.
License requirements: None.
OwningPart¶
-
WorkPlane.
OwningPart
¶ Returns the owning part of this object
-------------------------------------
Getter Method
Signature
OwningPart()
Returns: The owning part of this object or null if it does not have an owner Return type: NXOpen.BasePart
New in version NX3.0.0.
License requirements: None.
PolarShowMajorLines¶
-
WorkPlane.
PolarShowMajorLines
¶ Returns or sets the show major lines flag for polar grid
-------------------------------------
Getter Method
Signature
PolarShowMajorLines()
Returns: Return type: bool New in version NX6.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
PolarShowMajorLines(polarShowMajorLines)
Parameters: polarShowMajorLines (bool) – New in version NX6.0.0.
License requirements: None.
Prototype¶
-
WorkPlane.
Prototype
¶ Returns the prototype of this object if it is an occurrence.
-------------------------------------
Getter Method
Signature
Prototype()
Returns: The prototype of this object or null if this object is not an occurrence Return type: NXOpen.INXObject
New in version NX3.0.0.
License requirements: None.
RectangularShowMajorLines¶
-
WorkPlane.
RectangularShowMajorLines
¶ Returns or sets the show major lines flag for rectangular grid
-------------------------------------
Getter Method
Signature
RectangularShowMajorLines()
Returns: Return type: bool New in version NX6.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
RectangularShowMajorLines(rectangularShowMajorLines)
Parameters: rectangularShowMajorLines (bool) – New in version NX6.0.0.
License requirements: None.
ShowGrid¶
-
WorkPlane.
ShowGrid
¶ Returns or sets the show and hide grid flag.
If true displays the grid pattern in the graphics window else hides
-------------------------------------
Getter Method
Signature
ShowGrid()
Returns: Return type: bool New in version NX3.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
ShowGrid(showGrid)
Parameters: showGrid (bool) – New in version NX3.0.0.
License requirements: None.
ShowLabels¶
-
WorkPlane.
ShowLabels
¶ Returns or sets the show and hide grid labels flag.
If true displays the grid labels in the graphics window else hides
-------------------------------------
Getter Method
Signature
ShowLabels()
Returns: Return type: bool New in version NX5.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
ShowLabels(showLabels)
Parameters: showLabels (bool) – New in version NX5.0.0.
License requirements: None.
SnapToGrid¶
-
WorkPlane.
SnapToGrid
¶ Returns or sets the snap to grid flag.
If true enables snapping (moves an indicated screen position point to the nearest grid point). Points snap to the grid even when Show Grid is off.
-------------------------------------
Getter Method
Signature
SnapToGrid()
Returns: Return type: bool New in version NX3.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
SnapToGrid(snapToGrid)
Parameters: snapToGrid (bool) – New in version NX3.0.0.
License requirements: None.
Method Detail¶
FindObject¶
-
WorkPlane.
FindObject
¶ Finds the
NXOpen.NXObject
with the given identifier as recorded in a journal.An object may not return the same value as its JournalIdentifier in different versions of the software. However newer versions of the software should find the same object when FindObject is passed older versions of its journal identifier. In general, this method should not be used in handwritten code and exists to support record and playback of journals.
An exception will be thrown if no object can be found with the given journal identifier.
Signature
FindObject(journalIdentifier)
Parameters: journalIdentifier (str) – Journal identifier of the object Returns: Return type: NXOpen.INXObject
New in version NX3.0.0.
License requirements: None.
GetPolarGridSize¶
-
WorkPlane.
GetPolarGridSize
¶ Query the polar grid size parameters.
Signature
GetPolarGridSize()
Returns: Return type: NXOpen.Preferences.WorkPlanePolarGridSize_Struct
New in version NX6.0.0.
License requirements: None.
GetRectangularNonuniformGridSize¶
-
WorkPlane.
GetRectangularNonuniformGridSize
¶ Query the rectangular nonuniform grid size parameters.
Signature
GetRectangularNonuniformGridSize()
Returns: Return type: NXOpen.Preferences.WorkPlaneNonuniformGridSize_Struct
New in version NX6.0.0.
License requirements: None.
GetRectangularUniformGridSize¶
-
WorkPlane.
GetRectangularUniformGridSize
¶ Query the rectangular uniform grid size parameters.
Signature
GetRectangularUniformGridSize()
Returns: Return type: NXOpen.Preferences.WorkPlaneGridSize_Struct
New in version NX6.0.0.
License requirements: None.
Print¶
-
WorkPlane.
Print
¶ Prints a representation of this object to the system log file.
Signature
Print()
New in version NX3.0.0.
License requirements: None.
SetName¶
-
WorkPlane.
SetName
¶ Sets the custom name of the object.
NOTE: This method should not be used to edit a read-only object such as a Mirrored PMI object. If it is, the changes will be overridden when the part is updated.
Signature
SetName(name)
Parameters: name (str) – New in version NX3.0.0.
License requirements: None.
SetPolarGridSize¶
-
WorkPlane.
SetPolarGridSize
¶ Set the polar grid size parameters.
Signature
SetPolarGridSize(polarGridSize)
Parameters: polarGridSize ( NXOpen.Preferences.WorkPlanePolarGridSize_Struct
) –New in version NX6.0.0.
License requirements: None.
SetRectangularNonuniformGridSize¶
-
WorkPlane.
SetRectangularNonuniformGridSize
¶ Set the rectangular nonuniform grid size parameters.
Signature
SetRectangularNonuniformGridSize(nonuniformGridSize)
Parameters: nonuniformGridSize ( NXOpen.Preferences.WorkPlaneNonuniformGridSize_Struct
) –New in version NX6.0.0.
License requirements: None.
SetRectangularUniformGridSize¶
-
WorkPlane.
SetRectangularUniformGridSize
¶ Set the rectangular uniform grid size parameters.
Signature
SetRectangularUniformGridSize(gridSize)
Parameters: gridSize ( NXOpen.Preferences.WorkPlaneGridSize_Struct
) –New in version NX6.0.0.
License requirements: None.