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

Inheritance diagram for NXOpen.Display.Stage:

Public Types
enum	OrientationType { Yz, Xz, Xy, UserDefined }
	Represents an index to a floor plane type define More...

enum	WallType { Left, Right, Top, Bottom, Front, Back, Total }
	Represents an index to a particular wall in the stage. More...

Public Member Functions
unsafe void	AlignFloorPlane (NXOpen.Plane specifyFloorPlane)
	The stage's bottom wall (floor) aligns with the given plane. More...

unsafe void	CommitOffset (NXOpen.View view)
	Updates the data and display for a change to the stage's offset More...

unsafe void	CommitWall (NXOpen.View view, int currentWallIndex, bool updateStageDatabase)
	Updates the data and display for a given wall More...

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

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

Public Member Functions inherited from NXOpen.TaggedObject
void	PrintTestData (String variableName)
	<exclude> More...

void	PrintTestData (String variableName, int lineNumber)
	<exclude> More...

override string	ToString ()
	Returns a String that represents the current Object. More...

Public Member Functions inherited from NXOpen.Utilities.NXRemotableObject
IMessageCtrl	AsyncProcessMessage (IMessage msg, IMessageSink replySink)
	Asynchronously processes the given message. More...

IMessage	SyncProcessMessage (IMessage msg)
	Synchronously processes the given message. 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...

Properties inherited from NXOpen.Builder
unsafe NXOpen.PreviewBuilder	PreviewBuilder `[get]`
	Returns the preview builder subobject. More...

Properties inherited from NXOpen.TaggedObject
Tag	Tag `[get]`
	Returns the tag of this object. More...

Properties inherited from NXOpen.Utilities.NXRemotableObject
IMessageSink	NextSink `[get]`
	Gets the next message sink in the sink chain. More...

Additional Inherited Members
Protected Member Functions inherited from NXOpen.TaggedObject
new void	initialize ()
	<exclude> More...

Detailed Description

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

Member Enumeration Documentation

enum NXOpen.Display.Stage.OrientationType

Represents an index to a floor plane type define

Enumerator
Yz	Use yz plane for the stage floor.
Xz	Use xz plane for the stage floor.
Xy	Use xy plane for the stage floor.
UserDefined	Use user defined plane for the stage floor.

enum NXOpen.Display.Stage.WallType

Represents an index to a particular wall in the stage.

Enumerator
Left	The left wall of the stage.
Right	The right wall of the stage.
Top	The top wall or "ceiling" of the stage.
Bottom	The bottom wall or "floor" of the stage.
Front	The front wall of the stage.
Back	The back wall of the stage.
Total	The total number of walls in the stage.

Member Function Documentation

unsafe void NXOpen.Display.Stage.AlignFloorPlane ( NXOpen.Plane specifyFloorPlane )

inline

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

Created in NX5.0.0

License requirements: None.

Parameters

specifyFloorPlane

unsafe void NXOpen.Display.Stage.CommitOffset ( NXOpen.View view )

inline

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

unsafe void NXOpen.Display.Stage.CommitWall	(	NXOpen.View	view,
		int	currentWallIndex,
		bool	updateStageDatabase
	)

inline

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

unsafe void NXOpen.Display.Stage.FloorXaxis ( )

inline

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 ( )

inline

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 ( )

inline

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 )

inline

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.

Parameters

index index to the array of walls

Returns: the wall

unsafe void NXOpen.Display.Stage.SetWallInList	(	NXOpen.Display.Stage.WallType	index,
		NXOpen.Display.Wall	wall
	)

inline

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

Property Documentation

unsafe NXOpen.Display.Stage.OrientationType NXOpen.Display.Stage.FloorOrientationType

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.

unsafe double NXOpen.Display.Stage.Offset

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.

unsafe NXOpen.Expression NXOpen.Display.Stage.OffsetExpression

get

Returns the stage offset expression

Created in NX10.0.0

License requirements: None.

unsafe double NXOpen.Display.Stage.Size

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.

unsafe NXOpen.Expression NXOpen.Display.Stage.SizeExpression

get

Returns the stage size expression

Created in NX10.0.0

License requirements: None.

unsafe NXOpen.Plane NXOpen.Display.Stage.SpecifyFloorPlane

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.

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

Display_Stage.cs

Public Types

Public Member Functions

Properties

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

Member Function Documentation

Property Documentation