NXOpen.Display Package

Classes

Background Class Represents a NXOpen.Display.Background Background defines how background pixels are displayed.
BoundedGrid Class Represents a bounded grid
BoundedGridBuilder Class Represents the builder for creating a bounded grid NXOpen.Display.BoundedGrid.
Camera Class Represents a camera
CameraBuilder Class Represents a NXOpen.Display.CameraBuilder
CameraCollection Class Represents a collection cameras
CanonMRTestBuilder Class Supports debug dialog DisplayUI::UICompCanonMRTest in testing DSS and CGP functions for the Canon MR display system.
DatumPlaneGrid Class Represents a grid on a datum plane
DatumPlaneGridBuilder Class Represents the builder for adding a datum plane grid NXOpen.Display.DatumPlaneGrid to a datum plane.
DecalBuilder Class Represents a NXOpen.Display.DecalBuilder
DecalCollection Class Represents a collection decal material texture
DynamicSection Class Represents a dynamic section
DynamicSectionBuilder Class Represents a Dynamic Section Builder used for creating sections.
DynamicSectionCollection Class Represents a collection of dynamic section objects
DynamicSectionCut Class Represents a dynamic section-cut generated by sectioning an object such as a NXOpen.IBody or a NXOpen.Assemblies.Component.
DynamicSectionTypes Class Represents a enumerations used by Dynamic Section Builder.
EntitySelectionPlane Class Represents a grid on a datum plane
EnvironmentBuilder Class Represents a Display.EnvironmentBuilder This controls environment image, tone mapping, and stages.
ExtractScene Class Represents a NXOpen.Display.ExtractScene
FacetSettingsBuilder Class Represents a NXOpen.Display.FacetSettingsBuilder
GlobalIlluminationBuilder Class Represents a NXOpen.Display.GlobalIlluminationBuilder.
Grid Class Represents a grid
GridBuilder Class Represents the builder for adding a grid NXOpen.Display.Grid
GridCollection Class Represents a collection of plane grid objects
IDynamicSectionCutCreator Class Represents a dynamic section-cut creator that generates dynamic section-cuts (see NXOpen.Display.DynamicSectionCut).
IRayPlusStudioEditorBuilder Class Represents a NXOpen.Display.IRayPlusStudioEditorBuilder.
Image Class Represents a NXOpen.Display.Image
ImageBase Class Represents a NXOpen.Display.ImageBase that provides definition, orientation, sizing, and display setting controls for image based objects.
ImageBaseBuilder Class Represents a NXOpen.Display.ImageBaseBuilder.
ImageBasedLighting Class Represents a NXOpen.Display.ImageBasedLighting Image-based Lighting (IBL) is only performed in High Quality Image renderings.
ImageCollection Class Represents a collection of image objects
ImageData Class Represents a NXOpen.Display.ImageData that stores the contents of a previously imported image file in the part.
ImageDataCollection Class Represents a collection of NXOpen.Display.ImageData objects.
IrayPlusMaterialAttribute Class Represents an IrayPlus Attribute
IrayPlusMaterialAttributeEnum Class Represents a IrayPlus Enum Attribute
IrayPlusMaterialEditorBuilder Class Represents a NXOpen.Display.IrayPlusMaterialEditorBuilder
IrayPlusSimpleMaterialEditorBuilder Class Represents a NXOpen.Display.IrayPlusSimpleMaterialEditorBuilder
LayerSettingsBuilder Class Represents a builder for object layer settings.
LightBuilder Class Represents a NXOpen.Display.LightBuilder
Lighting Class Represents a NXOpen.Display.Lighting Lights are used to illuminate the scene in Shaded and Studio rendering styles, as well as in High Quality Images.
NonProportionalZoom Class Provides non-proportional zoom capability
PerspectiveOptionsBuilder Class Represents a NXOpen.Display.PerspectiveOptionsBuilder
PlanarShipGrid Class Represents a planar ship grid.
PlanarShipGridBuilder Class Represents a NXOpen.Display.PlanarShipGrid builder.
PlaneGrid Class Represents a grid on a bounded plane
PlaneGridBuilder Class Represents the builder for adding a bounded grid NXOpen.Display.PlaneGrid to a plane.
PointCloud Class Represents a NXOpen.Display.PointCloud imported from point data files.
PointCloudBuilder Class Represents a Display.PointCloudBuilder.
PointCloudClippingBoxesListItemBuilder Class Represents a NXOpen.Display.PointCloudClippingBoxesListItemBuilder to create clipping regions for NXOpen.Display.PointCloud.
PointCloudClippingBoxesListItemBuilderList Class Represents a list of objects.
PointCloudCollection Class Represents a collection of point cloud objects
RasterImage Class Represents a NXOpen.Display.RasterImage that provides placing an imported image onto a plane (with controls for orientation, sizing, and display) to use as a reference in the model to create geometry.
RasterImageBuilder Class Represents a NXOpen.Display.RasterImageBuilder.
RayTracedStudioBuilder Class Represents a NXOpen.Display.RayTracedStudioBuilder.
RayTracedStudioEditorBuilder Class Represents a NXOpen.Display.RayTracedStudioEditorBuilder.
Reflection Class Represents a NXOpen.Display.Reflection Reflection defines the source of reflection in shiny objects for Studio rendering style or High Quality Images.
SaveImageFileBrowserBuilder Class Represents a NXOpen.Display.SaveImageFileBrowserBuilder.
Scene Class Represents a NXOpen.Display.Scene A scene is comprised of background, stage, reflection, lights and image-based lighting subobjects.
SectionCurveSettingsBuilder Class Represents a NXOpen.Display.SectionCurveSettingsBuilder
SelPref Class Represents a NXOpen.Display.SelPref
SelPrefCollection Class Represents a collection SelPref
SelectFontFileBuilder Class This class is being used in conjunction with the Select Font File dialog, which is (at least so far) only for internal debugging use.
Shadows Class Represents a NXOpen.Display.Shadows
Stage Class Represents a NXOpen.Display.Stage A stage is an environment cube, a six-sided room, that can have between one and six visible walls.
StudioImageCaptureBuilder Class Represents a NXOpen.Display.StudioImageCaptureBuilder
TransientText Class Represents temporary text strings which can be used for Temporary Display
TrueShading Class Represents a True Shading object
TrueShadingBuilder Class Represents a NXOpen.Display.TrueShading builder
TrueShadingCollection Class Represents a collection SHED objects
TrueStudio Class Represents a True Shading object
TrueStudioBuilder Class The TrueStudioBuillder manages Advanced Studio visualization display
TrueStudioCollection Class Represents a collection TrueStudio objects
Wall Class Represents a NXOpen.Display.Wall

Enumerations

BackgroundBackgroundDomeType Enumeration dome types
BackgroundCategoryType Enumeration background 2D3D types
BackgroundType Enumeration background types
BoundedGridBuilderLabelReferenceType Enumeration Specifies label reference.
BoundedGridBuilderShowLabelType Enumeration Specifies label option to be used for grid label display.
CameraBuilderAperture Enumeration Predefined apertures: f2.
CameraBuilderFovMeasured Enumeration either horizontal or vertical measure
CameraBuilderLensAngle Enumeration the way to define the field of view angle
CameraBuilderLensFlare Enumeration Predefined lens flare types: Standard, 35mm, 50mm, 105mm, polygonal, 35mm poly, 50mm poly, 105mm poly, spark, star
CameraBuilderStockLens Enumeration Predefined lenses: 28, 35, 50, 70, 105, 135, 210, 300mm
CameraBuilderTypes Enumeration the camera types
CanonMRTestBuilderImageUsageType Enumeration Indicates how the image identified by ImageFile is specified to CGP.
DatumPlaneGridBuilderGridOrientationType Enumeration Specifies grid orientation option to be used for grid display.
DecalBuilderAnchor Enumeration image anchor
DecalBuilderDecalIllumination Enumeration decal illumination type
DecalBuilderDecalReflectivities Enumeration decal reflectivity type
DecalBuilderImageSize Enumeration image size type
DecalBuilderScaling Enumeration decal scaling type
DynamicSectionTypesActivePlane Enumeration Specifies active clip plane in the active plane pair.
DynamicSectionTypesAxis Enumeration Specifies axis.
DynamicSectionTypesCapColorOption Enumeration Specifies cap color type to be used for the cap.
DynamicSectionTypesClip Enumeration Specifies clipping type.
DynamicSectionTypesCoordinateSystem Enumeration Specifies the coordinate system used for creating principal planes i.
DynamicSectionTypesCurveColorOption Enumeration Specifies the color of the curves created by the section plane.
DynamicSectionTypesType Enumeration Specifies different type of sectioning.
EnvironmentBuilderGroundPlaneTypes Enumeration Represents an index to a ground plane type define
EnvironmentBuilderImageBlurType Enumeration lighting image blurr type
EnvironmentBuilderImageUpVectorTypes Enumeration up vector type
EnvironmentBuilderToneMappingTypes Enumeration tone mapping type - do not enable until NX11
FacetSettingsBuilderAdvVisToleranceSetting Enumeration Specifies which set of tolerances are to be used for rendering facets for display for Advanced Visualization views.
FacetSettingsBuilderFacetScale Enumeration Denotes what type of scaling factor is applied to the corresponding tolerances used to generate facets.
FacetSettingsBuilderFacetToViewRatio Enumeration Specifies whether the ratio of the view scale to the scale used to generate facets is determined automatically by the system (as was always done before NX 8) or whether a ratio defined by the user (by one of the set_*FacetRatio methods) is to be used as the ratio.
FacetSettingsBuilderFacetUpdate Enumeration Specifies whether an Update Display or Fit operation is to regenerate the facets for only visible objects, for all objects or for no objects.
FacetSettingsBuilderShadedToleranceSetting Enumeration Specifies which set of tolerances are to be used for rendering facets for display for Shaded views.
GridBuilderLineStyleType Enumeration Specifies line style to be used for major and minor lines of the grid.
GridBuilderLineWeightType Enumeration Specifies line weight to be used for major and minor lines of the grid.
IRayPlusStudioEditorBuilderDynamicIRayPlusStudioRenderModeType Enumeration To specify the quality and performance of the Ray Traced Studio display when dynamic interaction stops
IRayPlusStudioEditorBuilderIRayPlusStudioRemoteRenderFormatType Enumeration To specify the Ray Traced Studio remote rendering format
IRayPlusStudioEditorBuilderIRayPlusStudioRemoteRenderType Enumeration To specify the Ray Traced Studio remote rendering type
IRayPlusStudioEditorBuilderIRayPlusStudioRemoteRenderVideoType Enumeration To specify the Ray Traced Studio remote rendering video mode
IRayPlusStudioEditorBuilderIRayPlusStudioStaticImageFileFormatType Enumeration To specify the Ray Traced Studio static image file format
IRayPlusStudioEditorBuilderIRayPlusStudioStaticImageOrientationType Enumeration To specify the Ray Traced Studio static image orientation
IRayPlusStudioEditorBuilderIRayPlusStudioStaticImageResolutionType Enumeration To specify the Ray Traced Studio static image resolution
IRayPlusStudioEditorBuilderIRayPlusStudioStaticImageSizeType Enumeration To specify the Ray Traced Studio static image size
IRayPlusStudioEditorBuilderIRayPlusStudioStaticImageUnitsType Enumeration To specify the Ray Traced Studio static image units
ImageBaseBuilderBasePointChoices Enumeration Specifies image reference base point choice.
ImageBaseBuilderImageColorModes Enumeration Describes image color modes.
ImageBaseBuilderInsertionPoint Enumeration Describes insertion point type.
ImageBaseBuilderReferenceDirection Enumeration Specifies image alignment reference direction type.
ImageBaseBuilderSizeOptions Enumeration Describes size options.
ImageBaseBuilderTransparencyColorFrom Enumeration Transparency Color From
ImageBasedLightingImageBlurType Enumeration lighting image blurr type
ImageBasedLightingImageUpVectorTypes Enumeration up vector type
ImageBasedLightingImagesType Enumeration images type - environment used for generating image-based lighting
ImageBasedLightingShadowsType Enumeration shadow type
IrayPlusMaterialEditorBuilderLayerType Enumeration Layer types used in iray plus material
IrayPlusSimpleMaterialEditorBuilderTextureSpace Enumeration texture spacee type
LayerSettingsBuilderLayerOptionType Enumeration Specifies the layer options.
LightBuilderLightMode Enumeration light_mode
LightBuilderShadowType Enumeration shadow types
NonProportionalZoomMethodType Enumeration Sets the kind of mouse interaction that will define the non-proportional zoom.
PlanarShipGridBuilderIntersectOption Enumeration Settings that indicate how to search for objects that intersect the plane.
PlanarShipGridBuilderLabelDisplayOption Enumeration Settings that indicate what grid lines should be labelled.
PointCloudBuilderBrightnessModes Enumeration Specifies point cloud brightness display mode choice.
PointCloudBuilderColorModes Enumeration Specifies point cloud color display mode choice.
PointCloudClippingBoxesListItemBuilderClippingSides Enumeration Specifies clipping side options used for defined clipping box.
RayTracedStudioBuilderStationaryDisplayQualityType Enumeration To specify the quality and performance of the Ray Traced Studio display.
RayTracedStudioEditorBuilderDynamicRayTracedStudioTilingQualityType Enumeration To specify the quality and performance of the interactive, dynamic Ray Traced Studio display.
RayTracedStudioEditorBuilderRayTracedStudioStaticImageFileFormatType Enumeration To specify the Ray Traced Studio static image file format
RayTracedStudioEditorBuilderRayTracedStudioStaticImageOrientationType Enumeration To specify the Ray Traced Studio static image orientation
RayTracedStudioEditorBuilderRayTracedStudioStaticImageResolutionType Enumeration To specify the Ray Traced Studio static image resolution
RayTracedStudioEditorBuilderRayTracedStudioStaticImageSizeType Enumeration To specify the Ray Traced Studio static image size
RayTracedStudioEditorBuilderRayTracedStudioStaticImageUnitsType Enumeration To specify the Ray Traced Studio static image units
RayTracedStudioEditorBuilderStaticAntialiasingType Enumeration To specify the antialiasing quality during stationary Ray Traced Studio display during static image rendering
RayTracedStudioEditorBuilderStaticRayTracedStudioQualityType Enumeration To specify the quality and performance of the Ray Traced Studio display during static image rendering
RayTracedStudioEditorBuilderStationaryAntialiasingType Enumeration To specify the antialiasing quality during stationary Ray Traced Studio display when dynamic interaction stops
RayTracedStudioEditorBuilderStationaryRayTracedStudioQualityType Enumeration To specify the quality and performance of the Ray Traced Studio display when dynamic interaction stops
ReflectionType Enumeration where the reflections for rendering will be obtained
SaveImageFileBrowserBuilderFileFormats Enumeration To specify the Ray Traced Studio static image file format
SectionCurveSettingsBuilderColorOptionType Enumeration Specifies the color of the curves.
SelPrefFaceAnalysisViews Enumeration Represents the face analysis views type
SelPrefMethod Enumeration Represents the chaining method type
SelPrefMouseGesture Enumeration Represents the mouse gesture type
SelPrefSelectionRadius Enumeration Represents the selection radius type
SelPrefSelectionRule Enumeration Represents the selection rule type
SelPrefShadedViews Enumeration Represents the shaded views type
SelectFontFileBuilderFontCyclingType Enumeration Specifies whether available fonts are automatically cycled.
SelectFontFileBuilderGeometryType Enumeration Specifies the coordinate spaces of text geometry.
SelectFontFileBuilderHiddenStyleType Enumeration Specifies the behavior of hidden text.
SelectFontFileBuilderJustificationType Enumeration Specifies how glyphs are justified in the text box.
SelectFontFileBuilderLayoutType Enumeration Identifies the text layout, which defines the direction in which glyphs advance or flow along a single line, and the direction in which lines advance or flow along a page.
SelectFontFileBuilderRefLocation Enumeration Identifies the location on the text box used to position text.
SelectFontFileBuilderRotation2dType Enumeration Specifies how Screen text is rotated in the plane of the screen.
ShadowsRealTimeState Enumeration Real time type settings - environment_shadow_catcher_only is enabled only in Basic Studio mode
ShadowsSsaoContrastType Enumeration Shadows SSAO contrast settings
ShadowsSsaoQualityType Enumeration Shadows SSAO quality settings
StageOrientationType Enumeration Represents an index to a floor plane type define
StageWallType Enumeration Represents an index to a particular wall in the stage.
StudioImageCaptureBuilderAASamplesEnumType Enumeration Provide the following anti-aliasing sample size for off screen image capture
StudioImageCaptureBuilderDPIEnumType Enumeration Provide the following screen capture resolutions in dots per inch
StudioImageCaptureBuilderDrawingSizeEnumType Enumeration Provide the following standard Drawing sizes
StudioImageCaptureBuilderOrientEnumType Enumeration Provide the following options to image orientation
StudioImageCaptureBuilderUnitsEnumType Enumeration Provide the following resolution unit options to screen capture
TransientTextStandardTextRef Enumeration This enumerated type specifies the type of reference point used in the text box for standard_text methods.
TransientTextTextSize Enumeration Provides a way to specify the size of the desired text, as small, medium or large (normal is a synonym for medium).
TransientTextViewType Enumeration the view or views in which the transient text is to be displayed.
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
TrueStudioBuilderGlobalMaterial Enumeration Types of True Studio Global Material display.
TrueStudioBuilderRenderMethod Enumeration Types of True Studio Render Methods.
WallMaterialTextureType Enumeration the new wall material texture type
WallMaterialType Enumeration Defines the material characteristics of a stage wall.