Represents a Display::TrueShading builder
To create a new instance of this class, use Display::TrueShadingCollection::CreateTrueShadingBuilder

Created in NX6.0.0. More...

Inheritance diagram for NXOpen::Display::TrueShadingBuilder:

Public Types
enum	BgdImageType { BgdImageTypeImage1, BgdImageTypeImage2, BgdImageTypeImage3, BgdImageTypeImage4, BgdImageTypeImage5, BgdImageTypeImage6, BgdImageTypeCustomImage }
	Background image types. More...

enum	BgdType { BgdTypeDarkGraduated, BgdTypeLightGraduated, BgdTypeBlack, BgdTypeWhite, BgdTypeCustomPlain, BgdTypeCustomGraduated, BgdTypeInheritShadedBackground, BgdTypeImageBackground }
	Background colors and image types. More...

enum	EnvironmentMapType { EnvironmentMapTypeDefault, EnvironmentMapTypeMetalShiny1, EnvironmentMapTypeMetalShiny2, EnvironmentMapTypeMetalBrushed1, EnvironmentMapTypeMetalBrushed2, EnvironmentMapTypeGlossy1, EnvironmentMapTypeGlossy2, EnvironmentMapTypeSurfaceAnalysisLines, EnvironmentMapTypeSurfaceAnalysisHorizon, EnvironmentMapTypeAutoPhotoStudio, EnvironmentMapTypeCustomImage }
	Global environment reflection map types. More...

enum	MaterialType { MaterialTypeGlobalWashShinyMetal, MaterialTypeGlobalWashBrushedMetal, MaterialTypeGlobalWashShinyPlastic, MaterialTypeGlobalWashAnalysis, MaterialTypeGlobalWashFlat, MaterialTypeGlobalRedGlossyPlastic, MaterialTypeGlobalBlueGlossyPlastic, MaterialTypeGlobalGreenGlossyPlastic, MaterialTypeGlobalGrayGlossyPlastic, MaterialTypeGlobalBlackGlossyPlastic, MaterialTypeGlobalBrownGlossyPlastic, MaterialTypeGlobalYellowGlossyPlastic, MaterialTypeGlobalTealGlossyPlastic, MaterialTypeGlobalWhiteGlossyPlastic, MaterialTypeGlobalClearPlastic, MaterialTypeGlobalChrome, MaterialTypeGlobalCopper, MaterialTypeGlobalGold, MaterialTypeGlobalBrass, MaterialTypeGlobalSteel, MaterialTypeGlobalBrushedChrome, MaterialTypeGlobalBrushedAluminum, MaterialTypeGlobalBrushedTitanium, MaterialTypeGlobalGlassClear, MaterialTypeGlobalGlassSmokey, MaterialTypeGlobalMetallicPaintRed, MaterialTypeGlobalMetallicPaintGray, MaterialTypeGlobalMetallicPaintBlack, MaterialTypeGlobalMetallicPaintBlue, MaterialTypeGlobalRubber, MaterialTypeOverrideRedGlossyPlastic, MaterialTypeOverrideBlueGlossyPlastic, MaterialTypeOverrideGreenGlossyPlastic, MaterialTypeOverrideGrayGlossyPlastic, MaterialTypeOverrideBlackGlossyPlastic, MaterialTypeOverrideBrownGlossyPlastic, MaterialTypeOverrideYellowGlossyPlastic, MaterialTypeOverrideTealGlossyPlastic, MaterialTypeOverrideWhiteGlossyPlastic, MaterialTypeOverrideClearPlastic, MaterialTypeOverrideChrome, MaterialTypeOverrideCopper, MaterialTypeOverrideGold, MaterialTypeOverrideBrass, MaterialTypeOverrideSteel, MaterialTypeOverrideBrushedChrome, MaterialTypeOverrideBrushedAluminum, MaterialTypeOverrideBrushedTitanium, MaterialTypeOverrideGlassClear, MaterialTypeOverrideGlassSmokey, MaterialTypeOverrideMetallicPaintRed, MaterialTypeOverrideMetallicPaintGray, MaterialTypeOverrideMetallicPaintBlack, MaterialTypeOverrideMetallicPaintBlue, MaterialTypeOverrideRubber, MaterialTypeOverrideRoughMetalMedGray, MaterialTypeOverrideRoughMetalDkGray, MaterialTypeOverrideRoughPlasticBlueGray, MaterialTypeOverrideRoughPlasticTan }
	Global material and per object overriding material types. More...

enum	SHEDLightCollectionType { SHEDLightCollectionTypeDefaultLights, SHEDLightCollectionTypeLighting1, SHEDLightCollectionTypeLighting2, SHEDLightCollectionTypeLighting3, SHEDLightCollectionTypeLighting4, SHEDLightCollectionTypeCustom }
	Scene lighting collection types. More...

enum	SurfaceOrientType { SurfaceOrientTypeNone, SurfaceOrientTypeBottom, SurfaceOrientTypeBack, SurfaceOrientTypeBottomFixed }
	Shadow plane projection orientation types. More...

Public Member Functions
void	AssignOverrideMaterial (NXOpen::Display::TrueShadingBuilder::MaterialType overrideMaterialType)
	Assigns an overriding material type to one or more selected objects Created in NX6.0.0.

NXOpen::Display::TrueShadingBuilder::BgdImageType	BgdImageEnum ()
	Returns the background image list enum Created in NX6.0.0.

NXString	BgdImageFileBrowser ()
	Returns the background image filename Created in NX6.0.0.

NXOpen::Display::TrueShadingBuilder::BgdType	BgdTypeEnum ()
	Returns the background color or background image type enum Created in NX6.0.0.

NXOpen::Display::TrueShadingBuilder::EnvironmentMapType	EnvironmentMapEnum ()
	Returns the reflection environment map enum type Created in NX6.0.0.

NXString	EnvironmentMapFileBrowser ()
	Returns the reflection environment map filename Created in NX6.0.0.

void	GButton0 ()
	Global material button 1 Created in NX6.0.0.

void	GButton1 ()
	Global material button 2 Created in NX6.0.0.

void	GButton10 ()
	Global material button 11 Created in NX6.0.0.

void	GButton11 ()
	Global material button 12 Created in NX6.0.0.

void	GButton12 ()
	Global material button 13 Created in NX6.0.0.

void	GButton13 ()
	Global material button 14 Created in NX6.0.0.

void	GButton14 ()
	Global material button 15 Created in NX6.0.0.

void	GButton15 ()
	Global material button 16 Created in NX6.0.0.

void	GButton16 ()
	Global material button 17 Created in NX6.0.0.

void	GButton17 ()
	Global material button 18 Created in NX6.0.0.

void	GButton18 ()
	Global material button 19 Created in NX6.0.0.

void	GButton19 ()
	Global material button 20 Created in NX6.0.0.

void	GButton2 ()
	Global material button 3 Created in NX6.0.0.

void	GButton20 ()
	Global material button 21 Created in NX6.0.0.

void	GButton21 ()
	Global material button 22 Created in NX6.0.0.

void	GButton22 ()
	Global material button 23 Created in NX6.0.0.

void	GButton23 ()
	Global material button 24 Created in NX6.0.0.

void	GButton24 ()
	Global material button 25 Created in NX6.0.0.

void	GButton25 ()
	Global material button 26 Created in NX6.0.0.

void	GButton26 ()
	Global material button 27 Created in NX6.0.0.

void	GButton27 ()
	Global material button 28 Created in NX6.0.0.

void	GButton28 ()
	Global material button 29 Created in NX6.0.0.

void	GButton29 ()
	Global material button 30 Created in NX6.0.0.

void	GButton3 ()
	Global material button 4 Created in NX6.0.0.

void	GButton4 ()
	Global material button 5 Created in NX6.0.0.

void	GButton5 ()
	Global material button 6 Created in NX6.0.0.

void	GButton6 ()
	Global material button 7 Created in NX6.0.0.

void	GButton7 ()
	Global material button 8 Created in NX6.0.0.

void	GButton8 ()
	Global material button 9 Created in NX6.0.0.

void	GButton9 ()
	Global material button 10 Created in NX6.0.0.

std::vector< double >	GetBgdBottomRgbcolorPicker ()
	Returns the RGB values of background bottom color picker.

std::vector< double >	GetBgdTopRgbcolorPicker ()
	Returns the RGB values of background top color picker.

std::vector< double >	GetGridRgbcolorPicker ()
	Returns the grid RGB color values picker.

NXOpen::Display::TrueShadingBuilder::MaterialType	GlobalMaterialType ()
	Returns the globalMaterialType Created in NX6.0.0.

bool	InheritModelTogggle ()
	Returns the shadow plane grid to inherit Model grid attributes toggle Created in NX6.0.0.

NXOpen::Display::TrueShadingBuilder::SHEDLightCollectionType	LightCollectionEnum ()
	Returns the light collection enum Created in NX6.0.0.

double	LightDimmerValue ()
	Returns the light dimmer value Created in NX6.0.0.

NXOpen::SelectNXObjectList *	ObjSpecificSelection ()
	Returns the selected object(s) list Created in NX6.0.0.

void	OButton0 ()
	Per Object override material button 1 Created in NX6.0.0.

void	OButton1 ()
	Per Object override material button 2 Created in NX6.0.0.

void	OButton10 ()
	Per Object override material button 11 Created in NX6.0.0.

void	OButton11 ()
	Per Object override material button 12 Created in NX6.0.0.

void	OButton12 ()
	Per Object override material button 13 Created in NX6.0.0.

void	OButton13 ()
	Per Object override material button 14 Created in NX6.0.0.

void	OButton14 ()
	Per Object override material button 15 Created in NX6.0.0.

void	OButton15 ()
	Per Object override material button 16 Created in NX6.0.0.

void	OButton16 ()
	Per Object override material button 17 Created in NX6.0.0.

void	OButton17 ()
	Per Object override material button 18 Created in NX6.0.0.

void	OButton18 ()
	Per Object override material button 19 Created in NX6.0.0.

void	OButton19 ()
	Per Object override material button 20 Created in NX6.0.0.

void	OButton2 ()
	Per Object override material button 3 Created in NX6.0.0.

void	OButton20 ()
	Per Object override material button 21 Created in NX6.0.0.

void	OButton21 ()
	Per Object override material button 22 Created in NX6.0.0.

void	OButton22 ()
	Per Object override material button 23 Created in NX6.0.0.

void	OButton23 ()
	Per Object override material button 24 Created in NX6.0.0.

void	OButton24 ()
	Per Object override material button 25 Created in NX6.0.0.

void	OButton25 ()
	Per Object override material button 26 Created in NX6.0.0.

void	OButton26 ()
	Per Object override material button 27 Created in NX6.0.0.

void	OButton27 ()
	Per Object override material button 28 Created in NX6.0.0.

void	OButton28 ()
	Per Object override material button 29 Created in NX6.0.0.

void	OButton3 ()
	Per Object override material button 4 Created in NX6.0.0.

void	OButton4 ()
	Per Object override material button 5 Created in NX6.0.0.

void	OButton5 ()
	Per Object override material button 6 Created in NX6.0.0.

void	OButton6 ()
	Per Object override material button 7 Created in NX6.0.0.

void	OButton7 ()
	Per Object override material button 8 Created in NX6.0.0.

void	OButton8 ()
	Per Object override material button 9 Created in NX6.0.0.

void	OButton9 ()
	Per Object override material button 10 Created in NX6.0.0.

void	ORemoveButton ()
	Removes override material from selected object(s) Created in NX6.0.0.

bool	PlanarReflectionToggle ()
	Returns the planar reflection visibility toggle Created in NX6.0.0.

bool	PlanarShadowToggle ()
	Returns the planar shadow visibility toggle Created in NX6.0.0.

bool	PlaneGridToggle ()
	Returns the shadow plane grid visibility toggle Created in NX6.0.0.

bool	PlaneOffsetFixedToggle ()
	Returns the shadow plane with fixed offset toggle Created in NX6.0.0.

double	PlaneOffsetValue ()
	Returns the offset distance between the shadow plane and the nearest vertex of the displayed object Created in NX6.0.0.

void	ProtectUpdate ()
	Protects update Created in NX6.0.0.

double	ReflectivityValue ()
	Returns the reflectivity value Created in NX6.0.0.

void	SetBgdBottomRgbcolorPicker (const std::vector< double > &bgdBottomRGBColorPicker)
	Sets the RGB values of background bottom color picker Created in NX6.0.0.

void	SetBgdImageEnum (NXOpen::Display::TrueShadingBuilder::BgdImageType bgdImageEnum)
	Sets the background image list enum Created in NX6.0.0.

void	SetBgdImageFileBrowser (const NXString &filename)
	Sets the background image filename Created in NX6.0.0.

void	SetBgdImageFileBrowser (const char *filename)
	Sets the background image filename Created in NX6.0.0.

void	SetBgdTopRgbcolorPicker (const std::vector< double > &bgdTopRGBColorPicker)
	Sets the RGB values of background top color picker Created in NX6.0.0.

void	SetBgdTypeEnum (NXOpen::Display::TrueShadingBuilder::BgdType bgdTypeEnum)
	Sets the background color or background image type enum Created in NX6.0.0.

void	SetEnvironmentMapEnum (NXOpen::Display::TrueShadingBuilder::EnvironmentMapType environmentMapEnum)
	Sets the reflection environment map enum type Created in NX6.0.0.

void	SetEnvironmentMapFileBrowser (const NXString &filename)
	Sets the reflection environment map filename Created in NX6.0.0.

void	SetEnvironmentMapFileBrowser (const char *filename)
	Sets the reflection environment map filename Created in NX6.0.0.

void	SetGlobalMaterialType (NXOpen::Display::TrueShadingBuilder::MaterialType globalMaterialType)
	Sets the globalMaterialType Created in NX6.0.0.

void	SetGridRgbcolorPicker (const std::vector< double > &gridRGBColorPicker)
	Sets the grid RGB color picker Created in NX6.0.0.

void	SetInheritModelTogggle (bool inheritModelTogggle)
	Sets the shadow plane grid to inherit Model grid attributes toggle Created in NX6.0.0.

void	SetLightCollectionEnum (NXOpen::Display::TrueShadingBuilder::SHEDLightCollectionType lightCollectionEnum)
	Sets the light collection enum Created in NX6.0.0.

void	SetLightDimmerValue (double lightDimmerValue)
	Sets the light dimmer value Created in NX6.0.0.

void	SetPlanarReflectionToggle (bool planarReflectionToggle)
	Sets the planar reflection visibility toggle Created in NX6.0.0.

void	SetPlanarShadowToggle (bool planarShadowToggle)
	Sets the planar shadow visibility toggle Created in NX6.0.0.

void	SetPlaneGridToggle (bool planeGridToggle)
	Sets the shadow plane grid visibility toggle Created in NX6.0.0.

void	SetPlaneOffsetFixedToggle (bool planeOffsetFixedToggle)
	Sets the shadow plane with fixed offset toggle Created in NX6.0.0.

void	SetPlaneOffsetValue (double planeOffsetValue)
	Sets the offset distance between the shadow plane and the nearest vertex of the displayed object Created in NX6.0.0.

void	SetReflectivityValue (double reflectivityValue)
	Sets the reflectivity value Created in NX6.0.0.

void	SetShedModeToggle (bool shedModeToggle)
	Sets the True Shading display toggle state Created in NX6.0.0.

void	SetSnapFloorToggle (bool snapFloorToggle)
	Sets the toggle forces the shadow plane to snap to the nearest object vertex Created in NX6.0.0.

void	SetSoftShadowsToggle (bool softShadowsToggle)
	Sets the soft shadows toggle Created in NX6.0.0.

void	SetSpecifyPlane (NXOpen::Plane *specifyPlane)
	Sets the custom plane definition for the shadow projection Created in NX6.0.0.

void	SetSurfaceOrientEnum (NXOpen::Display::TrueShadingBuilder::SurfaceOrientType surfaceOrientEnum)
	Sets the shadow plane surface orientation enum Created in NX6.0.0.

bool	ShedModeToggle ()
	Returns the True Shading display toggle state Created in NX6.0.0.

bool	SnapFloorToggle ()
	Returns the toggle forces the shadow plane to snap to the nearest object vertex Created in NX6.0.0.

bool	SoftShadowsToggle ()
	Returns the soft shadows toggle Created in NX6.0.0.

NXOpen::Plane *	SpecifyPlane ()
	Returns the custom plane definition for the shadow projection Created in NX6.0.0.

NXOpen::Display::TrueShadingBuilder::SurfaceOrientType	SurfaceOrientEnum ()
	Returns the shadow plane surface orientation enum Created in NX6.0.0.

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

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

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

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

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

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

Public Member Functions inherited from NXOpen::TaggedObject
tag_t	GetTag () const
	<b>Deprecated</b>:<br> Use Tag instead.

tag_t	Tag () const
	Returns the tag of this object.

Detailed Description

Represents a Display::TrueShading builder
To create a new instance of this class, use Display::TrueShadingCollection::CreateTrueShadingBuilder

Created in NX6.0.0.

Member Enumeration Documentation

enum NXOpen::Display::TrueShadingBuilder::BgdImageType

Background image types.

Enumerator:

BgdImageTypeImage1	Predefined image 1 background.
BgdImageTypeImage2	Predefined image 2 background.
BgdImageTypeImage3	Predefined image 3 background.
BgdImageTypeImage4	Predefined image 4 background.
BgdImageTypeImage5	Predefined image 5 background.
BgdImageTypeImage6	Predefined image 6 background.
BgdImageTypeCustomImage	Custom image background.

enum NXOpen::Display::TrueShadingBuilder::BgdType

Background colors and image types.

Enumerator:

BgdTypeDarkGraduated	Graduated dark colored background.
BgdTypeLightGraduated	Graduated light colored background.
BgdTypeBlack	Plain dark Colored background.
BgdTypeWhite	Plain light Colored background.
BgdTypeCustomPlain	Customized plain colored background.
BgdTypeCustomGraduated	Customized graduated colored background.
BgdTypeInheritShadedBackground	Use same background color as in shaded display mode.
BgdTypeImageBackground	Use one of the predefined images as background.

enum NXOpen::Display::TrueShadingBuilder::EnvironmentMapType

Global environment reflection map types.

Enumerator:

EnvironmentMapTypeDefault	No reflection map.
EnvironmentMapTypeMetalShiny1	Shiny Metal Reflection 1.
EnvironmentMapTypeMetalShiny2	Shiny Metal Reflection 2.
EnvironmentMapTypeMetalBrushed1	Brushed Metal Reflection 1.
EnvironmentMapTypeMetalBrushed2	Brushed Metal Reflection 2.
EnvironmentMapTypeGlossy1	Glossy Reflection 1.
EnvironmentMapTypeGlossy2	Glossy Reflection 2.
EnvironmentMapTypeSurfaceAnalysisLines	Surface Analysis Lines Reflection.
EnvironmentMapTypeSurfaceAnalysisHorizon	Surface Analysis Horizontal Lines Reflection.
EnvironmentMapTypeAutoPhotoStudio	Automotive Lighting Reflection.
EnvironmentMapTypeCustomImage	Custom Image Reflection.

enum NXOpen::Display::TrueShadingBuilder::MaterialType

Global material and per object overriding material types.

Enumerator:

MaterialTypeGlobalWashShinyMetal	Shiny Metal Wash.
MaterialTypeGlobalWashBrushedMetal	Brushed Metal Wash.
MaterialTypeGlobalWashShinyPlastic	Shiny Plastic Wash.
MaterialTypeGlobalWashAnalysis	Surface Analysis Wash.
MaterialTypeGlobalWashFlat	Low Sheen Plastic Wash.
MaterialTypeGlobalRedGlossyPlastic	Red Glossy Plastic.
MaterialTypeGlobalBlueGlossyPlastic	Blue Glossy Plastic.
MaterialTypeGlobalGreenGlossyPlastic	Green Glossy Plastic.
MaterialTypeGlobalGrayGlossyPlastic	Gray Glossy Plastic.
MaterialTypeGlobalBlackGlossyPlastic	Black Glossy Plastic.
MaterialTypeGlobalBrownGlossyPlastic	Brown Glossy Plastic.
MaterialTypeGlobalYellowGlossyPlastic	Yellow Glossy Plastic.
MaterialTypeGlobalTealGlossyPlastic	Teal Glossy Plastic.
MaterialTypeGlobalWhiteGlossyPlastic	White Glossy Plastic.
MaterialTypeGlobalClearPlastic	Clear Plastic.
MaterialTypeGlobalChrome	Chrome.
MaterialTypeGlobalCopper	Copper.
MaterialTypeGlobalGold	Gold.
MaterialTypeGlobalBrass	Brass.
MaterialTypeGlobalSteel	Steel.
MaterialTypeGlobalBrushedChrome	Brushed Chrome.
MaterialTypeGlobalBrushedAluminum	Brushed Aluminum.
MaterialTypeGlobalBrushedTitanium	Brushed Titanium.
MaterialTypeGlobalGlassClear	Clear Glass.
MaterialTypeGlobalGlassSmokey	Smokey Glass.
MaterialTypeGlobalMetallicPaintRed	Red Metallic Paint.
MaterialTypeGlobalMetallicPaintGray	Gray Metallic Paint.
MaterialTypeGlobalMetallicPaintBlack	Black Metallic Paint.
MaterialTypeGlobalMetallicPaintBlue	Blue Metallic Paint.
MaterialTypeGlobalRubber	Black Rubber.
MaterialTypeOverrideRedGlossyPlastic	Red Glossy Plastic.
MaterialTypeOverrideBlueGlossyPlastic	Blue Glossy Plastic.
MaterialTypeOverrideGreenGlossyPlastic	Green Glossy Plastic.
MaterialTypeOverrideGrayGlossyPlastic	Gray Glossy Plastic.
MaterialTypeOverrideBlackGlossyPlastic	Black Glossy Plastic.
MaterialTypeOverrideBrownGlossyPlastic	Brown Glossy Plastic.
MaterialTypeOverrideYellowGlossyPlastic	Yellow Glossy Plastic.
MaterialTypeOverrideTealGlossyPlastic	Teal Glossy Plastic.
MaterialTypeOverrideWhiteGlossyPlastic	White Glossy Plastic.
MaterialTypeOverrideClearPlastic	Clear Plastic.
MaterialTypeOverrideChrome	Chrome.
MaterialTypeOverrideCopper	Copper.
MaterialTypeOverrideGold	Gold.
MaterialTypeOverrideBrass	Brass.
MaterialTypeOverrideSteel	Steel.
MaterialTypeOverrideBrushedChrome	Brushed Chrome.
MaterialTypeOverrideBrushedAluminum	Brushed Aluminum.
MaterialTypeOverrideBrushedTitanium	Brushed Titanium.
MaterialTypeOverrideGlassClear	Clear Glass.
MaterialTypeOverrideGlassSmokey	Smokey Glass.
MaterialTypeOverrideMetallicPaintRed	Red Metallic Paint.
MaterialTypeOverrideMetallicPaintGray	Gray Metallic Paint.
MaterialTypeOverrideMetallicPaintBlack	Black Metallic Paint.
MaterialTypeOverrideMetallicPaintBlue	Blue Metallic Paint.
MaterialTypeOverrideRubber	Black Rubber.
MaterialTypeOverrideRoughMetalMedGray	Medium Grey Texture.
MaterialTypeOverrideRoughMetalDkGray	Dark Grey Texture.
MaterialTypeOverrideRoughPlasticBlueGray	Blue Grey Texture.
MaterialTypeOverrideRoughPlasticTan	Tan Texture.

enum NXOpen::Display::TrueShadingBuilder::SHEDLightCollectionType

Scene lighting collection types.

Enumerator:

SHEDLightCollectionTypeDefaultLights	Scene lighting collection 1.
SHEDLightCollectionTypeLighting1	Scene lighting collection 2.
SHEDLightCollectionTypeLighting2	Scene lighting collection 3.
SHEDLightCollectionTypeLighting3	Scene lighting collection 4.
SHEDLightCollectionTypeLighting4	Scene lighting collection 5.
SHEDLightCollectionTypeCustom	Custom lighting configuration.

enum NXOpen::Display::TrueShadingBuilder::SurfaceOrientType

Shadow plane projection orientation types.

Enumerator:

SurfaceOrientTypeNone	Do not project shadows.
SurfaceOrientTypeBottom	Project shadows onto the floor.
SurfaceOrientTypeBack	Project shadows onto the back wall.
SurfaceOrientTypeBottomFixed	Project shadows onto a fixed oriented floor.

Member Function Documentation

void NXOpen::Display::TrueShadingBuilder::AssignOverrideMaterial ( NXOpen::Display::TrueShadingBuilder::MaterialType overrideMaterialType )

Assigns an overriding material type to one or more selected objects
Created in NX6.0.0.

License requirements : None

Parameters

overrideMaterialType New material type

NXOpen::Display::TrueShadingBuilder::BgdImageType NXOpen::Display::TrueShadingBuilder::BgdImageEnum ( )

Returns the background image list enum
Created in NX6.0.0.

License requirements : None

NXString NXOpen::Display::TrueShadingBuilder::BgdImageFileBrowser ( )

Returns the background image filename
Created in NX6.0.0.

License requirements : None

NXOpen::Display::TrueShadingBuilder::BgdType NXOpen::Display::TrueShadingBuilder::BgdTypeEnum ( )

Returns the background color or background image type enum
Created in NX6.0.0.

License requirements : None

NXOpen::Display::TrueShadingBuilder::EnvironmentMapType NXOpen::Display::TrueShadingBuilder::EnvironmentMapEnum ( )

Returns the reflection environment map enum type
Created in NX6.0.0.

License requirements : None

NXString NXOpen::Display::TrueShadingBuilder::EnvironmentMapFileBrowser ( )

Returns the reflection environment map filename
Created in NX6.0.0.

License requirements : None

void NXOpen::Display::TrueShadingBuilder::GButton0 ( )

Global material button 1
Created in NX6.0.0.

License requirements : None

void NXOpen::Display::TrueShadingBuilder::GButton1 ( )

Global material button 2
Created in NX6.0.0.

License requirements : None

void NXOpen::Display::TrueShadingBuilder::GButton10 ( )

Global material button 11
Created in NX6.0.0.

License requirements : None

void NXOpen::Display::TrueShadingBuilder::GButton11 ( )

Global material button 12
Created in NX6.0.0.

License requirements : None

void NXOpen::Display::TrueShadingBuilder::GButton12 ( )

Global material button 13
Created in NX6.0.0.

License requirements : None

void NXOpen::Display::TrueShadingBuilder::GButton13 ( )

Global material button 14
Created in NX6.0.0.

License requirements : None

void NXOpen::Display::TrueShadingBuilder::GButton14 ( )

Global material button 15
Created in NX6.0.0.

License requirements : None

void NXOpen::Display::TrueShadingBuilder::GButton15 ( )

Global material button 16
Created in NX6.0.0.

License requirements : None

void NXOpen::Display::TrueShadingBuilder::GButton16 ( )

Global material button 17
Created in NX6.0.0.

License requirements : None

void NXOpen::Display::TrueShadingBuilder::GButton17 ( )

Global material button 18
Created in NX6.0.0.

License requirements : None

void NXOpen::Display::TrueShadingBuilder::GButton18 ( )

Global material button 19
Created in NX6.0.0.

License requirements : None

void NXOpen::Display::TrueShadingBuilder::GButton19 ( )

Global material button 20
Created in NX6.0.0.

License requirements : None

void NXOpen::Display::TrueShadingBuilder::GButton2 ( )

Global material button 3
Created in NX6.0.0.

License requirements : None

void NXOpen::Display::TrueShadingBuilder::GButton20 ( )

Global material button 21
Created in NX6.0.0.

License requirements : None

void NXOpen::Display::TrueShadingBuilder::GButton21 ( )

Global material button 22
Created in NX6.0.0.

License requirements : None

void NXOpen::Display::TrueShadingBuilder::GButton22 ( )

Global material button 23
Created in NX6.0.0.

License requirements : None

void NXOpen::Display::TrueShadingBuilder::GButton23 ( )

Global material button 24
Created in NX6.0.0.

License requirements : None

void NXOpen::Display::TrueShadingBuilder::GButton24 ( )

Global material button 25
Created in NX6.0.0.

License requirements : None

void NXOpen::Display::TrueShadingBuilder::GButton25 ( )

Global material button 26
Created in NX6.0.0.

License requirements : None

void NXOpen::Display::TrueShadingBuilder::GButton26 ( )

Global material button 27
Created in NX6.0.0.

License requirements : None

void NXOpen::Display::TrueShadingBuilder::GButton27 ( )

Global material button 28
Created in NX6.0.0.

License requirements : None

void NXOpen::Display::TrueShadingBuilder::GButton28 ( )

Global material button 29
Created in NX6.0.0.

License requirements : None

void NXOpen::Display::TrueShadingBuilder::GButton29 ( )

Global material button 30
Created in NX6.0.0.

License requirements : None

void NXOpen::Display::TrueShadingBuilder::GButton3 ( )

Global material button 4
Created in NX6.0.0.

License requirements : None

void NXOpen::Display::TrueShadingBuilder::GButton4 ( )

Global material button 5
Created in NX6.0.0.

License requirements : None

void NXOpen::Display::TrueShadingBuilder::GButton5 ( )

Global material button 6
Created in NX6.0.0.

License requirements : None

void NXOpen::Display::TrueShadingBuilder::GButton6 ( )

Global material button 7
Created in NX6.0.0.

License requirements : None

void NXOpen::Display::TrueShadingBuilder::GButton7 ( )

Global material button 8
Created in NX6.0.0.

License requirements : None

void NXOpen::Display::TrueShadingBuilder::GButton8 ( )

Global material button 9
Created in NX6.0.0.

License requirements : None

void NXOpen::Display::TrueShadingBuilder::GButton9 ( )

Global material button 10
Created in NX6.0.0.

License requirements : None

std::vector<double> NXOpen::Display::TrueShadingBuilder::GetBgdBottomRgbcolorPicker ( )

Returns the RGB values of background bottom color picker.

Returns: Array of 3 RGB values, each between 0 and 1
Created in NX6.0.0.

License requirements : None

std::vector<double> NXOpen::Display::TrueShadingBuilder::GetBgdTopRgbcolorPicker ( )

Returns the RGB values of background top color picker.

Returns: Array of 3 RGB values, each between 0 and 1
Created in NX6.0.0.

License requirements : None

std::vector<double> NXOpen::Display::TrueShadingBuilder::GetGridRgbcolorPicker ( )

Returns the grid RGB color values picker.

Returns: Array of 3 RGB values, each between 0 and 1
Created in NX6.0.0.

License requirements : None

NXOpen::Display::TrueShadingBuilder::MaterialType NXOpen::Display::TrueShadingBuilder::GlobalMaterialType ( )

Returns the globalMaterialType
Created in NX6.0.0.

License requirements : None

bool NXOpen::Display::TrueShadingBuilder::InheritModelTogggle ( )

Returns the shadow plane grid to inherit Model grid attributes toggle
Created in NX6.0.0.

License requirements : None

NXOpen::Display::TrueShadingBuilder::SHEDLightCollectionType NXOpen::Display::TrueShadingBuilder::LightCollectionEnum ( )

Returns the light collection enum
Created in NX6.0.0.

License requirements : None

double NXOpen::Display::TrueShadingBuilder::LightDimmerValue ( )

Returns the light dimmer value
Created in NX6.0.0.

License requirements : None

NXOpen::SelectNXObjectList* NXOpen::Display::TrueShadingBuilder::ObjSpecificSelection ( )

Returns the selected object(s) list
Created in NX6.0.0.

License requirements : None

void NXOpen::Display::TrueShadingBuilder::OButton0 ( )

Per Object override material button 1
Created in NX6.0.0.

License requirements : None

void NXOpen::Display::TrueShadingBuilder::OButton1 ( )

Per Object override material button 2
Created in NX6.0.0.

License requirements : None

void NXOpen::Display::TrueShadingBuilder::OButton10 ( )

Per Object override material button 11
Created in NX6.0.0.

License requirements : None

void NXOpen::Display::TrueShadingBuilder::OButton11 ( )

Per Object override material button 12
Created in NX6.0.0.

License requirements : None

void NXOpen::Display::TrueShadingBuilder::OButton12 ( )

Per Object override material button 13
Created in NX6.0.0.

License requirements : None

void NXOpen::Display::TrueShadingBuilder::OButton13 ( )

Per Object override material button 14
Created in NX6.0.0.

License requirements : None

void NXOpen::Display::TrueShadingBuilder::OButton14 ( )

Per Object override material button 15
Created in NX6.0.0.

License requirements : None

void NXOpen::Display::TrueShadingBuilder::OButton15 ( )

Per Object override material button 16
Created in NX6.0.0.

License requirements : None

void NXOpen::Display::TrueShadingBuilder::OButton16 ( )

Per Object override material button 17
Created in NX6.0.0.

License requirements : None

void NXOpen::Display::TrueShadingBuilder::OButton17 ( )

Per Object override material button 18
Created in NX6.0.0.

License requirements : None

void NXOpen::Display::TrueShadingBuilder::OButton18 ( )

Per Object override material button 19
Created in NX6.0.0.

License requirements : None

void NXOpen::Display::TrueShadingBuilder::OButton19 ( )

Per Object override material button 20
Created in NX6.0.0.

License requirements : None

void NXOpen::Display::TrueShadingBuilder::OButton2 ( )

Per Object override material button 3
Created in NX6.0.0.

License requirements : None

void NXOpen::Display::TrueShadingBuilder::OButton20 ( )

Per Object override material button 21
Created in NX6.0.0.

License requirements : None

void NXOpen::Display::TrueShadingBuilder::OButton21 ( )

Per Object override material button 22
Created in NX6.0.0.

License requirements : None

void NXOpen::Display::TrueShadingBuilder::OButton22 ( )

Per Object override material button 23
Created in NX6.0.0.

License requirements : None

void NXOpen::Display::TrueShadingBuilder::OButton23 ( )

Per Object override material button 24
Created in NX6.0.0.

License requirements : None

void NXOpen::Display::TrueShadingBuilder::OButton24 ( )

Per Object override material button 25
Created in NX6.0.0.

License requirements : None

void NXOpen::Display::TrueShadingBuilder::OButton25 ( )

Per Object override material button 26
Created in NX6.0.0.

License requirements : None

void NXOpen::Display::TrueShadingBuilder::OButton26 ( )

Per Object override material button 27
Created in NX6.0.0.

License requirements : None

void NXOpen::Display::TrueShadingBuilder::OButton27 ( )

Per Object override material button 28
Created in NX6.0.0.

License requirements : None

void NXOpen::Display::TrueShadingBuilder::OButton28 ( )

Per Object override material button 29
Created in NX6.0.0.

License requirements : None

void NXOpen::Display::TrueShadingBuilder::OButton3 ( )

Per Object override material button 4
Created in NX6.0.0.

License requirements : None

void NXOpen::Display::TrueShadingBuilder::OButton4 ( )

Per Object override material button 5
Created in NX6.0.0.

License requirements : None

void NXOpen::Display::TrueShadingBuilder::OButton5 ( )

Per Object override material button 6
Created in NX6.0.0.

License requirements : None

void NXOpen::Display::TrueShadingBuilder::OButton6 ( )

Per Object override material button 7
Created in NX6.0.0.

License requirements : None

void NXOpen::Display::TrueShadingBuilder::OButton7 ( )

Per Object override material button 8
Created in NX6.0.0.

License requirements : None

void NXOpen::Display::TrueShadingBuilder::OButton8 ( )

Per Object override material button 9
Created in NX6.0.0.

License requirements : None

void NXOpen::Display::TrueShadingBuilder::OButton9 ( )

Per Object override material button 10
Created in NX6.0.0.

License requirements : None

void NXOpen::Display::TrueShadingBuilder::ORemoveButton ( )

Removes override material from selected object(s)
Created in NX6.0.0.

License requirements : None

bool NXOpen::Display::TrueShadingBuilder::PlanarReflectionToggle ( )

Returns the planar reflection visibility toggle
Created in NX6.0.0.

License requirements : None

bool NXOpen::Display::TrueShadingBuilder::PlanarShadowToggle ( )

Returns the planar shadow visibility toggle
Created in NX6.0.0.

License requirements : None

bool NXOpen::Display::TrueShadingBuilder::PlaneGridToggle ( )

Returns the shadow plane grid visibility toggle
Created in NX6.0.0.

License requirements : None

bool NXOpen::Display::TrueShadingBuilder::PlaneOffsetFixedToggle ( )

Returns the shadow plane with fixed offset toggle
Created in NX6.0.0.

License requirements : None

double NXOpen::Display::TrueShadingBuilder::PlaneOffsetValue ( )

Returns the offset distance between the shadow plane and the nearest vertex of the displayed object
Created in NX6.0.0.

License requirements : None

void NXOpen::Display::TrueShadingBuilder::ProtectUpdate ( )

Protects update
Created in NX6.0.0.

License requirements : None

double NXOpen::Display::TrueShadingBuilder::ReflectivityValue ( )

Returns the reflectivity value
Created in NX6.0.0.

License requirements : None

void NXOpen::Display::TrueShadingBuilder::SetBgdBottomRgbcolorPicker ( const std::vector< double > & bgdBottomRGBColorPicker )

Sets the RGB values of background bottom color picker
Created in NX6.0.0.

License requirements : None

Parameters

bgdBottomRGBColorPicker Array of 3 RGB values, each between 0 and 1

void NXOpen::Display::TrueShadingBuilder::SetBgdImageEnum ( NXOpen::Display::TrueShadingBuilder::BgdImageType bgdImageEnum )

Sets the background image list enum
Created in NX6.0.0.

License requirements : None

Parameters

bgdImageEnum bgdimageenum

void NXOpen::Display::TrueShadingBuilder::SetBgdImageFileBrowser ( const NXString & filename )

Sets the background image filename
Created in NX6.0.0.

License requirements : None

Parameters

filename filename

void NXOpen::Display::TrueShadingBuilder::SetBgdImageFileBrowser ( const char * filename )

Sets the background image filename
Created in NX6.0.0.

License requirements : None

Parameters

filename filename

void NXOpen::Display::TrueShadingBuilder::SetBgdTopRgbcolorPicker ( const std::vector< double > & bgdTopRGBColorPicker )

Sets the RGB values of background top color picker
Created in NX6.0.0.

License requirements : None

Parameters

bgdTopRGBColorPicker Array of 3 RGB values, each between 0 and 1

void NXOpen::Display::TrueShadingBuilder::SetBgdTypeEnum ( NXOpen::Display::TrueShadingBuilder::BgdType bgdTypeEnum )

Sets the background color or background image type enum
Created in NX6.0.0.

License requirements : None

Parameters

bgdTypeEnum bgdtypeenum

void NXOpen::Display::TrueShadingBuilder::SetEnvironmentMapEnum ( NXOpen::Display::TrueShadingBuilder::EnvironmentMapType environmentMapEnum )

Sets the reflection environment map enum type
Created in NX6.0.0.

License requirements : None

Parameters

environmentMapEnum environmentmapenum

void NXOpen::Display::TrueShadingBuilder::SetEnvironmentMapFileBrowser ( const NXString & filename )

Sets the reflection environment map filename
Created in NX6.0.0.

License requirements : None

Parameters

filename filename

void NXOpen::Display::TrueShadingBuilder::SetEnvironmentMapFileBrowser ( const char * filename )

Sets the reflection environment map filename
Created in NX6.0.0.

License requirements : None

Parameters

filename filename

void NXOpen::Display::TrueShadingBuilder::SetGlobalMaterialType ( NXOpen::Display::TrueShadingBuilder::MaterialType globalMaterialType )

Sets the globalMaterialType
Created in NX6.0.0.

License requirements : None

Parameters

globalMaterialType globalmaterialtype

void NXOpen::Display::TrueShadingBuilder::SetGridRgbcolorPicker ( const std::vector< double > & gridRGBColorPicker )

Sets the grid RGB color picker
Created in NX6.0.0.

License requirements : None

Parameters

gridRGBColorPicker Array of 3 RGB values, each between 0 and 1

void NXOpen::Display::TrueShadingBuilder::SetInheritModelTogggle ( bool inheritModelTogggle )

Sets the shadow plane grid to inherit Model grid attributes toggle
Created in NX6.0.0.

License requirements : None

Parameters

inheritModelTogggle inheritmodeltogggle

void NXOpen::Display::TrueShadingBuilder::SetLightCollectionEnum ( NXOpen::Display::TrueShadingBuilder::SHEDLightCollectionType lightCollectionEnum )

Sets the light collection enum
Created in NX6.0.0.

License requirements : None

Parameters

lightCollectionEnum lightcollectionenum

void NXOpen::Display::TrueShadingBuilder::SetLightDimmerValue ( double lightDimmerValue )

Sets the light dimmer value
Created in NX6.0.0.

License requirements : None

Parameters

lightDimmerValue lightdimmervalue

void NXOpen::Display::TrueShadingBuilder::SetPlanarReflectionToggle ( bool planarReflectionToggle )

Sets the planar reflection visibility toggle
Created in NX6.0.0.

License requirements : None

Parameters

planarReflectionToggle planarreflectiontoggle

void NXOpen::Display::TrueShadingBuilder::SetPlanarShadowToggle ( bool planarShadowToggle )

Sets the planar shadow visibility toggle
Created in NX6.0.0.

License requirements : None

Parameters

planarShadowToggle planarshadowtoggle

void NXOpen::Display::TrueShadingBuilder::SetPlaneGridToggle ( bool planeGridToggle )

Sets the shadow plane grid visibility toggle
Created in NX6.0.0.

License requirements : None

Parameters

planeGridToggle planegridtoggle

void NXOpen::Display::TrueShadingBuilder::SetPlaneOffsetFixedToggle ( bool planeOffsetFixedToggle )

Sets the shadow plane with fixed offset toggle
Created in NX6.0.0.

License requirements : None

Parameters

planeOffsetFixedToggle planeoffsetfixedtoggle

void NXOpen::Display::TrueShadingBuilder::SetPlaneOffsetValue ( double planeOffsetValue )

Sets the offset distance between the shadow plane and the nearest vertex of the displayed object
Created in NX6.0.0.

License requirements : None

Parameters

planeOffsetValue planeoffsetvalue

void NXOpen::Display::TrueShadingBuilder::SetReflectivityValue ( double reflectivityValue )

Sets the reflectivity value
Created in NX6.0.0.

License requirements : None

Parameters

reflectivityValue reflectivityvalue

void NXOpen::Display::TrueShadingBuilder::SetShedModeToggle ( bool shedModeToggle )

Sets the True Shading display toggle state
Created in NX6.0.0.

License requirements : None

Parameters

shedModeToggle shedmodetoggle

void NXOpen::Display::TrueShadingBuilder::SetSnapFloorToggle ( bool snapFloorToggle )

Sets the toggle forces the shadow plane to snap to the nearest object vertex
Created in NX6.0.0.

License requirements : None

Parameters

snapFloorToggle snapfloortoggle

void NXOpen::Display::TrueShadingBuilder::SetSoftShadowsToggle ( bool softShadowsToggle )

Sets the soft shadows toggle
Created in NX6.0.0.

License requirements : None

Parameters

softShadowsToggle softshadowstoggle

void NXOpen::Display::TrueShadingBuilder::SetSpecifyPlane ( NXOpen::Plane * specifyPlane )

Sets the custom plane definition for the shadow projection
Created in NX6.0.0.

License requirements : None

Parameters

specifyPlane specifyplane

void NXOpen::Display::TrueShadingBuilder::SetSurfaceOrientEnum ( NXOpen::Display::TrueShadingBuilder::SurfaceOrientType surfaceOrientEnum )

Sets the shadow plane surface orientation enum
Created in NX6.0.0.

License requirements : None

Parameters

surfaceOrientEnum surfaceorientenum

bool NXOpen::Display::TrueShadingBuilder::ShedModeToggle ( )

Returns the True Shading display toggle state
Created in NX6.0.0.

License requirements : None

bool NXOpen::Display::TrueShadingBuilder::SnapFloorToggle ( )

Returns the toggle forces the shadow plane to snap to the nearest object vertex
Created in NX6.0.0.

License requirements : None

bool NXOpen::Display::TrueShadingBuilder::SoftShadowsToggle ( )

Returns the soft shadows toggle
Created in NX6.0.0.

License requirements : None

NXOpen::Plane* NXOpen::Display::TrueShadingBuilder::SpecifyPlane ( )

Returns the custom plane definition for the shadow projection
Created in NX6.0.0.

License requirements : None

NXOpen::Display::TrueShadingBuilder::SurfaceOrientType NXOpen::Display::TrueShadingBuilder::SurfaceOrientEnum ( )

Returns the shadow plane surface orientation enum
Created in NX6.0.0.

License requirements : None

The documentation for this class was generated from the following file:

Display_TrueShadingBuilder.hxx

Public Types

Public Member Functions

Detailed Description

Member Enumeration Documentation

Member Function Documentation