NXOpen .NET Reference Guide  1899
 All Classes Namespaces Functions Variables Enumerations Enumerator Properties
Public Types | Properties | List of all members
NXOpen.Display.Shadows Class Reference

Represents a NXOpen.Display.Shadows More...

Inheritance diagram for NXOpen.Display.Shadows:
NXOpen.Builder NXOpen.TaggedObject NXOpen.GeometricUtilities.IComponentBuilder NXOpen.Utilities.NXRemotableObject IMessageSink

Public Types

enum  RealTimeState { Disabled, EnvironmentShadowCatcherOnly, InterObject }
 Real time type settings - environment_shadow_catcher_only is enabled only in Basic Studio mode More...
 
enum  SsaoContrastType {
  None, Low, Medium, High,
  ExtraHigh
}
 Shadows SSAO contrast settings More...
 
enum  SsaoQualityType { Low, Medium, High, VeryHigh }
 Shadows SSAO quality settings More...
 

Properties

unsafe bool AmbientOcclusion [get, set]
 Returns or sets the shadows SSAO ambient occlusion More...
 
unsafe bool GenerateHqiShadows [get, set]
 Returns or sets the High Quality Image settings More...
 
unsafe
NXOpen.Display.Shadows.RealTimeState 
RealTimeType [get, set]
 Returns or sets the Real Time Settings More...
 
unsafe NXOpen.SelectNXObjectList ShadowCatcherSelection [get]
 Returns the Shadow Catcher Selection More...
 
unsafe bool ShadowsEnabled [get, set]
 Returns or sets the Overall Shadows More...
 
unsafe bool ShadowsShadedViewsShowGroundShadows [get, set]
 Returns or sets the Ground Shadow in Shaded View More...
 
unsafe double SoftShadowsBiasOffset [get, set]
 Returns or sets the Soft Shadows bias offset More...
 
unsafe int SoftShadowsEdges [get, set]
 Returns or sets the Soft Shadows edges (softness) More...
 
unsafe bool SoftShadowsEnabled [get, set]
 Returns or sets the Soft Shadows More...
 
unsafe double SoftShadowsGradientClamp [get, set]
 Returns or sets the Soft Shadows gradient clamp More...
 
unsafe int SoftShadowsQuality [get, set]
 Returns or sets the Soft Shadows quality More...
 
unsafe double SsaoBlurRadius [get, set]
 Returns or sets the shadows SSAO Blur Radius More...
 
unsafe
NXOpen.Display.Shadows.SsaoContrastType 
SsaoContrast [get, set]
 Returns or sets the shadows SSAO contrast More...
 
unsafe
NXOpen.Display.Shadows.SsaoQualityType 
SsaoQuality [get, set]
 Returns or sets the shadows SSAO quality More...
 
unsafe double SsaoRadius [get, set]
 Returns or sets the shadows SSAO radius More...
 
unsafe bool UseShadowCatcher [get, set]
 Returns or sets the Shadow Catcher More...
 
- Properties inherited from NXOpen.Builder
unsafe NXOpen.PreviewBuilder PreviewBuilder [get]
 Returns the preview builder subobject. More...
 
- Properties inherited from NXOpen.TaggedObject
Tag Tag [get]
 Returns the tag of this object. More...
 
- Properties inherited from NXOpen.Utilities.NXRemotableObject
IMessageSink NextSink [get]
 Gets the next message sink in the sink chain. More...
 

Additional Inherited Members

- Public Member Functions inherited from NXOpen.Builder
unsafe NXOpen.NXObject Commit ()
 Commits any edits that have been applied to the builder. More...
 
unsafe void Destroy ()
 Deletes the builder, and cleans up any objects created by the builder. More...
 
unsafe NXOpen.NXObject[] GetCommittedObjects ()
 For builders that create more than one object, this method returns the objects that are created by commit. More...
 
unsafe NXOpen.NXObject GetObject ()
 Returns the object currently being edited by this builder. More...
 
unsafe void ShowResults ()
 Updates the model to reflect the result of an edit to the model for all builders that support showing results. More...
 
unsafe bool Validate ()
 Validate whether the inputs to the component are sufficient for commit to be called. More...
 
- Protected Member Functions inherited from NXOpen.TaggedObject
new void initialize ()
 <exclude> 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 a null reference (Nothing in Visual Basic).

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

Created in NX7.5.3

Member Enumeration Documentation

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

Enumerator
Disabled 

Realtime is disabled

EnvironmentShadowCatcherOnly 

Realtime Environment or shadow catcher only

InterObject 

Realtime Inter-object shadows

Shadows SSAO contrast settings

Enumerator
None 

no contrast

Low 

low contrast

Medium 

Medium contrast

High 

High contrast

ExtraHigh 

Extra High contrast

Shadows SSAO quality settings

Enumerator
Low 

Low quality setting

Medium 

Medium quality setting

High 

High quality setting

VeryHigh 

Very High quality setting

Property Documentation

unsafe bool NXOpen.Display.Shadows.AmbientOcclusion
getset

Returns or sets the shadows SSAO ambient occlusion

Created in NX7.5.3

License requirements to get this property: None.

License requirements to set this property: None.

unsafe bool NXOpen.Display.Shadows.GenerateHqiShadows
getset

Returns or sets the High Quality Image settings

Created in NX7.5.3

License requirements to get this property: None.

License requirements to set this property: None.

unsafe NXOpen.Display.Shadows.RealTimeState NXOpen.Display.Shadows.RealTimeType
getset

Returns or sets the Real Time Settings

Created in NX7.5.3

License requirements to get this property: None.

License requirements to set this property: None.

unsafe NXOpen.SelectNXObjectList NXOpen.Display.Shadows.ShadowCatcherSelection
get

Returns the Shadow Catcher Selection

Created in NX7.5.3

License requirements: None.

unsafe bool NXOpen.Display.Shadows.ShadowsEnabled
getset

Returns or sets the Overall Shadows

Created in NX10.0.2

License requirements to get this property: None.

License requirements to set this property: None.

unsafe bool NXOpen.Display.Shadows.ShadowsShadedViewsShowGroundShadows
getset

Returns or sets the Ground Shadow in Shaded View

Created in NX1899.0.0

License requirements to get this property: None.

License requirements to set this property: None.

unsafe double NXOpen.Display.Shadows.SoftShadowsBiasOffset
getset

Returns or sets the Soft Shadows bias offset

Created in NX7.5.3

License requirements to get this property: None.

License requirements to set this property: None.

unsafe int NXOpen.Display.Shadows.SoftShadowsEdges
getset

Returns or sets the Soft Shadows edges (softness)

Created in NX7.5.3

License requirements to get this property: None.

License requirements to set this property: None.

unsafe bool NXOpen.Display.Shadows.SoftShadowsEnabled
getset

Returns or sets the Soft Shadows

Created in NX7.5.3

License requirements to get this property: None.

License requirements to set this property: None.

unsafe double NXOpen.Display.Shadows.SoftShadowsGradientClamp
getset

Returns or sets the Soft Shadows gradient clamp

Created in NX7.5.3

License requirements to get this property: None.

License requirements to set this property: None.

unsafe int NXOpen.Display.Shadows.SoftShadowsQuality
getset

Returns or sets the Soft Shadows quality

Created in NX7.5.3

License requirements to get this property: None.

License requirements to set this property: None.

unsafe double NXOpen.Display.Shadows.SsaoBlurRadius
getset

Returns or sets the shadows SSAO Blur Radius

Created in NX7.5.3

License requirements to get this property: None.

License requirements to set this property: None.

unsafe NXOpen.Display.Shadows.SsaoContrastType NXOpen.Display.Shadows.SsaoContrast
getset

Returns or sets the shadows SSAO contrast

Created in NX7.5.3

License requirements to get this property: None.

License requirements to set this property: None.

unsafe NXOpen.Display.Shadows.SsaoQualityType NXOpen.Display.Shadows.SsaoQuality
getset

Returns or sets the shadows SSAO quality

Created in NX7.5.3

License requirements to get this property: None.

License requirements to set this property: None.

unsafe double NXOpen.Display.Shadows.SsaoRadius
getset

Returns or sets the shadows SSAO radius

Created in NX7.5.3

License requirements to get this property: None.

License requirements to set this property: None.

unsafe bool NXOpen.Display.Shadows.UseShadowCatcher
getset

Returns or sets the Shadow Catcher

Created in NX7.5.3

License requirements to get this property: None.

License requirements to set this property: None.


The documentation for this class was generated from the following file:
Copyright 2019 Siemens Product Lifecycle Management Software Inc. All Rights Reserved.