Represents a Display::Wall
This class is restricted to being called from a program running during an Interactive NX session. More...

Inheritance diagram for NXOpen::Display::Wall:

Public Types
enum	MaterialType { MaterialTypeShadowCatcher, MaterialTypeReflective, MaterialTypeInvisible }
	Defines the material characteristics of a stage wall. More...

Public Member Functions
NXOpen::Display::Image *	Image ()
	Returns the walls's image builder Created in NX5.0.0.

NXString	ImageFilename ()
	Returns the stage wall's image filename Created in NX5.0.0.

double	PatternRepeatFactor ()
	Returns the pattern repeat factor - the number of times the image repeats Created in NX5.0.0.

double	Reflectivity ()
	Returns the reflectivity of a wall - the percentage of the environment reflected off of the wall Created in NX5.0.0.

void	SetImage (NXOpen::Display::Image *imageBuilder)
	Sets the walls's image builder Created in NX5.0.0.

void	SetImageFilename (const NXString &newImageFileName)
	Sets the stage wall's image filename Created in NX5.0.0.

void	SetImageFilename (const char *newImageFileName)
	Sets the stage wall's image filename Created in NX5.0.0.

void	SetPatternRepeatFactor (double patternRepeatFactor)
	Sets the pattern repeat factor - the number of times the image repeats Created in NX5.0.0.

void	SetReflectivity (double reflectivity)
	Sets the reflectivity of a wall - the percentage of the environment reflected off of the wall Created in NX5.0.0.

void	SetWallMaterialType (NXOpen::Display::Wall::MaterialType wallMaterialType)
	Sets the wall material type - either shadow_catcher, reflective, or invisible Created in NX5.0.0.

NXOpen::Display::Wall::MaterialType	WallMaterialType ()
	Returns the wall material type - either shadow_catcher, reflective, or invisible 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::Wall
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::CreateWall

Created in NX5.0.0.

Member Enumeration Documentation

enum NXOpen::Display::Wall::MaterialType

Defines the material characteristics of a stage wall.

Enumerator:

MaterialTypeShadowCatcher

The wall is transparent, and is used to display shadows.

Use this to cast shadows onto a "virtual" background image of an environment.

MaterialTypeReflective

The wall is reflective.

For example, use this on a "bottom" wall to display a shiny floor.

MaterialTypeInvisible

The wall is not displayed.

For example, use this on all the walls except the "bottom" if you only need to display a floor.

Member Function Documentation

NXOpen::Display::Image* NXOpen::Display::Wall::Image ( )

Returns the walls's image builder
Created in NX5.0.0.

License requirements : None

NXString NXOpen::Display::Wall::ImageFilename ( )

Returns the stage wall's image filename
Created in NX5.0.0.

License requirements : None

double NXOpen::Display::Wall::PatternRepeatFactor ( )

Returns the pattern repeat factor - the number of times the image repeats
Created in NX5.0.0.

License requirements : None

double NXOpen::Display::Wall::Reflectivity ( )

Returns the reflectivity of a wall - the percentage of the environment reflected off of the wall
Created in NX5.0.0.

License requirements : None

void NXOpen::Display::Wall::SetImage ( NXOpen::Display::Image * imageBuilder )

Sets the walls's image builder
Created in NX5.0.0.

License requirements : None

Parameters

imageBuilder image builder

void NXOpen::Display::Wall::SetImageFilename ( const NXString & newImageFileName )

Sets the stage wall's image filename
Created in NX5.0.0.

License requirements : None

Parameters

newImageFileName new image file name

void NXOpen::Display::Wall::SetImageFilename ( const char * newImageFileName )

Sets the stage wall's image filename
Created in NX5.0.0.

License requirements : None

Parameters

newImageFileName new image file name

void NXOpen::Display::Wall::SetPatternRepeatFactor ( double patternRepeatFactor )

Sets the pattern repeat factor - the number of times the image repeats
Created in NX5.0.0.

License requirements : None

Parameters

patternRepeatFactor patternrepeatfactor

void NXOpen::Display::Wall::SetReflectivity ( double reflectivity )

Sets the reflectivity of a wall - the percentage of the environment reflected off of the wall
Created in NX5.0.0.

License requirements : None

Parameters

reflectivity reflectivity

void NXOpen::Display::Wall::SetWallMaterialType ( NXOpen::Display::Wall::MaterialType wallMaterialType )

Sets the wall material type - either shadow_catcher, reflective, or invisible
Created in NX5.0.0.

License requirements : None

Parameters

wallMaterialType wallmaterialtype

NXOpen::Display::Wall::MaterialType NXOpen::Display::Wall::WallMaterialType ( )

Returns the wall material type - either shadow_catcher, reflective, or invisible
Created in NX5.0.0.

License requirements : None

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

Display_Wall.hxx

Public Types

Public Member Functions

Detailed Description

Member Enumeration Documentation

Member Function Documentation