Stage Class¶
-
class
NXOpen.Display.Stage¶ Bases:
NXOpen.BuilderRepresents a
NXOpen.Display.StageA stage is an environment cube, a six-sided room, that can have between one and six visible walls.You optionally specify a stage in Studio rendering styles and High Quality Images.
This class is restricted to being called from a program running during an Interactive NX session. If run from a non-interactive session it will return None.
To create a new instance of this class, use
NXOpen.ViewCollection.CreateStage()New in version NX5.0.0.
Properties¶
| Property | Description |
|---|---|
| FloorOrientationType | Returns or sets the floor orientation define |
| Offset | Returns or sets the offset distance to translate the stage in the z-direction, in part units |
| OffsetExpression | Returns the stage offset expression |
| Size | Returns or sets the size all of the stage walls (length and width), in part units |
| SizeExpression | Returns the stage size expression |
| SpecifyFloorPlane | Returns or sets the specify floor plane |
| Tag | Returns the Tag for this object. |
Methods¶
| Method | Description |
|---|---|
| AlignFloorPlane | The stage’s bottom wall (floor) aligns with the given plane. |
| Commit | Commits any edits that have been applied to the builder. |
| CommitOffset | Updates the data and display for a change to the stage’s offset |
| CommitWall | Updates the data and display for a given wall |
| Destroy | Deletes the builder, and cleans up any objects created by the builder. |
| FloorXaxis | The stage’s bottom wall to align with the WCS x-axis |
| FloorYaxis | The stage’s bottom wall to align with the WCS y-axis |
| FloorZaxis | The stage’s bottom wall to align with the WCS z-axis |
| GetCommittedObjects | For builders that create more than one object, this method returns the objects that are created by commit. |
| GetObject | Returns the object currently being edited by this builder. |
| GetWallFromList | Returns a wall builder, given by the index, in the array of walls for the given stage |
| SetWallInList | Sets a wall builder in the array at the given index |
| ShowResults | Updates the model to reflect the result of an edit to the model for all builders that support showing results. |
| Validate | Validate whether the inputs to the component are sufficient for commit to be called. |
Enumerations¶
| StageOrientationType Enumeration | Represents an index to a floor plane type define |
| StageWallType Enumeration | Represents an index to a particular wall in the stage. |
Property Detail¶
FloorOrientationType¶
-
Stage.FloorOrientationType¶ Returns or sets the floor orientation define
-------------------------------------Getter Method
Signature
FloorOrientationTypeReturns: Return type: NXOpen.Display.StageOrientationTypeNew in version NX10.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
FloorOrientationTypeParameters: floorOrientationType ( NXOpen.Display.StageOrientationType) –New in version NX10.0.0.
License requirements: None.
Offset¶
-
Stage.Offset¶ Returns or sets the offset distance to translate the stage in the z-direction, in part units
-------------------------------------Getter Method
Signature
OffsetReturns: Return type: float New in version NX5.0.0.
Deprecated since version NX10.0.0: Use :py:meth:`NXOpen.Display.Stage.OffsetExpression`instead.
License requirements: None.
-------------------------------------Setter Method
Signature
OffsetParameters: offset (float) – New in version NX5.0.0.
Deprecated since version NX10.0.0: This functionality is no longer supported.
License requirements: None.
OffsetExpression¶
-
Stage.OffsetExpression¶ Returns the stage offset expression
-------------------------------------Getter Method
Signature
OffsetExpressionReturns: Return type: NXOpen.ExpressionNew in version NX10.0.0.
License requirements: None.
Size¶
-
Stage.Size¶ Returns or sets the size all of the stage walls (length and width), in part units
-------------------------------------Getter Method
Signature
SizeReturns: Return type: float New in version NX5.0.0.
Deprecated since version NX10.0.0: Use
NXOpen.Display.Stage.SizeExpression()instead.License requirements: None.
-------------------------------------Setter Method
Signature
SizeParameters: size (float) – New in version NX5.0.0.
Deprecated since version NX10.0.0: This functionality is no longer supported.
License requirements: None.
SizeExpression¶
-
Stage.SizeExpression¶ Returns the stage size expression
-------------------------------------Getter Method
Signature
SizeExpressionReturns: Return type: NXOpen.ExpressionNew in version NX10.0.0.
License requirements: None.
SpecifyFloorPlane¶
-
Stage.SpecifyFloorPlane¶ Returns or sets the specify floor plane
-------------------------------------Getter Method
Signature
SpecifyFloorPlaneReturns: Return type: NXOpen.PlaneNew in version NX5.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
SpecifyFloorPlaneParameters: specifyFloorPlane ( NXOpen.Plane) –New in version NX5.0.0.
License requirements: None.
Method Detail¶
AlignFloorPlane¶
-
Stage.AlignFloorPlane¶ The stage’s bottom wall (floor) aligns with the given plane.
Signature
AlignFloorPlane(specifyFloorPlane)Parameters: specifyFloorPlane ( NXOpen.Plane) –New in version NX5.0.0.
License requirements: None.
CommitOffset¶
-
Stage.CommitOffset¶ Updates the data and display for a change to the stage’s offset
Signature
CommitOffset(view)Parameters: view ( NXOpen.View) – view of the stageNew in version NX5.0.0.
License requirements: None.
CommitWall¶
-
Stage.CommitWall¶ Updates the data and display for a given wall
Signature
CommitWall(view, currentWallIndex, updateStageDatabase)Parameters: - view (
NXOpen.View) – view of the stage and walls - currentWallIndex (int) – the index of the wall in the stage builder array
- updateStageDatabase (bool) – if true, commit the stage builder
New in version NX5.0.0.
License requirements: None.
- view (
FloorXaxis¶
-
Stage.FloorXaxis¶ The stage’s bottom wall to align with the WCS x-axis
Signature
FloorXaxis()New in version NX5.0.0.
License requirements: None.
FloorYaxis¶
-
Stage.FloorYaxis¶ The stage’s bottom wall to align with the WCS y-axis
Signature
FloorYaxis()New in version NX5.0.0.
License requirements: None.
FloorZaxis¶
-
Stage.FloorZaxis¶ The stage’s bottom wall to align with the WCS z-axis
Signature
FloorZaxis()New in version NX5.0.0.
License requirements: None.
GetWallFromList¶
-
Stage.GetWallFromList¶ Returns a wall builder, given by the index, in the array of walls for the given stage
Signature
GetWallFromList(index)Parameters: index ( NXOpen.Display.StageWallType) – index to the array of wallsReturns: the wall Return type: NXOpen.Display.WallNew in version NX5.0.0.
License requirements: None.
SetWallInList¶
-
Stage.SetWallInList¶ Sets a wall builder in the array at the given index
Signature
SetWallInList(index, wall)Parameters: - index (
NXOpen.Display.StageWallType) – index to the array of walls - wall (
NXOpen.Display.Wall) – the wall
New in version NX5.0.0.
License requirements: None.
- index (
Validate¶
-
Stage.Validate¶ Validate whether the inputs to the component are sufficient for commit to be called.
If the component is not in a state to commit then an exception is thrown. For example, if the component requires you to set some property, this method will throw an exception if you haven’t set it. This method throws a not-yet-implemented NXException for some components.
Signature
Validate()Returns: Was self validation successful Return type: bool New in version NX3.0.1.
License requirements: None.