TrueShadingBuilder Class

class NXOpen.Display.TrueShadingBuilder

Bases: NXOpen.Builder

Represents a NXOpen.Display.TrueShading builder

To create a new instance of this class, use NXOpen.Display.TrueShadingCollection.CreateTrueShadingBuilder()

New in version NX6.0.0.

Properties

Property Description
BgdImageEnum Returns or sets the background image list enum
BgdImageFileBrowser Returns or sets the background image filename
BgdTypeEnum Returns or sets the background color or background image type enum
EnvironmentMapEnum Returns or sets the reflection environment map enum type
EnvironmentMapFileBrowser Returns or sets the reflection environment map filename
GlobalMaterialType Returns or sets the globalMaterialType
InheritModelTogggle Returns or sets the shadow plane grid to inherit Model grid attributes toggle
LightCollectionEnum Returns or sets the light collection enum
LightDimmerValue Returns or sets the light dimmer value
ObjSpecificSelection Returns the selected object(s) list
PlanarReflectionToggle Returns or sets the planar reflection visibility toggle
PlanarShadowToggle Returns or sets the planar shadow visibility toggle
PlaneGridToggle Returns or sets the shadow plane grid visibility toggle
PlaneOffsetFixedToggle Returns or sets the shadow plane with fixed offset toggle
PlaneOffsetValue Returns or sets the offset distance between the shadow plane and the nearest vertex of the displayed object
ReflectivityValue Returns or sets the reflectivity value
ShedModeToggle Returns or sets the True Shading display toggle state
SnapFloorToggle Returns or sets the toggle forces the shadow plane to snap to the nearest object vertex
SoftShadowsToggle Returns or sets the soft shadows toggle
SpecifyPlane Returns or sets the custom plane definition for the shadow projection
SurfaceOrientEnum Returns or sets the shadow plane surface orientation enum
Tag Returns the Tag for this object.

Methods

Method Description
AssignOverrideMaterial Assigns an overriding material type to one or more selected objects
Commit Commits any edits that have been applied to the builder.
Destroy Deletes the builder, and cleans up any objects created by the builder.
GButton0 Global material button 1
GButton1 Global material button 2
GButton10 Global material button 11
GButton11 Global material button 12
GButton12 Global material button 13
GButton13 Global material button 14
GButton14 Global material button 15
GButton15 Global material button 16
GButton16 Global material button 17
GButton17 Global material button 18
GButton18 Global material button 19
GButton19 Global material button 20
GButton2 Global material button 3
GButton20 Global material button 21
GButton21 Global material button 22
GButton22 Global material button 23
GButton23 Global material button 24
GButton24 Global material button 25
GButton25 Global material button 26
GButton26 Global material button 27
GButton27 Global material button 28
GButton28 Global material button 29
GButton29 Global material button 30
GButton3 Global material button 4
GButton4 Global material button 5
GButton5 Global material button 6
GButton6 Global material button 7
GButton7 Global material button 8
GButton8 Global material button 9
GButton9 Global material button 10
GetBgdBottomRgbcolorPicker Returns the RGB values of background bottom color picker
GetBgdTopRgbcolorPicker Returns the RGB values of background top color picker
GetCommittedObjects For builders that create more than one object, this method returns the objects that are created by commit.
GetGridRgbcolorPicker Returns the grid RGB color values picker
GetObject Returns the object currently being edited by this builder.
OButton0 Per Object override material button 1
OButton1 Per Object override material button 2
OButton10 Per Object override material button 11
OButton11 Per Object override material button 12
OButton12 Per Object override material button 13
OButton13 Per Object override material button 14
OButton14 Per Object override material button 15
OButton15 Per Object override material button 16
OButton16 Per Object override material button 17
OButton17 Per Object override material button 18
OButton18 Per Object override material button 19
OButton19 Per Object override material button 20
OButton2 Per Object override material button 3
OButton20 Per Object override material button 21
OButton21 Per Object override material button 22
OButton22 Per Object override material button 23
OButton23 Per Object override material button 24
OButton24 Per Object override material button 25
OButton25 Per Object override material button 26
OButton26 Per Object override material button 27
OButton27 Per Object override material button 28
OButton28 Per Object override material button 29
OButton3 Per Object override material button 4
OButton4 Per Object override material button 5
OButton5 Per Object override material button 6
OButton6 Per Object override material button 7
OButton7 Per Object override material button 8
OButton8 Per Object override material button 9
OButton9 Per Object override material button 10
ORemoveButton Removes override material from selected object(s)
ProtectUpdate Protects update
SetBgdBottomRgbcolorPicker Sets the RGB values of background bottom color picker
SetBgdTopRgbcolorPicker Sets the RGB values of background top color picker
SetGridRgbcolorPicker Sets the grid RGB 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

TrueShadingBuilderBgdImageType Enumeration Background image types
TrueShadingBuilderBgdType Enumeration Background colors and image types
TrueShadingBuilderEnvironmentMapType Enumeration Global environment reflection map types
TrueShadingBuilderMaterialType Enumeration Global material and per object overriding material types
TrueShadingBuilderSHEDLightCollectionType Enumeration Scene lighting collection types
TrueShadingBuilderSurfaceOrientType Enumeration Shadow plane projection orientation types

Property Detail

BgdImageEnum

TrueShadingBuilder.BgdImageEnum

Returns or sets the background image list enum

-------------------------------------

Getter Method

Signature BgdImageEnum

Returns:
Return type:NXOpen.Display.TrueShadingBuilderBgdImageType

New in version NX6.0.0.

License requirements: None.

-------------------------------------

Setter Method

Signature BgdImageEnum

Parameters:bgdImageEnum (NXOpen.Display.TrueShadingBuilderBgdImageType) –

New in version NX6.0.0.

License requirements: None.

BgdImageFileBrowser

TrueShadingBuilder.BgdImageFileBrowser

Returns or sets the background image filename

-------------------------------------

Getter Method

Signature BgdImageFileBrowser

Returns:
Return type:str

New in version NX6.0.0.

License requirements: None.

-------------------------------------

Setter Method

Signature BgdImageFileBrowser

Parameters:filename (str) –

New in version NX6.0.0.

License requirements: None.

BgdTypeEnum

TrueShadingBuilder.BgdTypeEnum

Returns or sets the background color or background image type enum

-------------------------------------

Getter Method

Signature BgdTypeEnum

Returns:
Return type:NXOpen.Display.TrueShadingBuilderBgdType

New in version NX6.0.0.

License requirements: None.

-------------------------------------

Setter Method

Signature BgdTypeEnum

Parameters:bgdTypeEnum (NXOpen.Display.TrueShadingBuilderBgdType) –

New in version NX6.0.0.

License requirements: None.

EnvironmentMapEnum

TrueShadingBuilder.EnvironmentMapEnum

Returns or sets the reflection environment map enum type

-------------------------------------

Getter Method

Signature EnvironmentMapEnum

Returns:
Return type:NXOpen.Display.TrueShadingBuilderEnvironmentMapType

New in version NX6.0.0.

License requirements: None.

-------------------------------------

Setter Method

Signature EnvironmentMapEnum

Parameters:environmentMapEnum (NXOpen.Display.TrueShadingBuilderEnvironmentMapType) –

New in version NX6.0.0.

License requirements: None.

EnvironmentMapFileBrowser

TrueShadingBuilder.EnvironmentMapFileBrowser

Returns or sets the reflection environment map filename

-------------------------------------

Getter Method

Signature EnvironmentMapFileBrowser

Returns:
Return type:str

New in version NX6.0.0.

License requirements: None.

-------------------------------------

Setter Method

Signature EnvironmentMapFileBrowser

Parameters:filename (str) –

New in version NX6.0.0.

License requirements: None.

GlobalMaterialType

TrueShadingBuilder.GlobalMaterialType

Returns or sets the globalMaterialType

-------------------------------------

Getter Method

Signature GlobalMaterialType

Returns:
Return type:NXOpen.Display.TrueShadingBuilderMaterialType

New in version NX6.0.0.

License requirements: None.

-------------------------------------

Setter Method

Signature GlobalMaterialType

Parameters:globalMaterialType (NXOpen.Display.TrueShadingBuilderMaterialType) –

New in version NX6.0.0.

License requirements: None.

InheritModelTogggle

TrueShadingBuilder.InheritModelTogggle

Returns or sets the shadow plane grid to inherit Model grid attributes toggle

-------------------------------------

Getter Method

Signature InheritModelTogggle

Returns:
Return type:bool

New in version NX6.0.0.

License requirements: None.

-------------------------------------

Setter Method

Signature InheritModelTogggle

Parameters:inheritModelTogggle (bool) –

New in version NX6.0.0.

License requirements: None.

LightCollectionEnum

TrueShadingBuilder.LightCollectionEnum

Returns or sets the light collection enum

-------------------------------------

Getter Method

Signature LightCollectionEnum

Returns:
Return type:NXOpen.Display.TrueShadingBuilderSHEDLightCollectionType

New in version NX6.0.0.

License requirements: None.

-------------------------------------

Setter Method

Signature LightCollectionEnum

Parameters:lightCollectionEnum (NXOpen.Display.TrueShadingBuilderSHEDLightCollectionType) –

New in version NX6.0.0.

License requirements: None.

LightDimmerValue

TrueShadingBuilder.LightDimmerValue

Returns or sets the light dimmer value

-------------------------------------

Getter Method

Signature LightDimmerValue

Returns:
Return type:float

New in version NX6.0.0.

License requirements: None.

-------------------------------------

Setter Method

Signature LightDimmerValue

Parameters:lightDimmerValue (float) –

New in version NX6.0.0.

License requirements: None.

ObjSpecificSelection

TrueShadingBuilder.ObjSpecificSelection

Returns the selected object(s) list

-------------------------------------

Getter Method

Signature ObjSpecificSelection

Returns:
Return type:NXOpen.SelectNXObjectList

New in version NX6.0.0.

License requirements: None.

PlanarReflectionToggle

TrueShadingBuilder.PlanarReflectionToggle

Returns or sets the planar reflection visibility toggle

-------------------------------------

Getter Method

Signature PlanarReflectionToggle

Returns:
Return type:bool

New in version NX6.0.0.

License requirements: None.

-------------------------------------

Setter Method

Signature PlanarReflectionToggle

Parameters:planarReflectionToggle (bool) –

New in version NX6.0.0.

License requirements: None.

PlanarShadowToggle

TrueShadingBuilder.PlanarShadowToggle

Returns or sets the planar shadow visibility toggle

-------------------------------------

Getter Method

Signature PlanarShadowToggle

Returns:
Return type:bool

New in version NX6.0.0.

License requirements: None.

-------------------------------------

Setter Method

Signature PlanarShadowToggle

Parameters:planarShadowToggle (bool) –

New in version NX6.0.0.

License requirements: None.

PlaneGridToggle

TrueShadingBuilder.PlaneGridToggle

Returns or sets the shadow plane grid visibility toggle

-------------------------------------

Getter Method

Signature PlaneGridToggle

Returns:
Return type:bool

New in version NX6.0.0.

License requirements: None.

-------------------------------------

Setter Method

Signature PlaneGridToggle

Parameters:planeGridToggle (bool) –

New in version NX6.0.0.

License requirements: None.

PlaneOffsetFixedToggle

TrueShadingBuilder.PlaneOffsetFixedToggle

Returns or sets the shadow plane with fixed offset toggle

-------------------------------------

Getter Method

Signature PlaneOffsetFixedToggle

Returns:
Return type:bool

New in version NX6.0.0.

License requirements: None.

-------------------------------------

Setter Method

Signature PlaneOffsetFixedToggle

Parameters:planeOffsetFixedToggle (bool) –

New in version NX6.0.0.

License requirements: None.

PlaneOffsetValue

TrueShadingBuilder.PlaneOffsetValue

Returns or sets the offset distance between the shadow plane and the nearest vertex of the displayed object

-------------------------------------

Getter Method

Signature PlaneOffsetValue

Returns:
Return type:float

New in version NX6.0.0.

License requirements: None.

-------------------------------------

Setter Method

Signature PlaneOffsetValue

Parameters:planeOffsetValue (float) –

New in version NX6.0.0.

License requirements: None.

ReflectivityValue

TrueShadingBuilder.ReflectivityValue

Returns or sets the reflectivity value

-------------------------------------

Getter Method

Signature ReflectivityValue

Returns:
Return type:float

New in version NX6.0.0.

License requirements: None.

-------------------------------------

Setter Method

Signature ReflectivityValue

Parameters:reflectivityValue (float) –

New in version NX6.0.0.

License requirements: None.

ShedModeToggle

TrueShadingBuilder.ShedModeToggle

Returns or sets the True Shading display toggle state

-------------------------------------

Getter Method

Signature ShedModeToggle

Returns:
Return type:bool

New in version NX6.0.0.

License requirements: None.

-------------------------------------

Setter Method

Signature ShedModeToggle

Parameters:shedModeToggle (bool) –

New in version NX6.0.0.

License requirements: None.

SnapFloorToggle

TrueShadingBuilder.SnapFloorToggle

Returns or sets the toggle forces the shadow plane to snap to the nearest object vertex

-------------------------------------

Getter Method

Signature SnapFloorToggle

Returns:
Return type:bool

New in version NX6.0.0.

License requirements: None.

-------------------------------------

Setter Method

Signature SnapFloorToggle

Parameters:snapFloorToggle (bool) –

New in version NX6.0.0.

License requirements: None.

SoftShadowsToggle

TrueShadingBuilder.SoftShadowsToggle

Returns or sets the soft shadows toggle

-------------------------------------

Getter Method

Signature SoftShadowsToggle

Returns:
Return type:bool

New in version NX6.0.0.

License requirements: None.

-------------------------------------

Setter Method

Signature SoftShadowsToggle

Parameters:softShadowsToggle (bool) –

New in version NX6.0.0.

License requirements: None.

SpecifyPlane

TrueShadingBuilder.SpecifyPlane

Returns or sets the custom plane definition for the shadow projection

-------------------------------------

Getter Method

Signature SpecifyPlane

Returns:
Return type:NXOpen.Plane

New in version NX6.0.0.

License requirements: None.

-------------------------------------

Setter Method

Signature SpecifyPlane

Parameters:specifyPlane (NXOpen.Plane) –

New in version NX6.0.0.

License requirements: None.

SurfaceOrientEnum

TrueShadingBuilder.SurfaceOrientEnum

Returns or sets the shadow plane surface orientation enum

-------------------------------------

Getter Method

Signature SurfaceOrientEnum

Returns:
Return type:NXOpen.Display.TrueShadingBuilderSurfaceOrientType

New in version NX6.0.0.

License requirements: None.

-------------------------------------

Setter Method

Signature SurfaceOrientEnum

Parameters:surfaceOrientEnum (NXOpen.Display.TrueShadingBuilderSurfaceOrientType) –

New in version NX6.0.0.

License requirements: None.

Method Detail

AssignOverrideMaterial

TrueShadingBuilder.AssignOverrideMaterial

Assigns an overriding material type to one or more selected objects

Signature AssignOverrideMaterial(overrideMaterialType)

Parameters:overrideMaterialType (NXOpen.Display.TrueShadingBuilderMaterialType) – New material type

New in version NX6.0.0.

License requirements: None.

GButton0

TrueShadingBuilder.GButton0

Global material button 1

Signature GButton0()

New in version NX6.0.0.

License requirements: None.

GButton1

TrueShadingBuilder.GButton1

Global material button 2

Signature GButton1()

New in version NX6.0.0.

License requirements: None.

GButton10

TrueShadingBuilder.GButton10

Global material button 11

Signature GButton10()

New in version NX6.0.0.

License requirements: None.

GButton11

TrueShadingBuilder.GButton11

Global material button 12

Signature GButton11()

New in version NX6.0.0.

License requirements: None.

GButton12

TrueShadingBuilder.GButton12

Global material button 13

Signature GButton12()

New in version NX6.0.0.

License requirements: None.

GButton13

TrueShadingBuilder.GButton13

Global material button 14

Signature GButton13()

New in version NX6.0.0.

License requirements: None.

GButton14

TrueShadingBuilder.GButton14

Global material button 15

Signature GButton14()

New in version NX6.0.0.

License requirements: None.

GButton15

TrueShadingBuilder.GButton15

Global material button 16

Signature GButton15()

New in version NX6.0.0.

License requirements: None.

GButton16

TrueShadingBuilder.GButton16

Global material button 17

Signature GButton16()

New in version NX6.0.0.

License requirements: None.

GButton17

TrueShadingBuilder.GButton17

Global material button 18

Signature GButton17()

New in version NX6.0.0.

License requirements: None.

GButton18

TrueShadingBuilder.GButton18

Global material button 19

Signature GButton18()

New in version NX6.0.0.

License requirements: None.

GButton19

TrueShadingBuilder.GButton19

Global material button 20

Signature GButton19()

New in version NX6.0.0.

License requirements: None.

GButton2

TrueShadingBuilder.GButton2

Global material button 3

Signature GButton2()

New in version NX6.0.0.

License requirements: None.

GButton20

TrueShadingBuilder.GButton20

Global material button 21

Signature GButton20()

New in version NX6.0.0.

License requirements: None.

GButton21

TrueShadingBuilder.GButton21

Global material button 22

Signature GButton21()

New in version NX6.0.0.

License requirements: None.

GButton22

TrueShadingBuilder.GButton22

Global material button 23

Signature GButton22()

New in version NX6.0.0.

License requirements: None.

GButton23

TrueShadingBuilder.GButton23

Global material button 24

Signature GButton23()

New in version NX6.0.0.

License requirements: None.

GButton24

TrueShadingBuilder.GButton24

Global material button 25

Signature GButton24()

New in version NX6.0.0.

License requirements: None.

GButton25

TrueShadingBuilder.GButton25

Global material button 26

Signature GButton25()

New in version NX6.0.0.

License requirements: None.

GButton26

TrueShadingBuilder.GButton26

Global material button 27

Signature GButton26()

New in version NX6.0.0.

License requirements: None.

GButton27

TrueShadingBuilder.GButton27

Global material button 28

Signature GButton27()

New in version NX6.0.0.

License requirements: None.

GButton28

TrueShadingBuilder.GButton28

Global material button 29

Signature GButton28()

New in version NX6.0.0.

License requirements: None.

GButton29

TrueShadingBuilder.GButton29

Global material button 30

Signature GButton29()

New in version NX6.0.0.

License requirements: None.

GButton3

TrueShadingBuilder.GButton3

Global material button 4

Signature GButton3()

New in version NX6.0.0.

License requirements: None.

GButton4

TrueShadingBuilder.GButton4

Global material button 5

Signature GButton4()

New in version NX6.0.0.

License requirements: None.

GButton5

TrueShadingBuilder.GButton5

Global material button 6

Signature GButton5()

New in version NX6.0.0.

License requirements: None.

GButton6

TrueShadingBuilder.GButton6

Global material button 7

Signature GButton6()

New in version NX6.0.0.

License requirements: None.

GButton7

TrueShadingBuilder.GButton7

Global material button 8

Signature GButton7()

New in version NX6.0.0.

License requirements: None.

GButton8

TrueShadingBuilder.GButton8

Global material button 9

Signature GButton8()

New in version NX6.0.0.

License requirements: None.

GButton9

TrueShadingBuilder.GButton9

Global material button 10

Signature GButton9()

New in version NX6.0.0.

License requirements: None.

GetBgdBottomRgbcolorPicker

TrueShadingBuilder.GetBgdBottomRgbcolorPicker

Returns the RGB values of background bottom color picker

Signature GetBgdBottomRgbcolorPicker()

Returns:Array of 3 RGB values, each between 0 and 1
Return type:list of float

New in version NX6.0.0.

License requirements: None.

GetBgdTopRgbcolorPicker

TrueShadingBuilder.GetBgdTopRgbcolorPicker

Returns the RGB values of background top color picker

Signature GetBgdTopRgbcolorPicker()

Returns:Array of 3 RGB values, each between 0 and 1
Return type:list of float

New in version NX6.0.0.

License requirements: None.

GetGridRgbcolorPicker

TrueShadingBuilder.GetGridRgbcolorPicker

Returns the grid RGB color values picker

Signature GetGridRgbcolorPicker()

Returns:Array of 3 RGB values, each between 0 and 1
Return type:list of float

New in version NX6.0.0.

License requirements: None.

OButton0

TrueShadingBuilder.OButton0

Per Object override material button 1

Signature OButton0()

New in version NX6.0.0.

License requirements: None.

OButton1

TrueShadingBuilder.OButton1

Per Object override material button 2

Signature OButton1()

New in version NX6.0.0.

License requirements: None.

OButton10

TrueShadingBuilder.OButton10

Per Object override material button 11

Signature OButton10()

New in version NX6.0.0.

License requirements: None.

OButton11

TrueShadingBuilder.OButton11

Per Object override material button 12

Signature OButton11()

New in version NX6.0.0.

License requirements: None.

OButton12

TrueShadingBuilder.OButton12

Per Object override material button 13

Signature OButton12()

New in version NX6.0.0.

License requirements: None.

OButton13

TrueShadingBuilder.OButton13

Per Object override material button 14

Signature OButton13()

New in version NX6.0.0.

License requirements: None.

OButton14

TrueShadingBuilder.OButton14

Per Object override material button 15

Signature OButton14()

New in version NX6.0.0.

License requirements: None.

OButton15

TrueShadingBuilder.OButton15

Per Object override material button 16

Signature OButton15()

New in version NX6.0.0.

License requirements: None.

OButton16

TrueShadingBuilder.OButton16

Per Object override material button 17

Signature OButton16()

New in version NX6.0.0.

License requirements: None.

OButton17

TrueShadingBuilder.OButton17

Per Object override material button 18

Signature OButton17()

New in version NX6.0.0.

License requirements: None.

OButton18

TrueShadingBuilder.OButton18

Per Object override material button 19

Signature OButton18()

New in version NX6.0.0.

License requirements: None.

OButton19

TrueShadingBuilder.OButton19

Per Object override material button 20

Signature OButton19()

New in version NX6.0.0.

License requirements: None.

OButton2

TrueShadingBuilder.OButton2

Per Object override material button 3

Signature OButton2()

New in version NX6.0.0.

License requirements: None.

OButton20

TrueShadingBuilder.OButton20

Per Object override material button 21

Signature OButton20()

New in version NX6.0.0.

License requirements: None.

OButton21

TrueShadingBuilder.OButton21

Per Object override material button 22

Signature OButton21()

New in version NX6.0.0.

License requirements: None.

OButton22

TrueShadingBuilder.OButton22

Per Object override material button 23

Signature OButton22()

New in version NX6.0.0.

License requirements: None.

OButton23

TrueShadingBuilder.OButton23

Per Object override material button 24

Signature OButton23()

New in version NX6.0.0.

License requirements: None.

OButton24

TrueShadingBuilder.OButton24

Per Object override material button 25

Signature OButton24()

New in version NX6.0.0.

License requirements: None.

OButton25

TrueShadingBuilder.OButton25

Per Object override material button 26

Signature OButton25()

New in version NX6.0.0.

License requirements: None.

OButton26

TrueShadingBuilder.OButton26

Per Object override material button 27

Signature OButton26()

New in version NX6.0.0.

License requirements: None.

OButton27

TrueShadingBuilder.OButton27

Per Object override material button 28

Signature OButton27()

New in version NX6.0.0.

License requirements: None.

OButton28

TrueShadingBuilder.OButton28

Per Object override material button 29

Signature OButton28()

New in version NX6.0.0.

License requirements: None.

OButton3

TrueShadingBuilder.OButton3

Per Object override material button 4

Signature OButton3()

New in version NX6.0.0.

License requirements: None.

OButton4

TrueShadingBuilder.OButton4

Per Object override material button 5

Signature OButton4()

New in version NX6.0.0.

License requirements: None.

OButton5

TrueShadingBuilder.OButton5

Per Object override material button 6

Signature OButton5()

New in version NX6.0.0.

License requirements: None.

OButton6

TrueShadingBuilder.OButton6

Per Object override material button 7

Signature OButton6()

New in version NX6.0.0.

License requirements: None.

OButton7

TrueShadingBuilder.OButton7

Per Object override material button 8

Signature OButton7()

New in version NX6.0.0.

License requirements: None.

OButton8

TrueShadingBuilder.OButton8

Per Object override material button 9

Signature OButton8()

New in version NX6.0.0.

License requirements: None.

OButton9

TrueShadingBuilder.OButton9

Per Object override material button 10

Signature OButton9()

New in version NX6.0.0.

License requirements: None.

ORemoveButton

TrueShadingBuilder.ORemoveButton

Removes override material from selected object(s)

Signature ORemoveButton()

New in version NX6.0.0.

License requirements: None.

ProtectUpdate

TrueShadingBuilder.ProtectUpdate

Protects update

Signature ProtectUpdate()

New in version NX6.0.0.

License requirements: None.

SetBgdBottomRgbcolorPicker

TrueShadingBuilder.SetBgdBottomRgbcolorPicker

Sets the RGB values of background bottom color picker

Signature SetBgdBottomRgbcolorPicker(bgdBottomRGBColorPicker)

Parameters:bgdBottomRGBColorPicker (list of float) – Array of 3 RGB values, each between 0 and 1

New in version NX6.0.0.

License requirements: None.

SetBgdTopRgbcolorPicker

TrueShadingBuilder.SetBgdTopRgbcolorPicker

Sets the RGB values of background top color picker

Signature SetBgdTopRgbcolorPicker(bgdTopRGBColorPicker)

Parameters:bgdTopRGBColorPicker (list of float) – Array of 3 RGB values, each between 0 and 1

New in version NX6.0.0.

License requirements: None.

SetGridRgbcolorPicker

TrueShadingBuilder.SetGridRgbcolorPicker

Sets the grid RGB color picker

Signature SetGridRgbcolorPicker(gridRGBColorPicker)

Parameters:gridRGBColorPicker (list of float) – Array of 3 RGB values, each between 0 and 1

New in version NX6.0.0.

License requirements: None.

Validate

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