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

Represents a Display::Wall
To create a new instance of this class, use ViewCollection::CreateWall

Created in NX5.0.0. More...

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

List of all members.

Public Types

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

Public Member Functions

NXOpen::Display::ImageImage ()
 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 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.

Detailed Description

Represents a Display::Wall
To create a new instance of this class, use ViewCollection::CreateWall

Created in NX5.0.0.



Member Enumeration Documentation

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

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



License requirements : None

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



License requirements : None

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



License requirements : None

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



License requirements : None

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



License requirements : None

Parameters:
imageBuilderimage 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:
newImageFileNamenew 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:
patternRepeatFactorpatternrepeatfactor
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:
reflectivityreflectivity

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



License requirements : None

Parameters:
wallMaterialTypewallmaterialtype

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:
Copyright 2011 Siemens Product Lifecycle Management Software Inc. All Rights Reserved.