Share

DisplayOptions Object


Description

The DisplayOptions object provides access to properties that provide read and write access of the display related application options. This is somewhat equivalent to the Display tab of the Application Options dialog.

Properties

Name Description
Application Returns the top-level parent application object. When used the context of Inventor, an Application object is returned. When used in the context of Apprentice, an ApprenticeServer object is returned.
AreTexturesOn Gets and sets whether to turn textures on.
AutoUpdateReferringDocuments Enable/Disable automatically update referring documents.
DefaultOrbitType Gets/sets the default behavior for the orbit command.
DepthDimming Read-write property that enables or disables the depth dimming effect that displays entities that are nearer with a brighter light to better convey the depth of the model. Setting this property to True enables the depth dimming effect.
DisplayQuality Specifies the resolution quality to apply to the display of the model.
DisplaySilhouettes Read-write property that specifies whether to display silhouette edges for active components.
EdgeColor Read-write property that gets and sets the color for the edge display (including silhouettes) for active components.
EnableSmoothSketchLines Gets/sets whether to use the smooth sketch line.
HiddenLineDimmingPercent Gets/sets the dimming factor (expressed as a percentage) applied to the display of hidden lines in the model.
InactiveComponentsEdgeColor Read-write property that gets and sets the color for the edge display (including silhouettes) for inactive components.
InactiveComponentsEdgeDisplay Read-write property that specifies whether edges should be displayed for inactive components.
InactiveComponentsEdgeDisplayFollowVisibility Read-write property that specifies whether inactive component edges display should follow the visibility setting of visual styles.
InactiveComponentsShaded Read-write property that enables or disables contrasting shading for the display of inactive components.
InactiveComponentsShadeOpacity Read-write property that gets and sets the opacity level (expressed as a percentage) for the shading of inactive components.
MinimumFrameRate Gets/sets the number of frames to display for the model during interactive viewing operations like Rotate, Pan and Zoom.
NewWindowDisplayMode Gets/sets the default display mode for new windows.
NewWindowProjectionType Gets/sets the default projection type for new windows.
NewWindowShowAmbientShadows Gets and sets whether to display ambient shadows (occlusions) for new windows.
NewWindowShowGroundPlane Read-write property that gets and sets whether to display ground planes for new windows.
NewWindowShowGroundReflections Read-write property that gets and sets whether to display ground plane reflections for new windows.
NewWindowShowGroundShadows Gets and sets whether to display ground shadows for new windows.
NewWindowShowObjectShadows Gets and sets whether to display object shadows for new windows.
RayTracingQuality Gets and sets the quality used when ray tracing is enabled.
ReverseZoomDirection Gets/sets the zoom direction with respect to the movement of the mouse cursor or mouse wheel.
Show3DIndicator Show/Hide 3D indicator.
ShowXYZAxisLabels Gets and sets whether to show axis labels for the 3D indicator (triad).
SolidLinesForHiddenEdges Gets/sets whether the hidden model edges should be displayed as solid lines.
TransparentComponentsEdgeColor Read-write property that gets and sets the color for the edge display (including silhouettes) for transparent components.
TransparentComponentsEdgeDisplay Read-write property that specifies whether edges should be displayed for transparent components.
TransparentComponentsEdgeDisplayFollowVisibility Read-write property that specifies whether transparent component edges display should follow the visibility setting of visual styles.
TransparentComponentsShaded Read-write property that enables or disables contrasting shading for the display of transparent components.
TransparentComponentsShadeOpacity Read-write property that gets and sets the opacity level (expressed as a percentage) for the shading of transparent components.
Type Returns an ObjectTypeEnum indicating this object's type.
UseDocumentDisplaySettings Read-write property that gets and sets whether to use the display appearance settings defined in the document. If set to False, the application level display settings are used.
UseNearestModelPointForOrbit Gets/sets whether to use the nearest model point to the mouse position as orbit pivot.
UseRayTracingForRealisticDisplay Gets and sets whether to enable ray tracing in realistic visual styles for new windows.
ViewTransitionTime Gets/sets the time taken to transition between views of a model.
ZoomToCursor Gets/sets whether the cursor position is the focus point for the zoom operation.

Accessed From

Application.DisplayOptions, ApprenticeServer.DisplayOptions, ApprenticeServerComponent.DisplayOptions, InventorServer.DisplayOptions, InventorServerObject.DisplayOptions

Version

Introduced in version 11

Was this information helpful?