IrayPlusSimpleMaterialEditorBuilder Class¶
-
class
NXOpen.Display.IrayPlusSimpleMaterialEditorBuilder¶ Bases:
NXOpen.BuilderRepresents a
NXOpen.Display.IrayPlusSimpleMaterialEditorBuilderThis 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.
New in version NX10.0.2.
Properties¶
| Property | Description |
|---|---|
| AspectRatio | Returns or sets the aspect ratio |
| FileBrowser | Returns or sets the file browser |
| LatitudeScale | Returns or sets the latitude scale |
| LongitudeScale | Returns or sets the longitude scale |
| NameString | Returns or sets the name string |
| NormalVector | Returns or sets the normal vector |
| Scale | Returns or sets the scale |
| Tag | Returns the Tag for this object. |
| TextureSpaceEnum | Returns or sets the texture space enum |
| TexturedToggle | Returns or sets the textured toggle |
| UScale | Returns or sets the u scale |
| UpVector | Returns or sets the up vector |
| VScale | Returns or sets the v scale |
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. |
| ExportXMLButton | To export to a XML file |
| GetColorPicker | Returns the color picker @return Array of 3 RGB values, each between 0 and 1 |
| 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. |
| SaveMaterialsButton | To save to System Studio Materials |
| SetColorPicker | Sets the color picker |
| 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¶
| IrayPlusSimpleMaterialEditorBuilderTextureSpace Enumeration | texture spacee type |
Property Detail¶
AspectRatio¶
-
IrayPlusSimpleMaterialEditorBuilder.AspectRatio¶ Returns or sets the aspect ratio
-------------------------------------Getter Method
Signature
AspectRatio()Returns: Return type: float New in version NX10.0.2.
License requirements: studio_render (“UG STUDIO RENDER”)
-------------------------------------Setter Method
Signature
AspectRatio(aspectRatio)Parameters: aspectRatio (float) – New in version NX10.0.2.
License requirements: studio_render (“UG STUDIO RENDER”)
FileBrowser¶
-
IrayPlusSimpleMaterialEditorBuilder.FileBrowser¶ Returns or sets the file browser
-------------------------------------Getter Method
Signature
FileBrowser()Returns: Return type: str New in version NX10.0.2.
License requirements: studio_render (“UG STUDIO RENDER”)
-------------------------------------Setter Method
Signature
FileBrowser(filename)Parameters: filename (str) – New in version NX10.0.2.
License requirements: studio_render (“UG STUDIO RENDER”)
LatitudeScale¶
-
IrayPlusSimpleMaterialEditorBuilder.LatitudeScale¶ Returns or sets the latitude scale
-------------------------------------Getter Method
Signature
LatitudeScale()Returns: Return type: float New in version NX10.0.2.
License requirements: studio_render (“UG STUDIO RENDER”)
-------------------------------------Setter Method
Signature
LatitudeScale(latitudeScale)Parameters: latitudeScale (float) – New in version NX10.0.2.
License requirements: studio_render (“UG STUDIO RENDER”)
LongitudeScale¶
-
IrayPlusSimpleMaterialEditorBuilder.LongitudeScale¶ Returns or sets the longitude scale
-------------------------------------Getter Method
Signature
LongitudeScale()Returns: Return type: float New in version NX10.0.2.
License requirements: studio_render (“UG STUDIO RENDER”)
-------------------------------------Setter Method
Signature
LongitudeScale(longitudeScale)Parameters: longitudeScale (float) – New in version NX10.0.2.
License requirements: studio_render (“UG STUDIO RENDER”)
NameString¶
-
IrayPlusSimpleMaterialEditorBuilder.NameString¶ Returns or sets the name string
-------------------------------------Getter Method
Signature
NameString()Returns: Return type: str New in version NX10.0.2.
License requirements: studio_render (“UG STUDIO RENDER”)
-------------------------------------Setter Method
Signature
NameString(nameString)Parameters: nameString (str) – New in version NX10.0.2.
License requirements: studio_render (“UG STUDIO RENDER”)
NormalVector¶
-
IrayPlusSimpleMaterialEditorBuilder.NormalVector¶ Returns or sets the normal vector
-------------------------------------Getter Method
Signature
NormalVector()Returns: Return type: NXOpen.DirectionNew in version NX10.0.2.
License requirements: studio_render (“UG STUDIO RENDER”)
-------------------------------------Setter Method
Signature
NormalVector(normalVector)Parameters: normalVector ( NXOpen.Direction) –New in version NX10.0.2.
License requirements: studio_render (“UG STUDIO RENDER”)
Scale¶
-
IrayPlusSimpleMaterialEditorBuilder.Scale¶ Returns or sets the scale
-------------------------------------Getter Method
Signature
Scale()Returns: Return type: float New in version NX10.0.2.
License requirements: studio_render (“UG STUDIO RENDER”)
-------------------------------------Setter Method
Signature
Scale(scale)Parameters: scale (float) – New in version NX10.0.2.
License requirements: studio_render (“UG STUDIO RENDER”)
TextureSpaceEnum¶
-
IrayPlusSimpleMaterialEditorBuilder.TextureSpaceEnum¶ Returns or sets the texture space enum
-------------------------------------Getter Method
Signature
TextureSpaceEnum()Returns: Return type: NXOpen.Display.IrayPlusSimpleMaterialEditorBuilderTextureSpaceNew in version NX10.0.2.
License requirements: studio_render (“UG STUDIO RENDER”)
-------------------------------------Setter Method
Signature
TextureSpaceEnum(textureSpaceEnum)Parameters: textureSpaceEnum ( NXOpen.Display.IrayPlusSimpleMaterialEditorBuilderTextureSpace) –New in version NX10.0.2.
License requirements: studio_render (“UG STUDIO RENDER”)
TexturedToggle¶
-
IrayPlusSimpleMaterialEditorBuilder.TexturedToggle¶ Returns or sets the textured toggle
-------------------------------------Getter Method
Signature
TexturedToggle()Returns: Return type: bool New in version NX10.0.2.
License requirements: studio_render (“UG STUDIO RENDER”)
-------------------------------------Setter Method
Signature
TexturedToggle(texturedToggle)Parameters: texturedToggle (bool) – New in version NX10.0.2.
License requirements: studio_render (“UG STUDIO RENDER”)
UScale¶
-
IrayPlusSimpleMaterialEditorBuilder.UScale¶ Returns or sets the u scale
-------------------------------------Getter Method
Signature
UScale()Returns: Return type: float New in version NX10.0.2.
License requirements: studio_render (“UG STUDIO RENDER”)
-------------------------------------Setter Method
Signature
UScale(uScale)Parameters: uScale (float) – New in version NX10.0.2.
License requirements: studio_render (“UG STUDIO RENDER”)
UpVector¶
-
IrayPlusSimpleMaterialEditorBuilder.UpVector¶ Returns or sets the up vector
-------------------------------------Getter Method
Signature
UpVector()Returns: Return type: NXOpen.DirectionNew in version NX10.0.2.
License requirements: studio_render (“UG STUDIO RENDER”)
-------------------------------------Setter Method
Signature
UpVector(upVector)Parameters: upVector ( NXOpen.Direction) –New in version NX10.0.2.
License requirements: studio_render (“UG STUDIO RENDER”)
VScale¶
-
IrayPlusSimpleMaterialEditorBuilder.VScale¶ Returns or sets the v scale
-------------------------------------Getter Method
Signature
VScale()Returns: Return type: float New in version NX10.0.2.
License requirements: studio_render (“UG STUDIO RENDER”)
-------------------------------------Setter Method
Signature
VScale(vScale)Parameters: vScale (float) – New in version NX10.0.2.
License requirements: studio_render (“UG STUDIO RENDER”)
Method Detail¶
ExportXMLButton¶
-
IrayPlusSimpleMaterialEditorBuilder.ExportXMLButton¶ To export to a XML file
Signature
ExportXMLButton()New in version NX10.0.2.
License requirements: studio_render (“UG STUDIO RENDER”)
GetColorPicker¶
-
IrayPlusSimpleMaterialEditorBuilder.GetColorPicker¶ Returns the color picker
Signature
GetColorPicker()Returns: Array of 3 RGB values, each between 0 and 1 Return type: list of float New in version NX10.0.2.
License requirements: studio_render (“UG STUDIO RENDER”)
SaveMaterialsButton¶
-
IrayPlusSimpleMaterialEditorBuilder.SaveMaterialsButton¶ To save to System Studio Materials
Signature
SaveMaterialsButton()New in version NX10.0.2.
License requirements: studio_render (“UG STUDIO RENDER”)
SetColorPicker¶
-
IrayPlusSimpleMaterialEditorBuilder.SetColorPicker¶ Sets the color picker
Signature
SetColorPicker(colorPicker)Parameters: colorPicker (list of float) – Array of 3 RGB values, each between 0 and 1 New in version NX10.0.2.
License requirements: studio_render (“UG STUDIO RENDER”)
Validate¶
-
IrayPlusSimpleMaterialEditorBuilder.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.