Package | Description |
---|---|
nxopen |
Provides classes and interfaces for the NX Open Common API.
|
nxopen.annotations |
Provides classes and interfaces relating to Dimensions, Notes, Symbols, PMI, and other Annotations.
|
nxopen.cae.xyplot |
Provides classes and interfaces for XY Graphing.
|
nxopen.display |
Provides classes and interfaces for display.
|
Class and Description |
---|
Background
Represents a
Background
Background defines how background pixels are displayed. |
CameraCollection
Represents a collection cameras
To obtain an instance of this class, refer to BasePart Created in NX5.0.0 |
CgfxAttrCollection
Deprecated.
Deprecated in NX10.0.0. No alternative provided for this class.
|
CgfxMattexCollection
Deprecated.
Deprecated in NX10.0.0. No alternative provided for this class.
|
DecalCollection
Represents a collection decal material texture
This class is restricted to being called from a program running during an Interactive NX session. |
DynamicSection
Represents a dynamic section
To create or edit an instance of this class, use DynamicSectionBuilder Created in NX6.0.0 |
DynamicSectionBuilder
Represents a Dynamic Section Builder used for creating sections.
|
DynamicSectionCollection
Represents a collection of dynamic section objects
To obtain an instance of this class, refer to BasePart Created in NX6.0.0 |
ExtractScene
Represents a
ExtractScene
This class is restricted to being called from a program running during an Interactive NX session. |
FacetSettingsBuilder
Represents a
FacetSettingsBuilder
Facet Settings are not supported in KF. |
GlobalIlluminationBuilder
Represents a
GlobalIlluminationBuilder . |
GridCollection
Represents a collection of plane grid objects
To obtain an instance of this class, refer to BasePart Created in NX6.0.0 |
Image
Represents a
Image
This class is restricted to being called from a program running during an Interactive NX session. |
ImageBasedLighting
Represents a
ImageBasedLighting
Image-based Lighting (IBL) is only performed in High Quality Image
renderings. |
ImageCollection
Represents a collection of image objects
To obtain an instance of this class, refer to BasePart Created in NX9.0.0 |
ImageDataCollection
Represents a collection of
ImageData
objects. |
LightBuilder
Represents a
LightBuilder
This class is restricted to being called from a program running during an Interactive NX session. |
Lighting
Represents a
Lighting
Lights are used to illuminate the scene in Shaded and Studio rendering
styles, as well as in High Quality Images. |
NonProportionalZoom
Provides non-proportional zoom capability
To create a new instance of this class, use ViewCollection.createNonProportionalZoom() Default values. |
PerspectiveOptionsBuilder
Represents a
PerspectiveOptionsBuilder
Cameras are not supported in KF. |
RayTracedStudioBuilder
Represents a
RayTracedStudioBuilder . |
RayTracedStudioEditorBuilder
Represents a
RayTracedStudioEditorBuilder . |
Reflection
Represents a
Reflection
Reflection defines the source of reflection in shiny objects for Studio
rendering style or High Quality Images. |
SaveImageFileBrowserBuilder
Represents a
SaveImageFileBrowserBuilder . |
Scene
Represents a
Scene
A scene is comprised of background, stage, reflection, lights and
image-based lighting subobjects. |
SelPrefCollection
Represents a collection SelPref
To obtain an instance of this class, refer to BasePart Created in NX5.0.0 |
Shadows
Represents a
Shadows
This class is restricted to being called from a program running during an Interactive NX session. |
Stage
Represents a
Stage
A stage is an environment cube, a six-sided room, that can have between
one and six visible walls. |
Stage.WallType
Represents an index to a particular wall in the
stage.
|
StudioImageCaptureBuilder
Represents a
StudioImageCaptureBuilder
This class is restricted to being called from a program running during an Interactive NX session. |
TransientText
Represents temporary text strings which can be used for Temporary Display .
|
TrueShadingCollection
Represents a collection SHED objects
To obtain an instance of this class, refer to BasePart Created in NX6.0.0 |
TrueStudioCollection
Represents a collection TrueStudio objects
To obtain an instance of this class, refer to BasePart Created in NX6.0.0 |
Wall
Represents a
Wall
This class is restricted to being called from a program running during an Interactive NX session. |
Class and Description |
---|
DynamicSection
Represents a dynamic section
To create or edit an instance of this class, use DynamicSectionBuilder Created in NX6.0.0 |
DynamicSectionBuilder
Represents a Dynamic Section Builder used for creating sections.
|
IDynamicSectionCutCreator
Represents a dynamic section-cut creator that generates dynamic
section-cuts (see
DynamicSectionCut ). |
Class and Description |
---|
TransientText.TextSize
Provides a way to specify the size of the desired text, as small,
medium or large (normal is a synonym for medium).
|
Class and Description |
---|
Background
Represents a
Background
Background defines how background pixels are displayed. |
Background.Type
background types
|
BoundedGrid
Represents a bounded grid
Bounded grids are not supported in KF. |
BoundedGridBuilder
Represents the builder for creating a bounded grid
BoundedGrid . |
BoundedGridBuilder.CornerPointsData
This class holds the data returned from
BoundedGridBuilder.getCornerPoints() |
BoundedGridBuilder.LabelReferenceType
Specifies label reference.
|
BoundedGridBuilder.ShowLabelType
Specifies label option to be used for grid label display.
|
Camera |
CameraBuilder
Represents a
CameraBuilder
Cameras are not supported in KF. |
CameraBuilder.Aperture
Predefined apertures: f2.8, f5.6, f8, f11, f16, f22
|
CameraBuilder.FovMeasured
either horizontal or vertical measure
|
CameraBuilder.LensAngle
the way to define the field of view angle
|
CameraBuilder.LensFlare
Predefined lens flare types: Standard, 35mm, 50mm, 105mm,
polygonal, 35mm poly, 50mm poly, 105mm poly, spark, star
|
CameraBuilder.StockLens
Predefined lenses: 28, 35, 50, 70, 105, 135, 210, 300mm
|
CameraBuilder.Types
the camera types
|
CgfxAttributeValueColor3Builder
Deprecated.
Deprecated in NX10.0.0. No alternative provided for this class.
|
CgfxAttributeValueColor4Builder
Deprecated.
Deprecated in NX10.0.0. No alternative provided for this class.
|
CgfxAttributeValueFileBuilder
Deprecated.
Deprecated in NX10.0.0. No alternative provided for this class.
|
CgfxAttributeValueFloat3Builder
Deprecated.
Deprecated in NX10.0.0. No alternative provided for this class.
|
CgfxAttributeValueFloat4Builder
Deprecated.
Deprecated in NX10.0.0. No alternative provided for this class.
|
CgfxAttributeValueIntegerBuilder
Deprecated.
Deprecated in NX10.0.0. No alternative provided for this class.
|
CgfxAttributeValueNumberBuilder
Deprecated.
Deprecated in NX10.0.0. No alternative provided for this class.
|
CgfxMattexBuilder
Deprecated.
Deprecated in NX10.0.0. No alternative provided for this class.
|
CgfxMattexBuilder.Technique
Deprecated.
The technique is an index to a technique name in a list found in the CgFX file.
|
CgfxMattexBuilder.TextureSpace
Deprecated.
Deprecated in NX7.5.2. Use
CgfxMattexBuilder.TextureSpaceShader instead.
|
CgfxMattexBuilder.TextureSpaceShader
Deprecated.
The texture space shader type indicates the type of texture space shader to use for CgFX shader
|
CgfxMattexBuilder.UseCameraDirectionPlane
Deprecated.
The option indicates which texture space vectors are updated upon Update Texture to Camera Direction action
|
DatumPlaneGrid
Represents a grid on a datum plane
Datum plane grids are not supported in KF. |
DatumPlaneGridBuilder
Represents the builder for adding a datum plane grid
DatumPlaneGrid
to a datum plane. |
DatumPlaneGridBuilder.GridOrientationType
Specifies grid orientation option to be used for grid display.
|
DecalBuilder
Represents a
DecalBuilder
This class is restricted to being called from a program running during an Interactive NX session. |
DecalBuilder.Anchor
image anchor
|
DecalBuilder.DecalIllumination
decal illumination type
|
DecalBuilder.ImageSize
image size type
|
DecalBuilder.Scaling
decal scaling type
|
DynamicSection
Represents a dynamic section
To create or edit an instance of this class, use DynamicSectionBuilder Created in NX6.0.0 |
DynamicSectionBuilder
Represents a Dynamic Section Builder used for creating sections.
|
DynamicSectionBuilder.ActivePlaneData
This class holds the data returned from
DynamicSectionBuilder.getActivePlane() |
DynamicSectionBuilder.LoadAllIntersectingData
This class holds the data returned from
DynamicSectionBuilder.loadAllIntersecting() |
DynamicSectionBuilder.OffsetLimitsData
This class holds the data returned from
DynamicSectionBuilder.getOffsetLimits() |
DynamicSectionCut |
DynamicSectionTypes.ActivePlane
Specifies active clip plane in the active plane pair.
|
DynamicSectionTypes.Axis
Specifies axis.
|
DynamicSectionTypes.CapColorOption
Specifies cap color type to be used for the cap.
|
DynamicSectionTypes.Clip
Specifies clipping type.
|
DynamicSectionTypes.CoordinateSystem
Specifies the coordinate system used for creating
principal planes i.e.
|
DynamicSectionTypes.CurveColorOption
Specifies the color of the curves created by the
section plane.
|
DynamicSectionTypes.Type
Specifies different type of sectioning.
|
EntitySelectionPlane
Represents a grid on a datum plane
Entity selection planes are not supported in KF. |
FacetSettingsBuilder.AdvVisToleranceSetting
Specifies which set of tolerances are to be used for rendering facets
for display for Advanced Visualization views.
|
FacetSettingsBuilder.FacetScale
Denotes what type of scaling factor is applied to the corresponding tolerances used to generate facets.
|
FacetSettingsBuilder.FacetToViewRatio
Deprecated.
Deprecated in NX9.0.0. Refer to
FacetSettingsBuilder.FacetScale instead
|
FacetSettingsBuilder.FacetUpdate
Specifies whether an Update Display or Fit operation is to
regenerate the facets for only visible objects, for all objects or
for no objects.
|
FacetSettingsBuilder.ShadedToleranceSetting
Specifies which set of tolerances are to be used for rendering facets
for display for Shaded views.
|
Grid
Represents a grid
Grids are not supported in KF. |
GridBuilder
Represents the builder for adding a grid
Grid
This is an abstract class, and cannot be instantiated. |
GridBuilder.LineStyleType
Specifies line style to be used for major and minor lines of the grid.
|
GridBuilder.LineWeightType
Specifies line weight to be used for major and minor lines of the grid.
|
IDynamicSectionCutCreator
Represents a dynamic section-cut creator that generates dynamic
section-cuts (see
DynamicSectionCut ). |
Image
Represents a
Image
This class is restricted to being called from a program running during an Interactive NX session. |
ImageBase
Represents a
ImageBase that provides
definition, orientation, sizing, and display setting controls for image
based objects. |
ImageBaseBuilder
Represents a
ImageBaseBuilder . |
ImageBaseBuilder.BasePointChoices
Specifies image reference base point choice.
|
ImageBaseBuilder.CornerPointsData
This class holds the data returned from
ImageBaseBuilder.getCornerPoints() |
ImageBaseBuilder.ImageColorModes
Describes image color modes.
|
ImageBaseBuilder.InsertionPoint
Describes insertion point type.
|
ImageBaseBuilder.ReferenceDirection
Specifies image alignment reference direction type.
|
ImageBaseBuilder.SizeOptions
Describes size options.
|
ImageBaseBuilder.TransparencyColorFrom
Transparency Color From
|
ImageBasedLighting
Represents a
ImageBasedLighting
Image-based Lighting (IBL) is only performed in High Quality Image
renderings. |
ImageBasedLighting.ImageBlurType
lighting image blurr type
|
ImageBasedLighting.ImagesType
images type - environment used for generating image-based lighting
|
ImageBasedLighting.ImageUpVectorTypes
up vector type
|
ImageBasedLighting.ShadowsType
shadow type
|
ImageData
Represents a
ImageData that stores the
contents of a previously imported image file in the part. |
LayerSettingsBuilder
Represents a builder for object layer settings.
|
LayerSettingsBuilder.LayerOptionType
Specifies the layer options.
|
LightBuilder
Represents a
LightBuilder
This class is restricted to being called from a program running during an Interactive NX session. |
LightBuilder.LightMode
light_mode
|
LightBuilder.ShadowType
shadow types
|
Lighting
Represents a
Lighting
Lights are used to illuminate the scene in Shaded and Studio rendering
styles, as well as in High Quality Images. |
NonProportionalZoom.MethodType
Sets the kind of mouse interaction that will define the non-proportional zoom.
|
PlanarShipGrid
Represents a planar ship grid.
|
PlanarShipGridBuilder
Represents a
PlanarShipGrid builder. |
PlanarShipGridBuilder.ExtentData
This class holds the data returned from
PlanarShipGridBuilder.getExtent() |
PlanarShipGridBuilder.IntersectOption
Settings that indicate how to search for objects that intersect the plane.
|
PlanarShipGridBuilder.LabelDisplayOption
Settings that indicate what grid lines should be labelled.
|
PlaneGrid
Represents a grid on a bounded plane
Plane grids are not supported in KF. |
PlaneGridBuilder
Represents the builder for adding a bounded grid
PlaneGrid
to a plane. |
RasterImage
Represents a
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
Represents a
RasterImageBuilder . |
RayTracedStudioBuilder.StationaryDisplayQualityType
To specify the quality and performance of the Ray Traced Studio display when dynamic interaction stops
|
RayTracedStudioEditorBuilder.DynamicRayTracedStudioTilingQualityType
To specify the quality and performance of the interactive, dynamic Ray Traced Studio display.
|
RayTracedStudioEditorBuilder.RayTracedStudioStaticImageFileFormatType
To specify the Ray Traced Studio static image file format
|
RayTracedStudioEditorBuilder.RayTracedStudioStaticImageOrientationType
To specify the Ray Traced Studio static image orientation
|
RayTracedStudioEditorBuilder.RayTracedStudioStaticImageResolutionType
To specify the Ray Traced Studio static image resolution
|
RayTracedStudioEditorBuilder.RayTracedStudioStaticImageSizeType
To specify the Ray Traced Studio static image size
|
RayTracedStudioEditorBuilder.RayTracedStudioStaticImageUnitsType
To specify the Ray Traced Studio static image units
|
RayTracedStudioEditorBuilder.StaticAntialiasingType
To specify the antialiasing quality during stationary Ray Traced Studio display during static image rendering
|
RayTracedStudioEditorBuilder.StaticRayTracedStudioQualityType
To specify the quality and performance of the Ray Traced Studio display during static image rendering
|
RayTracedStudioEditorBuilder.StationaryAntialiasingType
To specify the antialiasing quality during stationary Ray Traced Studio display when dynamic interaction stops
|
RayTracedStudioEditorBuilder.StationaryRayTracedStudioQualityType
To specify the quality and performance of the Ray Traced Studio display when dynamic interaction stops
|
Reflection
Represents a
Reflection
Reflection defines the source of reflection in shiny objects for Studio
rendering style or High Quality Images. |
Reflection.Type
where the reflections for rendering will be obtained
|
SaveImageFileBrowserBuilder.FileFormats
To specify the Ray Traced Studio static image file format
|
SectionCurveSettingsBuilder |
SectionCurveSettingsBuilder.ColorOptionType
Specifies the color of the curves.
|
SelPref
Represents a
SelPref
To obtain a instance of this class use Display.SelPrefCollection#createSelPref Created in NX5.0.0 |
SelPref.FaceAnalysisViews
Represents the face analysis views type
|
SelPref.Method
Represents the chaining method type
|
SelPref.MouseGesture
Represents the mouse gesture type
|
SelPref.SelectionRadius
Represents the selection radius type
|
SelPref.SelectionRule
Represents the selection rule type
|
SelPref.ShadedViews
Represents the shaded views type
|
Shadows.RealTimeState
Real time type settings - environment_shadow_catcher_only is enabled only in Basic Studio mode
|
Shadows.SsaoContrastType
Shadows SSAO contrast settings
|
Shadows.SsaoQualityType
Shadows SSAO quality settings
|
Stage
Represents a
Stage
A stage is an environment cube, a six-sided room, that can have between
one and six visible walls. |
Stage.OrientationType
Represents an index to a floor plane type define
|
Stage.WallType
Represents an index to a particular wall in the
stage.
|
StudioImageCaptureBuilder.AASamplesEnumType
Provide the following anti-aliasing sample size for off screen image capture
|
StudioImageCaptureBuilder.DPIEnumType
Provide the following screen capture resolutions in dots per inch
|
StudioImageCaptureBuilder.DrawingSizeEnumType
Provide the following standard Drawing sizes
|
StudioImageCaptureBuilder.OrientEnumType
Provide the following options to image orientation
|
StudioImageCaptureBuilder.UnitsEnumType
Provide the following resolution unit options to screen capture
|
TransientText.AbsoluteTextSizeData
This class holds the data returned from
TransientText.getAbsoluteTextSize() |
TransientText.StandardTextRef
This enumerated type specifies the type of reference point used in the text box
for standard_text methods.
|
TransientText.TextSize
Provides a way to specify the size of the desired text, as small,
medium or large (normal is a synonym for medium).
|
TransientText.ViewType
the view or views in which the transient text is to be displayed.
|
TrueShading
Represents a True Shading object
TrueShading is not supported in KF. |
TrueShadingBuilder
Represents a
TrueShading builder To create a new instance of this class, use TrueShadingCollection.createTrueShadingBuilder(nxopen.display.TrueShading) Created in NX6.0.0 |
TrueShadingBuilder.BgdImageType
Background image types
|
TrueShadingBuilder.BgdType
Background colors and image types
|
TrueShadingBuilder.EnvironmentMapType
Global environment reflection map types
|
TrueShadingBuilder.MaterialType
Global material and per object overriding material types
|
TrueShadingBuilder.SHEDLightCollectionType
Scene lighting collection types
|
TrueShadingBuilder.SurfaceOrientType
Shadow plane projection orientation types
|
TrueStudio
Represents a True Shading object
TrueStudio is not supported in KF. |
TrueStudioBuilder
The TrueStudioBuillder manages Advanced Studio visualization display
To create a new instance of this class, use TrueStudioCollection.createTrueStudioBuilder(nxopen.display.TrueStudio) Created in NX8.0.0 |
TrueStudioBuilder.GlobalMaterial
Types of True Studio Global Material display.
|
TrueStudioBuilder.RenderMethod
Types of True Studio Render Methods.
|
Wall
Represents a
Wall
This class is restricted to being called from a program running during an Interactive NX session. |
Wall.MaterialTextureType
the new wall material texture type
|
Wall.MaterialType
Deprecated.
Deprecated in NX10.0.0. Use
nxopen.display.Wall.WallMaterialTextureType instead.
|
Copyright 2011 Siemens Product Lifecycle Management Software Inc. All Rights Reserved.