public interface Stage extends Builder
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.
ViewCollection.createStage(nxopen.View, boolean)
Modifier and Type | Interface and Description |
---|---|
static class |
Stage.OrientationType
Represents an index to a floor plane type define
|
static class |
Stage.WallType
Represents an index to a particular wall in the
stage.
|
Modifier and Type | Method and Description |
---|---|
void |
alignFloorPlane(Plane specifyFloorPlane)
The stage's bottom wall (floor) aligns with the given plane.
|
void |
commitOffset(View view)
Updates the data and display for a change to the stage's offset
License requirements: None. |
void |
commitWall(View view,
int currentWallIndex,
boolean updateStageDatabase)
Updates the data and display for a given wall
License requirements: None. |
Stage.OrientationType |
floorOrientationType()
Returns the floor orientation define
License requirements: None. |
void |
floorXaxis()
The stage's bottom wall to align with the WCS x-axis
License requirements: None. |
void |
floorYaxis()
The stage's bottom wall to align with the WCS y-axis
License requirements: None. |
void |
floorZaxis()
The stage's bottom wall to align with the WCS z-axis
License requirements: None. |
Wall |
getWallFromList(Stage.WallType index)
Returns a wall builder, given by the index, in the array of walls for the given stage
License requirements: None. |
double |
offset()
Deprecated.
Deprecated in NX10.0.0. Use
offsetExpression() and nxopen.display.Stage#setOffsetExpression instead.
|
Expression |
offsetExpression()
Returns the stage offset expression
License requirements: None. |
void |
setFloorOrientationType(Stage.OrientationType floorOrientationType)
License requirements: None. |
void |
setOffset(double offset)
Deprecated.
Deprecated in NX10.0.0. This functionality is no longer supported.
|
void |
setSize(double size)
Deprecated.
Deprecated in NX10.0.0. This functionality is no longer supported.
|
void |
setSpecifyFloorPlane(Plane specifyFloorPlane)
License requirements: None. |
void |
setWallInList(Stage.WallType index,
Wall wall)
Sets a wall builder in the array at the given index
License requirements: None. |
double |
size()
Deprecated.
Deprecated in NX10.0.0. Use
sizeExpression() and nxopen.display.Stage#setSizeExpression instead.
|
Expression |
sizeExpression()
Returns the stage size expression
License requirements: None. |
Plane |
specifyFloorPlane()
Returns the specify floor plane
License requirements: None. |
commit, destroy, getCommittedObjects, getObject, showResults
printTestData, printTestData, tag, tagValue
validate
Expression sizeExpression() throws NXException, RemoteException
NXException
RemoteException
Expression offsetExpression() throws NXException, RemoteException
NXException
RemoteException
double size() throws NXException, RemoteException
sizeExpression()
and nxopen.display.Stage#setSizeExpression
instead.
NXException
RemoteException
void setSize(double size) throws NXException, RemoteException
size
- NXException
RemoteException
double offset() throws NXException, RemoteException
offsetExpression()
and nxopen.display.Stage#setOffsetExpression
instead.
NXException
RemoteException
void setOffset(double offset) throws NXException, RemoteException
offset
- NXException
RemoteException
Stage.OrientationType floorOrientationType() throws NXException, RemoteException
NXException
RemoteException
void setFloorOrientationType(Stage.OrientationType floorOrientationType) throws NXException, RemoteException
floorOrientationType
- NXException
RemoteException
void floorXaxis() throws NXException, RemoteException
NXException
RemoteException
void floorYaxis() throws NXException, RemoteException
NXException
RemoteException
void floorZaxis() throws NXException, RemoteException
NXException
RemoteException
Plane specifyFloorPlane() throws NXException, RemoteException
NXException
RemoteException
void setSpecifyFloorPlane(Plane specifyFloorPlane) throws NXException, RemoteException
specifyFloorPlane
- NXException
RemoteException
void alignFloorPlane(Plane specifyFloorPlane) throws NXException, RemoteException
specifyFloorPlane
- NXException
RemoteException
Wall getWallFromList(Stage.WallType index) throws NXException, RemoteException
index
- index to the array of wallsNXException
RemoteException
void setWallInList(Stage.WallType index, Wall wall) throws NXException, RemoteException
index
- index to the array of wallswall
- the wallNXException
RemoteException
void commitWall(View view, int currentWallIndex, boolean updateStageDatabase) throws NXException, RemoteException
view
- view of the stage and wallscurrentWallIndex
- the index of the wall in the stage builder arrayupdateStageDatabase
- if true, commit the stage builderNXException
RemoteException
void commitOffset(View view) throws NXException, RemoteException
view
- view of the stageNXException
RemoteException
Copyright 2011 Siemens Product Lifecycle Management Software Inc. All Rights Reserved.