NXOpen .NET Reference
12.0.0
|
Represents a NXOpen.Display.Stage A stage is an environment cube, a six-sided room, that can have between one and six visible walls. More...
Public Types | |
enum | WallType { Left, Right, Top, Bottom, Front, Back, Total } |
Represents an index to a particular wall in the stage. More... | |
enum | OrientationType { Yz, Xz, Xy, UserDefined } |
Represents an index to a floor plane type define More... | |
Public Member Functions | |
unsafe void | FloorXaxis () |
The stage's bottom wall to align with the WCS x-axis More... | |
unsafe void | FloorYaxis () |
The stage's bottom wall to align with the WCS y-axis More... | |
unsafe void | FloorZaxis () |
The stage's bottom wall to align with the WCS z-axis More... | |
unsafe void | AlignFloorPlane (NXOpen.Plane specifyFloorPlane) |
The stage's bottom wall (floor) aligns with the given plane. More... | |
unsafe NXOpen.Display.Wall | GetWallFromList (NXOpen.Display.Stage.WallType index) |
Returns a wall builder, given by the index, in the array of walls for the given stage More... | |
unsafe void | SetWallInList (NXOpen.Display.Stage.WallType index, NXOpen.Display.Wall wall) |
Sets a wall builder in the array at the given index More... | |
unsafe void | CommitWall (NXOpen.View view, int currentWallIndex, bool updateStageDatabase) |
Updates the data and display for a given wall More... | |
unsafe void | CommitOffset (NXOpen.View view) |
Updates the data and display for a change to the stage's offset More... | |
Public Member Functions inherited from NXOpen.Builder | |
unsafe NXOpen.NXObject | Commit () |
Commits any edits that have been applied to the builder. More... | |
unsafe void | Destroy () |
Deletes the builder, and cleans up any objects created by the builder. More... | |
unsafe NXOpen.NXObject[] | GetCommittedObjects () |
For builders that create more than one object, this method returns the objects that are created by commit. More... | |
unsafe NXOpen.NXObject | GetObject () |
Returns the object currently being edited by this builder. More... | |
unsafe void | ShowResults () |
Updates the model to reflect the result of an edit to the model for all builders that support showing results. More... | |
unsafe bool | Validate () |
Validate whether the inputs to the component are sufficient for commit to be called. More... | |
Properties | |
unsafe NXOpen.Display.Stage.OrientationType | FloorOrientationType [get, set] |
Returns or sets the floor orientation define More... | |
unsafe double | Offset [get, set] |
Returns or sets the offset distance to translate the stage in the z-direction, in part units More... | |
unsafe NXOpen.Expression | OffsetExpression [get] |
Returns the stage offset expression More... | |
unsafe double | Size [get, set] |
Returns or sets the size all of the stage walls (length and width), in part units More... | |
unsafe NXOpen.Expression | SizeExpression [get] |
Returns the stage size expression More... | |
unsafe NXOpen.Plane | SpecifyFloorPlane [get, set] |
Returns or sets the specify floor plane More... | |
Represents a NXOpen.Display.Stage A 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 a null reference (Nothing in Visual Basic).
To create a new instance of this class, use NXOpen.ViewCollection.CreateStage
Created in NX5.0.0
Represents an index to a particular wall in the stage.
unsafe void NXOpen.Display.Stage.AlignFloorPlane | ( | NXOpen.Plane | specifyFloorPlane | ) |
The stage's bottom wall (floor) aligns with the given plane.
Created in NX5.0.0
License requirements: None.
specifyFloorPlane |
unsafe void NXOpen.Display.Stage.CommitOffset | ( | NXOpen.View | view | ) |
Updates the data and display for a change to the stage's offset
Created in NX5.0.0
License requirements: None.
view | view of the stage |
unsafe void NXOpen.Display.Stage.CommitWall | ( | NXOpen.View | view, |
int | currentWallIndex, | ||
bool | updateStageDatabase | ||
) |
Updates the data and display for a given wall
Created in NX5.0.0
License requirements: None.
view | view of the stage and walls |
currentWallIndex | the index of the wall in the stage builder array |
updateStageDatabase | if true, commit the stage builder |
unsafe void NXOpen.Display.Stage.FloorXaxis | ( | ) |
The stage's bottom wall to align with the WCS x-axis
Created in NX5.0.0
License requirements: None.
unsafe void NXOpen.Display.Stage.FloorYaxis | ( | ) |
The stage's bottom wall to align with the WCS y-axis
Created in NX5.0.0
License requirements: None.
unsafe void NXOpen.Display.Stage.FloorZaxis | ( | ) |
The stage's bottom wall to align with the WCS z-axis
Created in NX5.0.0
License requirements: None.
unsafe NXOpen.Display.Wall NXOpen.Display.Stage.GetWallFromList | ( | NXOpen.Display.Stage.WallType | index | ) |
Returns a wall builder, given by the index, in the array of walls for the given stage
Created in NX5.0.0
License requirements: None.
index | index to the array of walls |
unsafe void NXOpen.Display.Stage.SetWallInList | ( | NXOpen.Display.Stage.WallType | index, |
NXOpen.Display.Wall | wall | ||
) |
Sets a wall builder in the array at the given index
Created in NX5.0.0
License requirements: None.
index | index to the array of walls |
wall | the wall |
|
getset |
Returns or sets the floor orientation define
Created in NX10.0.0
License requirements to get this property: None.
License requirements to set this property: None.
|
getset |
Returns or sets the offset distance to translate the stage in the z-direction, in part units
Created in NX5.0.0
Deprecated in NX10.0.0. Use NXOpen.Display.Stage.OffsetExpression instead.
License requirements to get this property: None.
License requirements to set this property: None.
|
get |
Returns the stage offset expression
Created in NX10.0.0
License requirements: None.
|
getset |
Returns or sets the size all of the stage walls (length and width), in part units
Created in NX5.0.0
Deprecated in NX10.0.0. Use NXOpen.Display.Stage.SizeExpression instead.
License requirements to get this property: None.
License requirements to set this property: None.
|
get |
Returns the stage size expression
Created in NX10.0.0
License requirements: None.
|
getset |
Returns or sets the specify floor plane
Created in NX5.0.0
License requirements to get this property: None.
License requirements to set this property: None.