Represents a NXOpen::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	MaterialTextureType { MaterialTextureTypeShadowCatcher, MaterialTextureTypeImageFile, MaterialTextureTypeInvisible }
	the new wall material texture type More...

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

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

double	PatternRepeatFactor ()
	Returns the pattern repeat factor - the number of times the image repeats More...

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

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

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

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

void	SetPatternRepeatFactor (double patternRepeatFactor)
	Sets the pattern repeat factor - the number of times the image repeats More...

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

void	SetWallMaterialTextureType (NXOpen::Display::Wall::MaterialTextureType wallMaterialType)
	Sets the wall material texture type - either shadow_catcher, image file, or invisible Created in NX10.0.0. More...

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

NXOpen::Display::Wall::MaterialTextureType	WallMaterialTextureType ()
	Returns the wall material texture type - either shadow_catcher, image file, or invisible Created in NX10.0.0. More...

NXOpen::Display::Wall::MaterialType	WallMaterialType ()
	Returns the wall material type - either shadow_catcher, reflective, or invisible More...

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

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

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

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

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

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

Public Member Functions inherited from NXOpen::TaggedObject
tag_t	Tag () const
	Returns the tag of this object. More...

Detailed Description

Represents a NXOpen::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 NXOpen::ViewCollection::CreateWall

Created in NX5.0.0.

Member Enumeration Documentation

enum NXOpen::Display::Wall::MaterialTextureType

the new wall material texture type

Enumerator

MaterialTextureTypeShadowCatcher

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

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

MaterialTextureTypeImageFile

The wall uses image for tiling.

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

MaterialTextureTypeInvisible

The wall is not displayed.

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

enum NXOpen::Display::Wall::MaterialType

Defines the material characteristics of a stage wall.

Deprecated:: Deprecated in NX10.0.0. Use NXOpen::Display::Wall::MaterialTextureType instead.

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

Deprecated:: Deprecated in NX10.0.0.

This functionality is moved to NXOpen::Display::Image .

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

Deprecated:: Deprecated in NX10.0.0.

This functionality is moved to NXOpen::Display::Image .

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::SetWallMaterialTextureType ( NXOpen::Display::Wall::MaterialTextureType wallMaterialType )

Sets the wall material texture type - either shadow_catcher, image file, or invisible
Created in NX10.0.0.

License requirements : None

Parameters

wallMaterialType wallmaterialtype

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

Sets the wall material type - either shadow_catcher, reflective, or invisible

Deprecated:: Deprecated in NX10.0.0.

Use NXOpen::Display::Wall::WallMaterialTextureType and NXOpen::Display::Wall::SetWallMaterialTextureType instead.

Created in NX5.0.0.

License requirements : None

Parameters

wallMaterialType wallmaterialtype

NXOpen::Display::Wall::MaterialTextureType NXOpen::Display::Wall::WallMaterialTextureType ( )

Returns the wall material texture type - either shadow_catcher, image file, or invisible
Created in NX10.0.0.

License requirements : None

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

Returns the wall material type - either shadow_catcher, reflective, or invisible

Deprecated:: Deprecated in NX10.0.0.

Use NXOpen::Display::Wall::WallMaterialTextureType and NXOpen::Display::Wall::SetWallMaterialTextureType instead.

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