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

Represents a NXOpen.Display.RayTracedStudioEditorBuilder . More...

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

Public Types

enum  DynamicRayTracedStudioTilingQualityType { High, Medium, Low }
 To specify the quality and performance of the interactive, dynamic Ray Traced Studio display. More...
 
enum  RayTracedStudioStaticImageFileFormatType { Tif, Png, Jpg }
 To specify the Ray Traced Studio static image file format More...
 
enum  RayTracedStudioStaticImageOrientationType { Landscape, Portrait }
 To specify the Ray Traced Studio static image orientation More...
 
enum  RayTracedStudioStaticImageResolutionType { High, Medium, Low, UserDefined }
 To specify the Ray Traced Studio static image resolution More...
 
enum  RayTracedStudioStaticImageSizeType { RenderWindow, UserDefined }
 To specify the Ray Traced Studio static image size More...
 
enum  RayTracedStudioStaticImageUnitsType { Pixels, Millimeters, Inches }
 To specify the Ray Traced Studio static image units More...
 
enum  StaticAntialiasingType { High, Medium, Low, None }
 To specify the antialiasing quality during stationary Ray Traced Studio display during static image rendering More...
 
enum  StaticRayTracedStudioQualityType { High, Medium, Low, UserDefined }
 To specify the quality and performance of the Ray Traced Studio display during static image rendering More...
 
enum  StationaryAntialiasingType { Medium, Low, None }
 To specify the antialiasing quality during stationary Ray Traced Studio display when dynamic interaction stops More...
 
enum  StationaryRayTracedStudioQualityType { High, Medium, Low }
 To specify the quality and performance of the Ray Traced Studio display when dynamic interaction stops More...
 

Properties

unsafe
NXOpen.Display.RayTracedStudioEditorBuilder.DynamicRayTracedStudioTilingQualityType 
DynamicRayTracedStudioTilingQuality [get, set]
 Returns or sets the Ray Traced Studio tiling quality during interactive dynamic display More...
 
unsafe double RayTracedStudioDisplayGamma [get, set]
 Returns or sets the Ray Traced Studio display gamma, controls the overall contrast or brightness of the image's midtone values. More...
 
unsafe int RayTracedStudioStaticImageDotsPerInch [get, set]
 Returns or sets the Ray Traced Studio static image dots per inch (DPI) More...
 
unsafe double RayTracedStudioStaticImageDoubleHeight [get, set]
 Returns or sets the Ray Traced Studio static image height More...
 
unsafe double RayTracedStudioStaticImageDoubleWidth [get, set]
 Returns or sets the Ray Traced Studio static image width More...
 
unsafe
NXOpen.Display.RayTracedStudioEditorBuilder.RayTracedStudioStaticImageFileFormatType 
RayTracedStudioStaticImageFileFormat [get, set]
 Returns or sets the Ray Traced Studio static output image file format More...
 
unsafe bool RayTracedStudioStaticImageLockAspectRatio [get, set]
 Returns or sets the Ray Traced Studio static image aspect ratio will be maintained More...
 
unsafe
NXOpen.Display.RayTracedStudioEditorBuilder.RayTracedStudioStaticImageOrientationType 
RayTracedStudioStaticImageOrientation [get, set]
 Returns or sets the Ray Traced Studio static image orientation More...
 
unsafe int RayTracedStudioStaticImagePixelHeight [get, set]
 Returns or sets the Ray Traced Studio static image pixel height More...
 
unsafe int RayTracedStudioStaticImagePixelWidth [get, set]
 Returns or sets the Ray Traced Studio static image pixel width More...
 
unsafe
NXOpen.Display.RayTracedStudioEditorBuilder.RayTracedStudioStaticImageResolutionType 
RayTracedStudioStaticImageResolution [get, set]
 Returns or sets the Ray Traced Studio static image resolution More...
 
unsafe
NXOpen.Display.RayTracedStudioEditorBuilder.RayTracedStudioStaticImageSizeType 
RayTracedStudioStaticImageSize [get, set]
 Returns or sets the Ray Traced Studio static image size More...
 
unsafe
NXOpen.Display.RayTracedStudioEditorBuilder.RayTracedStudioStaticImageUnitsType 
RayTracedStudioStaticImageUnits [get, set]
 Returns or sets the Ray Traced Studio static image units More...
 
unsafe
NXOpen.Display.RayTracedStudioEditorBuilder.StaticAntialiasingType 
StaticAntialiasing [get, set]
 Returns or sets the Ray Traced Studio static image antialiasing quality More...
 
unsafe
NXOpen.Display.RayTracedStudioEditorBuilder.StaticRayTracedStudioQualityType 
StaticRayTracedStudioQuality [get, set]
 Returns or sets the Ray Traced Studio static image quality More...
 
unsafe int StaticRayTracedStudioRenderDepth [get, set]
 Returns or sets the Ray Traced Studio static image render depth, controls the iterations of ray tracing reflection and refraction calculations More...
 
unsafe
NXOpen.Display.RayTracedStudioEditorBuilder.StationaryAntialiasingType 
StationaryAntialiasing [get, set]
 Returns or sets the Ray Traced Studio stationary antialiasing quality when dynamic interaction stops More...
 
unsafe
NXOpen.Display.RayTracedStudioEditorBuilder.StationaryRayTracedStudioQualityType 
StationaryRayTracedStudioQuality [get, set]
 Returns or sets the Ray Traced Studio stationary display quality when dynamic interaction stops More...
 
unsafe bool StationaryRayTracedStudioshowStatusIndicator [get, set]
 Returns or sets the stationary Ray Traced Studio progess status indicator percent complete display 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.RayTracedStudioEditorBuilder .

Ray Traced Studio Editor controls display and output of CPU-based real-time ray tracing.

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

Created in NX9.0.0

Member Enumeration Documentation

To specify the quality and performance of the interactive, dynamic Ray Traced Studio display.

Affects the number of tiles presented in the display.

Enumerator
High 

Very small tiles used during progressive updates of ray traced display

Medium 

Medium sized tiles used during progressive updates of ray traced display

Low 

Larger tiles used during progressive updates of ray traced display for faster display time

To specify the Ray Traced Studio static image file format

Enumerator
Tif 

Tagged Image File Format (TIFF) file format

Png 

Portable Network Graphic (PNG) file format

Jpg 

Joint Photographic Experts Group (JPEG) file format

To specify the Ray Traced Studio static image orientation

Enumerator
Landscape 

static image orientation where width is greater than height

Portrait 

static image orientation where height is greater than width

To specify the Ray Traced Studio static image resolution

Enumerator
High 

static image output resolution of 300 DPI (dots per inch)

Medium 

static image output resolution of 150 DPI (dots per inch)

Low 

static image output resolution of 72 DPI (dots per inch)

UserDefined 

user specified image output resolution in DPI (dots per inch)

To specify the Ray Traced Studio static image size

Enumerator
RenderWindow 

Ray Traced Studio window size used for static image output

UserDefined 

user specified size for static image output

To specify the Ray Traced Studio static image units

Enumerator
Pixels 

static image size specified in pixel

Millimeters 

static image size specified in millimeters

Inches 

static image size specified in inches

To specify the antialiasing quality during stationary Ray Traced Studio display during static image rendering

Enumerator
High 

Very good antialiasing performed for static image rendering

Medium 

Good antialiasing performed for static image rendering

Low 

Coarse antialiasing performed for static image rendering

None 

No antialiasing performed to provide quick, preview of ray traced display for static image rendering

To specify the quality and performance of the Ray Traced Studio display during static image rendering

Enumerator
High 

Very good ray traced display quality for static image rendering

Medium 

Good quality ray traced display with good performance for static image rendering

Low 

The fastest ray traced display performance with preview quality for static image rendering

UserDefined 

User specified ray traced display quality for static image rendering

To specify the antialiasing quality during stationary Ray Traced Studio display when dynamic interaction stops

Enumerator
Medium 

Good antialiasing performed when dynamic interaction stops

Low 

Coarse antialiasing performed when dynamic interaction stops

None 

No antialiasing performed to provide quick, preview of ray traced display when dynamic interaction stops

To specify the quality and performance of the Ray Traced Studio display when dynamic interaction stops

Enumerator
High 

Very good ray traced display quality when dynamic interaction stops

Medium 

Good ray traced display quality with good performance when dynamic interaction stops

Low 

The fastest ray traced display performance with preview quality when dynamic interaction stops

Property Documentation

unsafe NXOpen.Display.RayTracedStudioEditorBuilder.DynamicRayTracedStudioTilingQualityType NXOpen.Display.RayTracedStudioEditorBuilder.DynamicRayTracedStudioTilingQuality
getset

Returns or sets the Ray Traced Studio tiling quality during interactive dynamic display

Created in NX9.0.0

License requirements to get this property: None.

License requirements to set this property: None.

unsafe double NXOpen.Display.RayTracedStudioEditorBuilder.RayTracedStudioDisplayGamma
getset

Returns or sets the Ray Traced Studio display gamma, controls the overall contrast or brightness of the image's midtone values.

A higher gamma value yields an overall brighter image.

Created in NX9.0.0

License requirements to get this property: None.

License requirements to set this property: None.

unsafe int NXOpen.Display.RayTracedStudioEditorBuilder.RayTracedStudioStaticImageDotsPerInch
getset

Returns or sets the Ray Traced Studio static image dots per inch (DPI)

Created in NX9.0.0

License requirements to get this property: None.

License requirements to set this property: None.

unsafe double NXOpen.Display.RayTracedStudioEditorBuilder.RayTracedStudioStaticImageDoubleHeight
getset

Returns or sets the Ray Traced Studio static image height

Created in NX9.0.0

License requirements to get this property: None.

License requirements to set this property: None.

unsafe double NXOpen.Display.RayTracedStudioEditorBuilder.RayTracedStudioStaticImageDoubleWidth
getset

Returns or sets the Ray Traced Studio static image width

Created in NX9.0.0

License requirements to get this property: None.

License requirements to set this property: None.

unsafe NXOpen.Display.RayTracedStudioEditorBuilder.RayTracedStudioStaticImageFileFormatType NXOpen.Display.RayTracedStudioEditorBuilder.RayTracedStudioStaticImageFileFormat
getset

Returns or sets the Ray Traced Studio static output image file format

Created in NX9.0.0

License requirements to get this property: None.

License requirements to set this property: None.

unsafe bool NXOpen.Display.RayTracedStudioEditorBuilder.RayTracedStudioStaticImageLockAspectRatio
getset

Returns or sets the Ray Traced Studio static image aspect ratio will be maintained

Created in NX9.0.0

License requirements to get this property: None.

License requirements to set this property: None.

unsafe NXOpen.Display.RayTracedStudioEditorBuilder.RayTracedStudioStaticImageOrientationType NXOpen.Display.RayTracedStudioEditorBuilder.RayTracedStudioStaticImageOrientation
getset

Returns or sets the Ray Traced Studio static image orientation

Created in NX9.0.0

License requirements to get this property: None.

License requirements to set this property: None.

unsafe int NXOpen.Display.RayTracedStudioEditorBuilder.RayTracedStudioStaticImagePixelHeight
getset

Returns or sets the Ray Traced Studio static image pixel height

Created in NX9.0.0

License requirements to get this property: None.

License requirements to set this property: None.

unsafe int NXOpen.Display.RayTracedStudioEditorBuilder.RayTracedStudioStaticImagePixelWidth
getset

Returns or sets the Ray Traced Studio static image pixel width

Created in NX9.0.0

License requirements to get this property: None.

License requirements to set this property: None.

unsafe NXOpen.Display.RayTracedStudioEditorBuilder.RayTracedStudioStaticImageResolutionType NXOpen.Display.RayTracedStudioEditorBuilder.RayTracedStudioStaticImageResolution
getset

Returns or sets the Ray Traced Studio static image resolution

Created in NX9.0.0

License requirements to get this property: None.

License requirements to set this property: None.

unsafe NXOpen.Display.RayTracedStudioEditorBuilder.RayTracedStudioStaticImageSizeType NXOpen.Display.RayTracedStudioEditorBuilder.RayTracedStudioStaticImageSize
getset

Returns or sets the Ray Traced Studio static image size

Created in NX9.0.0

License requirements to get this property: None.

License requirements to set this property: None.

unsafe NXOpen.Display.RayTracedStudioEditorBuilder.RayTracedStudioStaticImageUnitsType NXOpen.Display.RayTracedStudioEditorBuilder.RayTracedStudioStaticImageUnits
getset

Returns or sets the Ray Traced Studio static image units

Created in NX9.0.0

License requirements to get this property: None.

License requirements to set this property: None.

unsafe NXOpen.Display.RayTracedStudioEditorBuilder.StaticAntialiasingType NXOpen.Display.RayTracedStudioEditorBuilder.StaticAntialiasing
getset

Returns or sets the Ray Traced Studio static image antialiasing quality

Created in NX9.0.0

License requirements to get this property: None.

License requirements to set this property: None.

unsafe NXOpen.Display.RayTracedStudioEditorBuilder.StaticRayTracedStudioQualityType NXOpen.Display.RayTracedStudioEditorBuilder.StaticRayTracedStudioQuality
getset

Returns or sets the Ray Traced Studio static image quality

Created in NX9.0.0

License requirements to get this property: None.

License requirements to set this property: None.

unsafe int NXOpen.Display.RayTracedStudioEditorBuilder.StaticRayTracedStudioRenderDepth
getset

Returns or sets the Ray Traced Studio static image render depth, controls the iterations of ray tracing reflection and refraction calculations

Created in NX9.0.0

License requirements to get this property: None.

License requirements to set this property: None.

unsafe NXOpen.Display.RayTracedStudioEditorBuilder.StationaryAntialiasingType NXOpen.Display.RayTracedStudioEditorBuilder.StationaryAntialiasing
getset

Returns or sets the Ray Traced Studio stationary antialiasing quality when dynamic interaction stops

Created in NX9.0.0

License requirements to get this property: None.

License requirements to set this property: None.

unsafe NXOpen.Display.RayTracedStudioEditorBuilder.StationaryRayTracedStudioQualityType NXOpen.Display.RayTracedStudioEditorBuilder.StationaryRayTracedStudioQuality
getset

Returns or sets the Ray Traced Studio stationary display quality when dynamic interaction stops

Created in NX9.0.0

License requirements to get this property: None.

License requirements to set this property: None.

unsafe bool NXOpen.Display.RayTracedStudioEditorBuilder.StationaryRayTracedStudioshowStatusIndicator
getset

Returns or sets the stationary Ray Traced Studio progess status indicator percent complete display

Created in NX9.0.0

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.