NX Open C++ Reference Guide
Public Types | Public Member Functions
NXOpen::Display::Stage Class Reference

Represents a Display::Stage A stage is an environment cube, a six-sided room, that can have between one and six visible walls. More...

Inheritance diagram for NXOpen::Display::Stage:
NXOpen::Builder NXOpen::TaggedObject NXOpen::GeometricUtilities::IComponentBuilder

List of all members.

Public Types

enum  WallType {
  WallTypeLeft, WallTypeRight, WallTypeTop, WallTypeBottom,
  WallTypeFront, WallTypeBack, WallTypeTotal
}
 Represents an index to a particular wall in the stage. More...

Public Member Functions

void AlignFloorPlane (NXOpen::Plane *specifyFloorPlane)
 The stage's bottom wall (floor) aligns with the given plane.
void CommitOffset (NXOpen::View *view)
 Updates the data and display for a change to the stage's offset
Created in NX5.0.0.
void CommitWall (NXOpen::View *view, int currentWallIndex, bool updateStageDatabase)
 Updates the data and display for a given wall
Created in NX5.0.0.
void FloorXaxis ()
 The stage's bottom wall to align with the WCS x-axis
Created in NX5.0.0.
void FloorYaxis ()
 The stage's bottom wall to align with the WCS y-axis
Created in NX5.0.0.
void FloorZaxis ()
 The stage's bottom wall to align with the WCS z-axis
Created in NX5.0.0.
NXOpen::Display::WallGetWallFromList (NXOpen::Display::Stage::WallType index)
 Returns a wall builder, given by the index, in the array of walls for the given stage.
double Offset ()
 Returns the offset distance to translate the stage in the z-direction, in part units
Created in NX5.0.0.
void SetOffset (double offset)
 Sets the offset distance to translate the stage in the z-direction, in part units
Created in NX5.0.0.
void SetSize (double size)
 Sets the size all of the stage walls (length and width), in part units
Created in NX5.0.0.
void SetSpecifyFloorPlane (NXOpen::Plane *specifyFloorPlane)
 Sets the specify floor plane
Created in NX5.0.0.
void 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.
double Size ()
 Returns the size all of the stage walls (length and width), in part units
Created in NX5.0.0.
NXOpen::PlaneSpecifyFloorPlane ()
 Returns the specify floor plane
Created in NX5.0.0.

Detailed Description

Represents a 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.
To create a new instance of this class, use ViewCollection::CreateStage

Created in NX5.0.0.


Member Enumeration Documentation

Represents an index to a particular wall in the stage.

Enumerator:
WallTypeLeft 

The left wall of the stage.

WallTypeRight 

The right wall of the stage.

WallTypeTop 

The top wall or "ceiling" of the stage.

WallTypeBottom 

The bottom wall or "floor" of the stage.

WallTypeFront 

The front wall of the stage.

WallTypeBack 

The back wall of the stage.

WallTypeTotal 

The total number of walls in the stage.


Member Function Documentation

The stage's bottom wall (floor) aligns with the given plane.


Created in NX5.0.0.

License requirements : None

Parameters:
specifyFloorPlanespecifyfloorplane

Updates the data and display for a change to the stage's offset
Created in NX5.0.0.



License requirements : None

Parameters:
viewview of the stage
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

Parameters:
viewview of the stage and walls
currentWallIndexthe index of the wall in the stage builder array
updateStageDatabaseif true, commit the stage builder

The stage's bottom wall to align with the WCS x-axis
Created in NX5.0.0.



License requirements : None

The stage's bottom wall to align with the WCS y-axis
Created in NX5.0.0.



License requirements : None

The stage's bottom wall to align with the WCS z-axis
Created in NX5.0.0.



License requirements : None

Returns a wall builder, given by the index, in the array of walls for the given stage.

Returns:
the wall
Created in NX5.0.0.

License requirements : None
Parameters:
indexindex to the array of walls

Returns the offset distance to translate the stage in the z-direction, in part units
Created in NX5.0.0.



License requirements : None

void NXOpen::Display::Stage::SetOffset ( double  offset)

Sets the offset distance to translate the stage in the z-direction, in part units
Created in NX5.0.0.



License requirements : None

Parameters:
offsetoffset
void NXOpen::Display::Stage::SetSize ( double  size)

Sets the size all of the stage walls (length and width), in part units
Created in NX5.0.0.



License requirements : None

Parameters:
sizesize

Sets the specify floor plane
Created in NX5.0.0.



License requirements : None

Parameters:
specifyFloorPlanespecifyfloorplane

Sets a wall builder in the array at the given index
Created in NX5.0.0.



License requirements : None

Parameters:
indexindex to the array of walls
wallthe wall

Returns the size all of the stage walls (length and width), in part units
Created in NX5.0.0.



License requirements : None

Returns the specify floor plane
Created in NX5.0.0.



License requirements : None


The documentation for this class was generated from the following file:
Copyright 2011 Siemens Product Lifecycle Management Software Inc. All Rights Reserved.