Wall Class¶
-
class
NXOpen.Display.
Wall
¶ Bases:
NXOpen.Builder
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 None.
To create a new instance of this class, use
NXOpen.ViewCollection.CreateWall()
New in version NX5.0.0.
Properties¶
Property | Description |
---|---|
Image | Returns or sets the walls’s image builder |
ImageFilename | Returns or sets the stage wall’s image filename |
PatternRepeatFactor | Returns or sets the pattern repeat factor - the number of times the image repeats |
Reflectivity | Returns or sets the reflectivity of a wall - the percentage of the environment reflected off of the wall |
Tag | Returns the Tag for this object. |
WallMaterialTextureType | Returns or sets the wall material texture type - either shadow_catcher, image file, or invisible |
WallMaterialType | Returns or sets the wall material type - either shadow_catcher, reflective, or invisible |
Methods¶
Method | Description |
---|---|
Commit | Commits any edits that have been applied to the builder. |
Destroy | Deletes the builder, and cleans up any objects created by the builder. |
GetCommittedObjects | For builders that create more than one object, this method returns the objects that are created by commit. |
GetObject | Returns the object currently being edited by this builder. |
ShowResults | Updates the model to reflect the result of an edit to the model for all builders that support showing results. |
Validate | Validate whether the inputs to the component are sufficient for commit to be called. |
Enumerations¶
WallMaterialTextureType Enumeration | the new wall material texture type |
WallMaterialType Enumeration | Defines the material characteristics of a stage wall. |
Property Detail¶
Image¶
-
Wall.
Image
¶ Returns or sets the walls’s image builder
-------------------------------------
Getter Method
Signature
Image
Returns: Return type: NXOpen.Display.Image
New in version NX5.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
Image
Parameters: imageBuilder ( NXOpen.Display.Image
) –New in version NX5.0.0.
License requirements: None.
ImageFilename¶
-
Wall.
ImageFilename
¶ Returns or sets the stage wall’s image filename
-------------------------------------
Getter Method
Signature
ImageFilename
Returns: Return type: str New in version NX5.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
ImageFilename
Parameters: newImageFileName (str) – New in version NX5.0.0.
License requirements: None.
PatternRepeatFactor¶
-
Wall.
PatternRepeatFactor
¶ Returns or sets the pattern repeat factor - the number of times the image repeats
-------------------------------------
Getter Method
Signature
PatternRepeatFactor
Returns: Return type: float New in version NX5.0.0.
Deprecated since version NX10.0.0: This functionality is moved to
NXOpen.Display.Image
.License requirements: None.
-------------------------------------
Setter Method
Signature
PatternRepeatFactor
Parameters: patternRepeatFactor (float) – New in version NX5.0.0.
Deprecated since version NX10.0.0: This functionality is moved to
NXOpen.Display.Image
.License requirements: None.
Reflectivity¶
-
Wall.
Reflectivity
¶ Returns or sets the reflectivity of a wall - the percentage of the environment reflected off of the wall
-------------------------------------
Getter Method
Signature
Reflectivity
Returns: Return type: float New in version NX5.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
Reflectivity
Parameters: reflectivity (float) – New in version NX5.0.0.
License requirements: None.
WallMaterialTextureType¶
-
Wall.
WallMaterialTextureType
¶ Returns or sets the wall material texture type - either shadow_catcher, image file, or invisible
-------------------------------------
Getter Method
Signature
WallMaterialTextureType
Returns: Return type: NXOpen.Display.WallMaterialTextureType
New in version NX10.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
WallMaterialTextureType
Parameters: wallMaterialType ( NXOpen.Display.WallMaterialTextureType
) –New in version NX10.0.0.
License requirements: None.
WallMaterialType¶
-
Wall.
WallMaterialType
¶ Returns or sets the wall material type - either shadow_catcher, reflective, or invisible
-------------------------------------
Getter Method
Signature
WallMaterialType
Returns: Return type: NXOpen.Display.WallMaterialType
New in version NX5.0.0.
Deprecated since version NX10.0.0: Use
NXOpen.Display.Wall.WallMaterialTextureType`()
instead.License requirements: None.
-------------------------------------
Setter Method
Signature
WallMaterialType
Parameters: wallMaterialType ( NXOpen.Display.WallMaterialType
) –New in version NX5.0.0.
Deprecated since version NX10.0.0: Use
NXOpen.Display.Wall.WallMaterialTextureType`()
instead.License requirements: None.
Method Detail¶
Validate¶
-
Wall.
Validate
¶ Validate whether the inputs to the component are sufficient for commit to be called.
If the component is not in a state to commit then an exception is thrown. For example, if the component requires you to set some property, this method will throw an exception if you haven’t set it. This method throws a not-yet-implemented NXException for some components.
Signature
Validate()
Returns: Was self validation successful Return type: bool New in version NX3.0.1.
License requirements: None.