NXOpen::Display::Shadows Class Reference

Represents a NXOpen::Display::Shadows
This class is restricted to being called from a program running during an Interactive NX session. More...

Inheritance diagram for NXOpen::Display::Shadows:

Public Types
enum	RealTimeState { RealTimeStateDisabled, RealTimeStateEnvironmentShadowCatcherOnly, RealTimeStateInterObject }
	Real time type settings - environment_shadow_catcher_only is enabled only in Basic Studio mode. More...
enum	SsaoContrastType {   SsaoContrastTypeNone, SsaoContrastTypeLow, SsaoContrastTypeMedium, SsaoContrastTypeHigh,   SsaoContrastTypeExtraHigh }
	Shadows SSAO contrast settings. More...
enum	SsaoQualityType { SsaoQualityTypeLow, SsaoQualityTypeMedium, SsaoQualityTypeHigh, SsaoQualityTypeVeryHigh }
	Shadows SSAO quality settings. More...

Public Member Functions
bool	AmbientOcclusion ()
	Returns the shadows SSAO ambient occlusion Created in NX7.5.3. More...
bool	GenerateHqiShadows ()
	Returns the High Quality Image settings Created in NX7.5.3. More...
NXOpen::Display::Shadows::RealTimeState	RealTimeType ()
	Returns the Real Time Settings Created in NX7.5.3. More...
void	SetAmbientOcclusion (bool shadowsSSAODisplayEnabled)
	Sets the shadows SSAO ambient occlusion Created in NX7.5.3. More...
void	SetGenerateHqiShadows (bool generateHQIShadows)
	Sets the High Quality Image settings Created in NX7.5.3. More...
void	SetRealTimeType (NXOpen::Display::Shadows::RealTimeState realTimeType)
	Sets the Real Time Settings Created in NX7.5.3. More...
void	SetShadowsEnabled (bool shadowsEnabled)
	Sets the Overall Shadows Created in NX10.0.2. More...
void	SetSoftShadowsBiasOffset (double softShadowsBiasOffset)
	Sets the Soft Shadows bias offset Created in NX7.5.3. More...
void	SetSoftShadowsEdges (int softShadowsEdges)
	Sets the Soft Shadows edges (softness) Created in NX7.5.3. More...
void	SetSoftShadowsEnabled (bool softShadowsEnabled)
	Sets the Soft Shadows Created in NX7.5.3. More...
void	SetSoftShadowsGradientClamp (double softShadowsGradientClamp)
	Sets the Soft Shadows gradient clamp Created in NX7.5.3. More...
void	SetSoftShadowsQuality (int softShadowsQuality)
	Sets the Soft Shadows quality Created in NX7.5.3. More...
void	SetSsaoBlurRadius (double blurRadius)
	Sets the shadows SSAO Blur Radius Created in NX7.5.3. More...
void	SetSsaoContrast (NXOpen::Display::Shadows::SsaoContrastType contrast)
	Sets the shadows SSAO contrast Created in NX7.5.3. More...
void	SetSsaoQuality (NXOpen::Display::Shadows::SsaoQualityType shadowsSSAOQuality)
	Sets the shadows SSAO quality Created in NX7.5.3. More...
void	SetSsaoRadius (double radius)
	Sets the shadows SSAO radius Created in NX7.5.3. More...
void	SetUseShadowCatcher (bool useShadowCatcher)
	Sets the Shadow Catcher Created in NX7.5.3. More...
NXOpen::SelectNXObjectList *	ShadowCatcherSelection ()
	Returns the Shadow Catcher Selection Created in NX7.5.3. More...
bool	ShadowsEnabled ()
	Returns the Overall Shadows Created in NX10.0.2. More...
double	SoftShadowsBiasOffset ()
	Returns the Soft Shadows bias offset Created in NX7.5.3. More...
int	SoftShadowsEdges ()
	Returns the Soft Shadows edges (softness) Created in NX7.5.3. More...
bool	SoftShadowsEnabled ()
	Returns the Soft Shadows Created in NX7.5.3. More...
double	SoftShadowsGradientClamp ()
	Returns the Soft Shadows gradient clamp Created in NX7.5.3. More...
int	SoftShadowsQuality ()
	Returns the Soft Shadows quality Created in NX7.5.3. More...
double	SsaoBlurRadius ()
	Returns the shadows SSAO Blur Radius Created in NX7.5.3. More...
NXOpen::Display::Shadows::SsaoContrastType	SsaoContrast ()
	Returns the shadows SSAO contrast Created in NX7.5.3. More...
NXOpen::Display::Shadows::SsaoQualityType	SsaoQuality ()
	Returns the shadows SSAO quality Created in NX7.5.3. More...
double	SsaoRadius ()
	Returns the shadows SSAO radius Created in NX7.5.3. More...
bool	UseShadowCatcher ()
	Returns the Shadow Catcher Created in NX7.5.3. More...
Public Member Functions inherited from NXOpen::Builder
NXOpen::NXObject *	Commit ()
	Commits any edits that have been applied to the builder. More...
void	Destroy ()
	Deletes the builder, and cleans up any objects created by the builder. More...
std::vector< NXOpen::NXObject * >	GetCommittedObjects ()
	For builders that create more than one object, this method returns the objects that are created by commit. More...
NXOpen::NXObject *	GetObject ()
	Returns the object currently being edited by this builder. More...
void	ShowResults ()
	Updates the model to reflect the result of an edit to the model for all builders that support showing results. More...
virtual bool	Validate ()
	Validate whether the inputs to the component are sufficient for commit to be called. More...
Public Member Functions inherited from NXOpen::TaggedObject
tag_t	Tag () const
	Returns the tag of this object. More...

Detailed Description

Represents a NXOpen::Display::Shadows
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 NULL.

To create a new instance of this class, use NXOpen::ViewCollection::CreateShadows

Created in NX7.5.3.

Member Enumeration Documentation

enum NXOpen::Display::Shadows::RealTimeState

Real time type settings - environment_shadow_catcher_only is enabled only in Basic Studio mode.

Enumerator
RealTimeStateDisabled	Realtime is disabled.
RealTimeStateEnvironmentShadowCatcherOnly	Realtime Environment or shadow catcher only.
RealTimeStateInterObject	Realtime Inter-object shadows.

enum NXOpen::Display::Shadows::SsaoContrastType

Shadows SSAO contrast settings.

Enumerator
SsaoContrastTypeNone	no contrast
SsaoContrastTypeLow	low contrast
SsaoContrastTypeMedium	Medium contrast.
SsaoContrastTypeHigh	High contrast.
SsaoContrastTypeExtraHigh	Extra High contrast.

enum NXOpen::Display::Shadows::SsaoQualityType

Shadows SSAO quality settings.

Enumerator
SsaoQualityTypeLow	Low quality setting.
SsaoQualityTypeMedium	Medium quality setting.
SsaoQualityTypeHigh	High quality setting.
SsaoQualityTypeVeryHigh	Very High quality setting.

Member Function Documentation

bool NXOpen::Display::Shadows::AmbientOcclusion

(

)

Returns the shadows SSAO ambient occlusion
Created in NX7.5.3.

License requirements : None

bool NXOpen::Display::Shadows::GenerateHqiShadows

(

)

Returns the High Quality Image settings
Created in NX7.5.3.

License requirements : None

NXOpen::Display::Shadows::RealTimeState NXOpen::Display::Shadows::RealTimeType

(

)

Returns the Real Time Settings
Created in NX7.5.3.

License requirements : None

void NXOpen::Display::Shadows::SetAmbientOcclusion

(

bool

shadowsSSAODisplayEnabled

)

Sets the shadows SSAO ambient occlusion
Created in NX7.5.3.

License requirements : None

Parameters

shadowsSSAODisplayEnabled

shadowsssaodisplayenabled

void NXOpen::Display::Shadows::SetGenerateHqiShadows

(

bool

generateHQIShadows

)

Sets the High Quality Image settings
Created in NX7.5.3.

License requirements : None

Parameters

generateHQIShadows

generatehqishadows

void NXOpen::Display::Shadows::SetRealTimeType

(

NXOpen::Display::Shadows::RealTimeState

realTimeType

)

Sets the Real Time Settings
Created in NX7.5.3.

License requirements : None

Parameters

realTimeType

realtimetype

void NXOpen::Display::Shadows::SetShadowsEnabled

(

bool

shadowsEnabled

)

Sets the Overall Shadows
Created in NX10.0.2.

License requirements : None

Parameters

shadowsEnabled

shadowsenabled

void NXOpen::Display::Shadows::SetSoftShadowsBiasOffset

(

double

softShadowsBiasOffset

)

Sets the Soft Shadows bias offset
Created in NX7.5.3.

License requirements : None

Parameters

softShadowsBiasOffset

softshadowsbiasoffset

void NXOpen::Display::Shadows::SetSoftShadowsEdges

(

int

softShadowsEdges

)

Sets the Soft Shadows edges (softness)
Created in NX7.5.3.

License requirements : None

Parameters

softShadowsEdges

softshadowsedges

void NXOpen::Display::Shadows::SetSoftShadowsEnabled

(

bool

softShadowsEnabled

)

Sets the Soft Shadows
Created in NX7.5.3.

License requirements : None

Parameters

softShadowsEnabled

softshadowsenabled

void NXOpen::Display::Shadows::SetSoftShadowsGradientClamp

(

double

softShadowsGradientClamp

)

Sets the Soft Shadows gradient clamp
Created in NX7.5.3.

License requirements : None

Parameters

softShadowsGradientClamp

softshadowsgradientclamp

void NXOpen::Display::Shadows::SetSoftShadowsQuality

(

int

softShadowsQuality

)

Sets the Soft Shadows quality
Created in NX7.5.3.

License requirements : None

Parameters

softShadowsQuality

softshadowsquality

void NXOpen::Display::Shadows::SetSsaoBlurRadius

(

double

blurRadius

)

Sets the shadows SSAO Blur Radius
Created in NX7.5.3.

License requirements : None

Parameters

blurRadius

blurradius

void NXOpen::Display::Shadows::SetSsaoContrast

(

NXOpen::Display::Shadows::SsaoContrastType

contrast

)

Sets the shadows SSAO contrast
Created in NX7.5.3.

License requirements : None

Parameters

contrast

contrast

void NXOpen::Display::Shadows::SetSsaoQuality

(

NXOpen::Display::Shadows::SsaoQualityType

shadowsSSAOQuality

)

Sets the shadows SSAO quality
Created in NX7.5.3.

License requirements : None

Parameters

shadowsSSAOQuality

shadowsssaoquality

void NXOpen::Display::Shadows::SetSsaoRadius

(

double

radius

)

Sets the shadows SSAO radius
Created in NX7.5.3.

License requirements : None

Parameters

radius

radius

void NXOpen::Display::Shadows::SetUseShadowCatcher

(

bool

useShadowCatcher

)

Sets the Shadow Catcher
Created in NX7.5.3.

License requirements : None

Parameters

useShadowCatcher

useshadowcatcher

NXOpen::SelectNXObjectList* NXOpen::Display::Shadows::ShadowCatcherSelection

(

)

Returns the Shadow Catcher Selection
Created in NX7.5.3.

License requirements : None

bool NXOpen::Display::Shadows::ShadowsEnabled

(

)

Returns the Overall Shadows
Created in NX10.0.2.

License requirements : None

double NXOpen::Display::Shadows::SoftShadowsBiasOffset

(

)

Returns the Soft Shadows bias offset
Created in NX7.5.3.

License requirements : None

int NXOpen::Display::Shadows::SoftShadowsEdges

(

)

Returns the Soft Shadows edges (softness)
Created in NX7.5.3.

License requirements : None

bool NXOpen::Display::Shadows::SoftShadowsEnabled

(

)

Returns the Soft Shadows
Created in NX7.5.3.

License requirements : None

double NXOpen::Display::Shadows::SoftShadowsGradientClamp

(

)

Returns the Soft Shadows gradient clamp
Created in NX7.5.3.

License requirements : None

int NXOpen::Display::Shadows::SoftShadowsQuality

(

)

Returns the Soft Shadows quality
Created in NX7.5.3.

License requirements : None

double NXOpen::Display::Shadows::SsaoBlurRadius

(

)

Returns the shadows SSAO Blur Radius
Created in NX7.5.3.

License requirements : None

NXOpen::Display::Shadows::SsaoContrastType NXOpen::Display::Shadows::SsaoContrast

(

)

Returns the shadows SSAO contrast
Created in NX7.5.3.

License requirements : None

NXOpen::Display::Shadows::SsaoQualityType NXOpen::Display::Shadows::SsaoQuality

(

)

Returns the shadows SSAO quality
Created in NX7.5.3.

License requirements : None

double NXOpen::Display::Shadows::SsaoRadius

(

)

Returns the shadows SSAO radius
Created in NX7.5.3.

License requirements : None

bool NXOpen::Display::Shadows::UseShadowCatcher

(

)

Returns the Shadow Catcher
Created in NX7.5.3.

License requirements : None

---

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

• Display_Shadows.hxx