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:

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::Wall *	GetWallFromList (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::Plane *	SpecifyFloorPlane ()
	Returns the specify floor plane Created in NX5.0.0.

Public Member Functions inherited from NXOpen::Builder
NXOpen::NXObject *	Commit ()
	Commits any edits that have been applied to the builder.

void	Destroy ()
	Deletes the builder, and cleans up any objects created by the builder.

std::vector< NXOpen::NXObject * >	GetCommittedObjects ()
	For builders that create more than one object, this method returns the objects that are created by commit.

NXOpen::NXObject *	GetObject ()
	Returns the object currently being edited by this builder.

void	ShowResults ()
	Updates the model to reflect the result of an edit to the model for all builders that support showing results.

virtual bool	Validate ()
	Validate whether the inputs to the component are sufficient for commit to be called.

Public Member Functions inherited from NXOpen::TaggedObject
tag_t	GetTag () const
	<b>Deprecated</b>:<br> Use Tag instead.

tag_t	Tag () const
	Returns the tag of this object.

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.
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 NULL.

To create a new instance of this class, use ViewCollection::CreateStage

Created in NX5.0.0.

Member Enumeration Documentation

enum NXOpen::Display::Stage::WallType

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

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

Parameters

specifyFloorPlane specifyfloorplane

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

Parameters

view	view 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

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

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

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

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

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.

Returns: the wall
Created in NX5.0.0.

License requirements : None

Parameters

index index to the array of walls

double NXOpen::Display::Stage::Offset ( )

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

offset offset

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

size size

void NXOpen::Display::Stage::SetSpecifyFloorPlane ( NXOpen::Plane * specifyFloorPlane )

Sets the specify floor plane
Created in NX5.0.0.

License requirements : None

Parameters

specifyFloorPlane specifyfloorplane

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

Parameters

index	index to the array of walls
wall	the wall

double NXOpen::Display::Stage::Size ( )

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

License requirements : None

NXOpen::Plane* NXOpen::Display::Stage::SpecifyFloorPlane ( )

Returns the specify floor plane
Created in NX5.0.0.

License requirements : None

The documentation for this class was generated from the following file:

Display_Stage.hxx

Public Types

Public Member Functions

Detailed Description

Member Enumeration Documentation

Member Function Documentation