Display Options#

Display options commands are used to store settings that specify how assemblies and parts are to be displayed and how annotations are to be rendered in a particular viewport.

Object features#

AssemblyDisplayOptions#

class AssemblyDisplayOptions[source]#

The AssemblyDisplayOptions object stores settings that specify how assemblies are to be displayed in a particular viewport. The AssemblyDisplayOptions object has no constructor. When you create a new viewport, the settings are copied from the current viewport.

Notes

This object can be accessed by:

import assembly
session.viewports[name].assemblyDisplay
session.viewports[name].layers[name].assemblyDisplay

Attributes:

bcs: Boolean: A Boolean specifying whether boundary conditions are shown. The default value is OFF.
connectors: Boolean: A Boolean specifying whether connectors are shown. The default value is OFF.
cnxEndPoints: Boolean: A Boolean specifying whether the connector end points are shown. This member is applicable only if connectors=ON. The default value is ON.
cnxLocalAxes: Boolean: A Boolean specifying whether the connector local coordinate system axes are shown. This member is applicable only if connectors=ON. The default value is ON.
cnxTypeLabels: Boolean: A Boolean specifying whether the connector section type labels are shown. This member is applicable only if connectors=ON. The default value is ON.
cnxTagDisplay: Boolean: A Boolean specifying whether the tag information is displayed along with the connector section type labels. This member is applicable only if connectors=ON and if cnxTypeLabels=ON. The default value is OFF.
constraints: Boolean: A Boolean specifying whether constraints are shown. The default value is OFF.
engineeringFeatures: Boolean: A Boolean specifying whether to display engineering features. The default value is OFF.
geometricRestrictions: Boolean: A Boolean specifying whether geometric restrictions are shown. The default value is OFF.
renderBeamProfiles: Boolean: A Boolean specifying whether to render the beam profiles. The default value is OFF.
beamScaleFactor: float: A Float specifying the beam profile scale factor. The beamScaleFactor must be greater than zero. The default value is 1.0.
predefinedFields: Boolean: A Boolean specifying whether fields and initial conditions are shown. The default value is OFF.
interactions: Boolean: A Boolean specifying whether interactions are shown. The default value is OFF.
loads: Boolean: A Boolean specifying whether loads are shown. The default value is OFF.
mesh: Boolean: A Boolean specifying whether the mesh is shown. The default value is OFF.
optimizationTasks: Boolean: A Boolean specifying whether optimization tasks are shown. The default value is OFF.
stopConditions: Boolean: A Boolean specifying whether stop conditions are shown. The default value is OFF.
renderStyle: SymbolicConstant: A SymbolicConstant specifying how the image in the viewport is rendered. Possible values are WIREFRAME, HIDDEN, SHADED, and FILLED. The default value is WIREFRAME.
bcOptions: BCDisplayOptions: A BCDisplayOptions object.
constraintOptions: ConstraintDisplayOptions: A ConstraintDisplayOptions object.
displayGroup: DisplayGroup: A DisplayGroup object specifying the current display group an object in the displayGroups member of Session.
displayGroupInstances: dict[str, DisplayGroupInstance]: A repository of DisplayGroupInstance objects.
engineeringFeatureOptions: EngineeringFeatureDisplayOptions: An EngineeringFeatureDisplayOptions object.
predefinedFieldOptions: PredefinedFieldDisplayOptions: A PredefinedFieldDisplayOptions object.
geometricRestrictionOptions: GeometricRestrictionDisplayOptions: A GeometricRestrictionDisplayOptions object.
geometryOptions: GeometryDisplayOptions: A GeometryDisplayOptions object.
interactionOptions: InteractionDisplayOptions: An InteractionDisplayOptions object.
loadOptions: LoadDisplayOptions: A LoadDisplayOptions object.
meshOptions: MeshDisplayOptions: A MeshDisplayOptions object.
optimizationTaskOptions: OptimizationTaskDisplayOptions: An OptimizationTaskDisplayOptions object.
stopConditionOptions: StopConditionDisplayOptions: A StopConditionDisplayOptions object.
symbolOptions: SymbolDisplayOptions: A SymbolDisplayOptions object.
visibleInstances: tuple: A tuple of Strings specifying the names of the part instances that are visible in the viewport. The default value is an empty sequence.
step: str: A String specifying the step for which objects are to be displayed. Possible values are any valid step name. The default value is “Initial”.

Methods

setValues([visibleInstances, step, ...])

This method modifies the AssemblyDisplayOptions object.

setValues(visibleInstances: tuple = (), step: str = '', renderStyle: SymbolicConstantType = 'WIREFRAME', mesh: BooleanType = 0, loads: BooleanType = 0, bcs: BooleanType = 0, interactions: BooleanType = 0, constraints: BooleanType = 0, connectors: BooleanType = 0, cnxEndPoints: BooleanType = 1, cnxLocalAxes: BooleanType = 1, cnxTypeLabels: BooleanType = 1, cnxTagDisplay: BooleanType = 0, predefinedFields: BooleanType = 0, visibleDisplayGroups: tuple[DisplayGroup] = (), engineeringFeatures: BooleanType = 0, renderBeamProfiles: BooleanType = 0, beamScaleFactor: float = 1, optimizationTasks: BooleanType = 0, geometricRestrictions: BooleanType = 0, stopConditions: BooleanType = 0)[source]#

This method modifies the AssemblyDisplayOptions object.

Parameters:

visibleInstances: A sequence of Strings specifying the names of the part instances that are visible in the viewport. The default value is an empty sequence.
step: A String specifying the step for which objects are to be displayed. Possible values are any valid step name. The default value is “Initial”.
renderStyle: A SymbolicConstant specifying how the image in the viewport is rendered. Possible values are WIREFRAME, HIDDEN, SHADED, and FILLED. The default value is WIREFRAME.
mesh: A Boolean specifying whether the mesh is shown. The default value is OFF.
loads: A Boolean specifying whether loads are shown. The default value is OFF.
bcs: A Boolean specifying whether boundary conditions are shown. The default value is OFF.
interactions: A Boolean specifying whether interactions are shown. The default value is OFF.
constraints: A Boolean specifying whether constraints are shown. The default value is OFF.
connectors: A Boolean specifying whether connectors are shown. The default value is OFF.
cnxEndPoints: A Boolean specifying whether the connector end points are shown. This member is applicable only if *connectors*=ON. The default value is ON.
cnxLocalAxes: A Boolean specifying whether the connector local coordinate system axes are shown. This member is applicable only if *connectors*=ON. The default value is ON.
cnxTypeLabels: A Boolean specifying whether the connector section type labels are shown. This member is applicable only if *connectors*=ON. The default value is ON.
cnxTagDisplay: A Boolean specifying whether the tag information is displayed along with the connector section type labels. This member is applicable only if *connectors*=ON and if *cnxTypeLabels*=ON. The default value is OFF.
predefinedFields: A Boolean specifying whether fields and initial conditions are shown. The default value is OFF.
visibleDisplayGroups: A sequence of DisplayGroup objects specifying the DisplayGroups visible in the viewport. Currently the sequence can contain a maximum of one DisplayGroup object. The default value is an empty sequence.
engineeringFeatures: A Boolean specifying whether to display engineering features. The default value is OFF.
renderBeamProfiles: A Boolean specifying whether to render the beam profiles. The default value is OFF.
beamScaleFactor: A Float specifying the beam profile scale factor. The beamScaleFactor must be greater than zero. The default value is 1.0.
optimizationTasks: A Boolean specifying whether optimization tasks are shown. The default value is OFF.
geometricRestrictions: A Boolean specifying whether geometric restrictions are shown. The default value is OFF.
stopConditions: A Boolean specifying whether stop conditions are shown. The default value is OFF.

Raises:

RangeError

BCDisplayOptions#

class BCDisplayOptions[source]#

The BCDisplayOptions object stores settings that specify how assemblies are to be displayed in a particular viewport when session.viewports[name].assemblyDisplay.bcs=ON The BCDisplayOptions object has no constructor. When you create a new viewport, the settings are copied from the current viewport.

Notes

This object can be accessed by:: session.viewports[name].assemblyDisplay.bcOptions session.viewports[name].layers[name].assemblyDisplay.bcOptions

Methods

setValues([displacement, velocity, ...])

This method modifies the BCDisplayOptions object.

setValues(displacement: BooleanType = 1, velocity: BooleanType = 1, acceleration: BooleanType = 1, symmetry: BooleanType = 1, antiSymmetry: BooleanType = 1, temperature: BooleanType = 1, porePressure: BooleanType = 1, fluidCavityPressure: BooleanType = 1, acousticPressure: BooleanType = 1, electricPotential: BooleanType = 1, concentration: BooleanType = 1, encastre: BooleanType = 1, pinned: BooleanType = 1)[source]#

This method modifies the BCDisplayOptions object.

Parameters:

displacement: A Boolean specifying whether displacement symbols are shown. The default value is ON.
velocity: A Boolean specifying whether velocity symbols are shown. The default value is ON.
acceleration: A Boolean specifying whether acceleration symbols are shown. The default value is ON.
symmetry: A Boolean specifying whether symmetry symbols are shown. The default value is ON.
antiSymmetry: A Boolean specifying whether anti- symmetry symbols are shown. The default value is ON.
temperature: A Boolean specifying whether temperature symbols are shown. The default value is ON.
porePressure: A Boolean specifying whether pore pressure symbols are shown. The default value is ON.
fluidCavityPressure: A Boolean specifying whether fluid cavity pressure symbols are shown. The default value is ON.
acousticPressure: A Boolean specifying whether acoustic pressure symbols are shown. The default value is ON.
electricPotential: A Boolean specifying whether electric potential symbols are shown. The default value is ON.
concentration: A Boolean specifying whether concentration mass diffusion symbols are shown. The default value is ON.
encastre: A Boolean specifying whether encastre symbols are shown. The default value is ON.
pinned: A Boolean specifying whether pinned symbols are shown. The default value is ON.

ConstraintDisplayOptions#

class ConstraintDisplayOptions[source]#

The ConstraintDisplayOptions object stores settings that specify how assemblies are to be displayed in a particular viewport when session.viewports[name].assemblyDisplay.constraints=ON The ConstraintDisplayOptions object has no constructor. When you create a new viewport, the settings are copied from the current viewport.

Notes

This object can be accessed by:: session.viewports[name].assemblyDisplay.constraintOptions session.viewports[name].layers[name].assemblyDisplay.constraintOptions

Methods

setValues([constraintEquation, ...])

This method modifies the ConstraintDisplayOptions object.

setValues(constraintEquation: BooleanType = 1, tieConstraint: BooleanType = 1, rigidBodyConstraint: BooleanType = 1, displayBodyConstraint: BooleanType = 1, couplingConstrain: BooleanType = 1)[source]#

This method modifies the ConstraintDisplayOptions object.

Parameters:

constraintEquation: A Boolean specifying whether constraint equation symbols are shown. The default value is ON.
tieConstraint: A Boolean specifying whether tie constraint symbols are shown. The default value is ON.
rigidBodyConstraint: A Boolean specifying whether rigid body constraint symbols are shown. The default value is ON.
displayBodyConstraint: A Boolean specifying whether display body constraint symbols are shown. The default value is ON.
couplingConstrain: A Boolean specifying whether coupling constraint symbols are shown. The default value is ON.

EngineeringFeatureDisplayOptions#

class EngineeringFeatureDisplayOptions[source]#

The EngineeringFeatureDisplayOptions object stores settings that specify how assemblies are to be displayed in a particular viewport when session.viewports[name].assemblyDisplay.engineeringFeatures=ON The EngineeringFeatureDisplayOptions object has no constructor. When you create a new viewport, the settings are copied from the current viewport.

Notes

This object can be accessed by:

session.viewports[name].assemblyDisplay.engineeringFeatureOptions
session.viewports[name].layers[name].assemblyDisplay.engineeringFeatureOptions
import part
session.viewports[name].layers[name].partDisplay.engineeringFeatureOptions
session.viewports[name].partDisplay.engineeringFeatureOptions

Methods

setValues([pointMassInertia, ...])

This method modifies the EngineeringFeatureDisplayOptions object.

setValues(pointMassInertia: BooleanType = 1, nonstructuralMass: BooleanType = 1, heatCapacitance: BooleanType = 1, contourIntegral: BooleanType = 1, springToGround: BooleanType = 1, twoPointSpring: BooleanType = 1)[source]#

This method modifies the EngineeringFeatureDisplayOptions object.

Parameters:

pointMassInertia: A Boolean specifying whether point mass inertia symbols are shown. The default value is ON.
nonstructuralMass: A Boolean specifying whether nonstructural mass symbols are shown. The default value is ON.
heatCapacitance: A Boolean specifying whether heat capacitance symbols are shown. The default value is ON.
contourIntegral: A Boolean specifying whether contour integral symbols are shown. The default value is ON.
springToGround: A Boolean specifying whether spring-to-ground symbols are shown. The default value is ON.
twoPointSpring: A Boolean specifying whether two-point spring symbols are shown. The default value is ON.

Raises:

RangeError

GeometricRestrictionDisplayOptions#

class GeometricRestrictionDisplayOptions[source]#

The GeometricRestrictionDisplayOptions object stores settings that specify how assemblies are to be displayed in a particular viewport when session.viewports[name].assemblyDisplay.geometricRestrictions=ON The GeometricRestrictionDisplayOptions object has no constructor. When you create a new viewport, the settings are copied from the current viewport.

Notes

This object can be accessed by:: session.viewports[name].assemblyDisplay.geometricRestrictionOptions session.viewports[name].layers[name].assemblyDisplay.geometricRestrictionOptions

Methods

setValues([drillControl, fixedRegion, ...])

This method modifies the GeometricRestrictionDisplayOptions object.

setValues(drillControl: BooleanType = 1, fixedRegion: BooleanType = 1, frozenArea: BooleanType = 1, growth: BooleanType = 1, penetrationCheck: BooleanType = 1, shapeDemoldControl: BooleanType = 1, designDirection: BooleanType = 1, shapeMemberSize: BooleanType = 1, shapePlanarSymmetry: BooleanType = 1, shapePointSymmetry: BooleanType = 1, shapeRotationalSymmetry: BooleanType = 1, stampControl: BooleanType = 1, slideRegionControl: BooleanType = 1, topologyCyclicSymmetry: BooleanType = 1, topologyDemoldControl: BooleanType = 1, topologyMemberSize: BooleanType = 1, topologyPlanarSymmetry: BooleanType = 1, topologyPointSymmetry: BooleanType = 1, topologyRotationalSymmetry: BooleanType = 1, turnControl: BooleanType = 1)[source]#

This method modifies the GeometricRestrictionDisplayOptions object.

Parameters:

drillControl: A Boolean specifying whether drill control geometric restriction symbols are shown. The default value is ON.
fixedRegion: A Boolean specifying whether fixed region geometric restriction symbols are shown. The default value is ON.
frozenArea: A Boolean specifying whether frozen area geometric restriction symbols are shown. The default value is ON.
growth: A Boolean specifying whether growth geometric restriction symbols are shown. The default value is ON.
penetrationCheck: A Boolean specifying whether penetration check geometric restriction symbols are shown. The default value is ON.
shapeDemoldControl: A Boolean specifying whether demold control (shape) geometric restriction symbols are shown. The default value is ON.
designDirection: A Boolean specifying whether design direction geometric restriction symbols are shown. The default value is ON.
shapeMemberSize: A Boolean specifying whether member size (shape) geometric restriction symbols are shown. The default value is ON.
shapePlanarSymmetry: A Boolean specifying whether planar symmetry (shape) geometric restriction symbols are shown. The default value is ON.
shapePointSymmetry: A Boolean specifying whether point symmetry (shape) geometric restriction symbols are shown. The default value is ON.
shapeRotationalSymmetry: A Boolean specifying whether rotational symmetry (shape) geometric restriction symbols are shown. The default value is ON.
stampControl: A Boolean specifying whether stamp control geometric restriction symbols are shown. The default value is ON.
slideRegionControl: A Boolean specifying whether slide region control geometric restriction symbols are shown. The default value is ON.
topologyCyclicSymmetry: A Boolean specifying whether cyclic symmetry geometric restriction symbols are shown. The default value is ON.
topologyDemoldControl: A Boolean specifying whether demold control (topology) geometric restriction symbols are shown. The default value is ON.
topologyMemberSize: A Boolean specifying whether member size (topology) geometric restriction symbols are shown. The default value is ON.
topologyPlanarSymmetry: A Boolean specifying whether planar symmetry (topology) geometric restriction symbols are shown. The default value is ON.
topologyPointSymmetry: A Boolean specifying whether point symmetry (topology) geometric restriction symbols are shown. The default value is ON.
topologyRotationalSymmetry: A Boolean specifying whether rotational symmetry (topology) geometric restriction symbols are shown. The default value is ON.
turnControl: A Boolean specifying whether turn control geometric restriction symbols are shown. The default value is ON.

Raises:

RangeError

GeometryDisplayOptions#

class GeometryDisplayOptions[source]#

The GeometryDisplayOptions object stores settings that specify how assemblies are to be displayed in a particular viewport. The GeometryDisplayOptions object has no constructor. When you create a new viewport, the settings are copied from the current viewport.

Notes

This object can be accessed by:

session.viewports[name].assemblyDisplay.geometryOptions
session.viewports[name].layers[name].assemblyDisplay.geometryOptions
session.viewports[name].layers[name].partDisplay.geometryOptions
session.viewports[name].partDisplay.geometryOptions

Methods

setValues([geometryEdgesInShaded, ...])

This method modifies the GeometryDisplayOptions object.

setValues(geometryEdgesInShaded: BooleanType = 1, geometryHiddenEdges: BooleanType = 0, geometrySilhouetteEdges: BooleanType = 1, datumAxes: BooleanType = 1, datumCoordSystems: BooleanType = 1, datumPlanes: BooleanType = 1, referencePointLabels: BooleanType = 1, referencePointSymbols: BooleanType = 1, referenceRepresentation: BooleanType = 0, referenceRepTranslucency: BooleanType = 1)[source]#

This method modifies the GeometryDisplayOptions object.

Parameters:

geometryEdgesInShaded: A Boolean specifying whether geometry edges are displayed in shaded mode. The default value is ON.
geometryHiddenEdges: A Boolean specifying whether geometry hidden edges are displayed (dotted) in hidden line mode. The default value is OFF.
geometrySilhouetteEdges: A Boolean specifying whether geometry silhouette edges are displayed. The default value is ON.
datumAxes: A Boolean specifying whether datum axes are shown. The default value is ON.
datumCoordSystems: A Boolean specifying whether datum coordinate systems are shown. The default value is ON.
datumPlanes: A Boolean specifying whether datum planes are shown. The default value is ON.
referencePointLabels: A Boolean specifying whether referencePoint labels are shown. The default value is ON.
referencePointSymbols: A Boolean specifying whether referencePoint symbols are shown. The default value is ON.
referenceRepresentation: A Boolean specifying whether geometry that belongs to the reference representation of the Part or Instance is shown. The default value is OFF.
referenceRepTranslucency: A Boolean specifying whether to apply translucency to the geometry that belongs to the reference representation of the Part or Instance. The default value is ON.

Raises:

RangeError

GraphicsInfo#

class GraphicsInfo[source]#

The GraphicsInfo object stores information about the graphics adapter installed in your system. The GraphicsInfo object has no constructor or methods; Abaqus creates the GraphicsInfo member when a session is started. If you execute Abaqus/CAE on a remote system and display the main window locally, the glx server is your local machine and the glx client is the remote machine. This definition of client and server follows the X11 naming convention. If you execute and display Abaqus/CAE on the same machine, you will typically see identical values for both the name of the server and the name of the client. The members are all read-only.

Notes

This object can be accessed by:

session.graphicsInfo

Attributes:

glVersion: tuple: A sequence of the type (Int, Int, String) specifying the three components of the OpenGL version. The sequence consists of an Int with the OpenGL major version number, an Int with the OpenGL minor version number, and a String with any additional information.
glxServerVersion: tuple: A sequence of the type (Int, Int, String) specifying the three components of the glx version of the server. The sequence consists of an Int with the glx major version number, an Int with the glx minor version number, and a String with any additional information.
glxClientVersion: tuple: A sequence of the type (Int, Int, String) specifying the three components of the of glx version of the client. The sequence consists of an Int with the glx major version number, an Int with the glx minor version number, and String with any additional information.
glVendor: str: A String specifying the graphics adapter vendor. On hardware accelerated systems glVendor specifies the vendor that manufactured the adapter. On systems without hardware acceleration glVendor specifies the developer of the software graphics library.
glRenderer: str: A String specifying the name of the rendering device or the name of the software graphics library.
glxServerVendor: str: A String specifying the glx developer on the server side.
glxClientVendor: str: A String specifying the glx developer on the client side.

GraphicsOptions#

class GraphicsOptions[source]#

The GraphicsOptions object stores settings that control how objects are rendered in all viewports. GraphicsOptions objects are accessed in one of two ways: - The default graphics options. These settings are used as defaults when you start a session and by the Defaults button on the Graphics ConstrainedSketchOptions dialog box. - The current graphics options. The GraphicsOptions object has no constructor; Abaqus creates both the defaultGraphicsOptions and the graphicsOptions members when a session is started. When you start a session, Abaqus detects the graphics hardware installed on your system and uses the setValues method in the environment file (abaqus_v6.env ) to modify the members of the GraphicsOptions object. If your graphics hardware is not supported by Abaqus/CAE, or if you wish to override the default graphics options, you can modify settings in the environment file. For more information, see Tuning graphics cards.

Notes

This object can be accessed by:

session.defaultGraphicsOptions
session.graphicsOptions

Attributes:

backgroundOverride: Boolean: A Boolean specifying whether a viewport background style of GRADIENT can be overridden when displaying certain objects, such as sketches or XY plots. When overridden, the background will be the top color of the gradient background.
backfaceCulling: Boolean: A Boolean specifying whether facets that are determined to be facing away from the viewer will be drawn. The default value is ON. backfaceCulling provides a performance enhancement when displaying solid elements where the front side of the element occludes the back side of the element. Set backfaceCulling=OFF if it appears that you are seeing the back side of an element and the front side is missing. You should also set backfaceCulling=OFF if you believe the display is not complete.
graphicsDriver: SymbolicConstant: A SymbolicConstant specifying the graphics driver to use. Abaqus/CAE currently uses OpenGL exclusively so the only possible value is OPEN_GL. OPEN_GL takes advantage of graphics adapter hardware acceleration.
doubleBuffering: Boolean: A Boolean specifying whether double buffering is used. The default value is ON.Double buffering controls where Abaqus/CAE draws its graphics. When doubleBuffering=OFF, everything is drawn directly to the screen and on many systems you can see the progress of the drawing operations. Most users find this distracting, especially in dynamic situations such as view manipulation or animation of results. When doubleBuffering=ON, the drawing occurs in a separate graphics buffer that is displayed when all the drawing operations are complete. This results in a much smoother display during view changes or animation. It is recommended that you set double buffering to ON.
displayLists: Boolean: A Boolean specifying whether a display list will be used to accelerate graphics performance. The default value is ON.When displayLists=ON, drawing operations are recorded in a list that can be quickly replayed. This results in faster drawing on most systems but requires extra memory to record the drawing operations. In the Visualization module, display lists are only used during view manipulations and then their use is subject to the setting of viewManipDisplayListThreshold.
dragMode: SymbolicConstant: A SymbolicConstant specifying which rendering is used during dynamic rotations of the view. Possible values are:FAST, specifying a rendering mode where the image is rendered in wireframe.AS_IS, specifying a rendering mode where the image is rendered as is.The default value is AS_IS.When set to dragMode=FAST, a wireframe outline is drawn during view changes by rotation, pan, or zoom. When dragMode=AS_IS, everything displayed in the window will be drawn during view changes; however, the display may lag behind the mouse movement when the model is complex especially if you are using an older or slower system. For newer systems with graphics hardware acceleration the AS_IS setting can be accommodated without significant loss of performance.
antiAlias: Boolean: A Boolean specifying whether lines will be smoothed to reduce the jagged effect of rasterization. The default value is ON.
autoFitAfterRotate: Boolean: A Boolean specifying whether the model is automatically resized to fit the viewport after each view rotation. The default value is OFF.
polygonOffsetConstant: float: A Float specifying the offset added when drawing the faces of a polygon. The polygonOffsetConstant argument affects the behavior of only the OpenGL driver. Possible values are 0.0 ≤≤ polygonOffsetConstant ≤≤ 100.0. The default value is platform dependent and is typically between 0.0 and 2.0.
polygonOffsetSlope: float: A Float specifying the factor that multiplies the slope of each line before the line is added to the vertexes of a polygon face. The polygonOffsetSlope argument affects the behavior of only the OpenGL driver. Possible values are 0.0 ≤≤ polygonOffsetSlope ≤≤ 100.0. The default value is platform dependent and is typically between 0.0 and 2.0.
printPolygonOffsetConstant: float: A Float specifying the offset added when drawing the faces of a polygon. printPolygonOffsetConstant is similar to polygonOffsetConstant; however, printPolygonOffsetConstant is used when printing and polygonOffsetConstant is used for display. Some systems, especially Windows, use different OpenGL drivers for printing and display, and you may have to use different offset values for each driver.
printPolygonOffsetSlope: float: A Float specifying the factor that multiplies the slope of each line before the line is added to the vertexes of a polygon face. printPolygonOffsetSlope is similar to polygonOffsetSlope; however, printPolygonOffsetSlope is used when printing and polygonOffsetSlope is used for display. Some systems, especially Windows, use different OpenGL drivers for printing and display, and you may have to use different offset values for each driver.
vertexArrays: Boolean: A Boolean specifying how the three-dimensional vertices of the model are processed. When vertexArrays=OFF, each vertex of the model is processed separately. When vertexArrays=ON, the vertices are processed in large blocks resulting in faster display. Not all graphics adapters support this capability correctly. An indicator that the graphics adapters is not processing three-dimensional vertices correctly is the absence of graphics during rubber banding operations. For example, when dynamically dragging the radius of a circle in the Sketcher, the circle should be visible. The default value is ON.
vertexArraysInDisplayLists: Boolean: A Boolean specifying whether the vertexArrays setting should temporarily be set to OFF when building a display list. The default value is ON.Some graphics adapters do not properly support using vertex arrays inside a display list. Setting vertexArraysInDisplayLists to OFF has a smaller impact on graphics performance than setting vertexArrays or displayLists to OFF.
viewManipDisplayListThreshold: int: An Int specifying how large a display list may be created in order to accelerate view manipulation operations. Increasing this value when viewing large models will increase the delay before a view manipulation operation begins in order to obtain improved graphics performance during the view manipulation. If set high with a large model, the delay can be many seconds. In excessive cases, graphics memory can be exceeded and the result may be an empty display list (no visible model) for the view manipulation. This setting is treated as 0 if displayLists=OFF. Possible values are 0 ≤≤ viewManipDisplayListThreshold ≤≤ 20000. The default value is 40.
directRendering: Boolean: A Boolean specifying how Abaqus renders X11 graphics operations. When directRendering=OFF, the graphics are rendered through the X Server. When directRendering=ON, the graphics operations are sent directly to the graphics adapter producing faster displays. For maximum performance, the initial value is ON. This argument is used only when you first start Abaqus/CAE; you cannot configure directRendering during a session.
hardwareAcceleration: Boolean: A Boolean specifying whether a hardware accelerated OpenGL graphics driver will be used on Windows platforms. The default value is ON.When hardwareAcceleration=OFF, the graphics driver uses a software implementation of OpenGL that is included with the operating system. This results in slower drawing on most systems; however, you may have to use the software implementation of OpenGL if the hardware graphics driver is incompatible with Abaqus/CAE.**hardwareAcceleration** is used only when you first start Abaqus/CAE on a Windows platform; you cannot configure hardwareAcceleration during a session.**hardwareAcceleration** is not used when you start Abaqus/CAE on an X-Windows platform and display to a Windows platform running Exceed or any other X-Windows server.
hardwareOverlay: Boolean: A Boolean specifying whether hardware overlay planes will be used if available. The default value is the same value as the hardwareOverlayAvailable member.When hardwareOverlayAvailable=OFF, it will not be possible to set hardwareOverlay to ON and the HARDWARE_OVERLAY highlight method will not be available. If viewports display a solid color and will not display the model, it will be necessary to inhibit hardware overlay completely by setting the ABAQUS_EMULATE_OVERLAYS environment variable (to any value) before starting Abaqus/CAE.**hardwareOverlay** is used only when you first start Abaqus/CAE; you cannot configure hardwareOverlay during a session.
textureMapping: Boolean: A Boolean specifying whether textures will be used to display contour plots. The default value is ON.Turning off texture mapping is necessary only if viewports will not correctly display a contour plot of your model.
printTextureMapping: Boolean: A Boolean specifying whether textures will be used to display contour plots. The default value is ON.Turning off texture mapping for printing is necessary only if printed output does not correctly display a contour plot of your model. printTextureMapping is similar to textureMapping; however, printTextureMapping is used when printing and textureMapping is used for display. Some systems, especially Windows, use different OpenGL drivers for printing and display, and you may have to use different settings for each driver.
backgroundStyle: SymbolicConstant: A SymbolicConstant specifying the background style to be used for all viewport windows. Possible values are SOLID and GRADIENT. The default value is SOLID.If backgroundStyle=SOLID, the viewport background will appear as a solid color as specified by backgroundColor. If backgroundStyle=GRADIENT, the viewport background will be drawn as a gradient beginning with the backgroundColor at the top of the viewport and gradually blending to the backgroundBottomColor at the bottom of the viewport.
accelerateOffScreen: Boolean: A Boolean specifying whether the hardware accelerated graphics driver will be used for off-screen rendering. The default value is ON if graphics hardware acceleration is available and has not been disabled via the hardwareAcceleration option, and the graphics driver supports the underlying technology. When set to OFF, an alternate (slower) technique will be used to create off-screen images. Off-screen rendering is used for Printing, Probe, and backing store (viewport refresh). Setting this value to OFF will force printed images to be rendered without hardware acceleration. This is useful when writing automated tests to produce raster images that you will want to compare across multiple machines that may have different graphics environments.
backingStore: Boolean: A Boolean specifying whether a backing store will be used to refresh a viewport after a window occluding the viewport is moved or dismissed. The default value is ON.
highlightMethod: SymbolicConstant: A SymbolicConstant specifying the highlight method. For the GraphicsOptions object, possible values of the member are HARDWARE_OVERLAY, XOR, SOFTWARE_OVERLAY, and BLEND.
hardwareOverlayAvailable: Boolean: A Boolean specifying if the graphics hardware supports hardware overlay.
shadersAvailable: Boolean: A Boolean specifying if the graphics hardware supports the OpenGL Shading Language (GLSL).
translucencyMode: int: An Int specifying whether speed or accuracy is more important when drawing translucent objects. Lower values optimize for speed while higher values optimize for accuracy. The actual meaning of each setting will depend on the setting of shadersAvailable and the capabilities of the graphics hardware and driver. Possible values are 1 ≤≤ translucencyMode ≤≤ 6. The default value is 4.
contourRangeTexturePrecision: float: A Float specifying a tolerance used when computing the appropriate scale for transforming result (contour) values to texture values. When set too low the ‘out of range’ colors may be incorrectly shown for values near the range limits. The default value is 0.5×10–5.
options: str: None or a GraphicsOptions object specifying the object from which values are to be copied. If o:py:class:~.the`r arguments are also supplied to setValues, :py:class:`~.the`y will override :py:class:`~.the values in the options member. The default value is None.
highlightMethodHint: SymbolicConstant: A tuple of SymbolicConstants specifying a hint used to modify the highlight method. Possible values are:HARDWARE_OVERLAY, specifying a hint of hardware overlay. The best graphics performance is achieved using hardware overlay, but not all systems and graphics adapters support hardware overlay.XOR, specifying a hint of XOR technique. The XOR technique uses a boolean pixel operation to simulate the drawing operations but can produce different colors depending on the color of the underlying pixels.SOFTWARE_OVERLAY, specifying a hint of software overlay. The software overlay method simulates the effect of hardware overlay.BLEND, specifying a hint of blend method. The blend method combines the color of the underlying pixel with the desired color producing an approximation of the transient graphics.The default value is (HARDWARE_OVERLAY, XOR, SOFTWARE_OVERLAY, BLEND).The values of this sequence are applied by Abaqus when you start a session in first to last order. The first successful value becomes the default highlight method. Not all graphics adapters support the HARDWARE_OVERLAY value and you must use the highlightMethodHint argument to provide an alternative.You can use a single value to set the first element of the list, or you can use a tuple with one to four unique values. Abaqus sets any remaining elements of the tuple to unique values based on the default order.
backgroundColor: str: A String specifying one of the two background colors for all viewport windows. The initial color is black. A list of valid color strings is in the colors map in the Session object.
backgroundBottomColor: str: A String specifying one of the two background colors for all viewport windows. This color is used only if backgroundStyle =GRADIENT. The initial color is black. A list of valid color strings is in the colors map in the Session object.

Methods

setValues([graphicsDriver, doubleBuffering, ...])

This method modifies the GraphicsOptions object.

setValues(graphicsDriver: SymbolicConstantType | None = None, doubleBuffering: BooleanType = 1, displayLists: BooleanType = 1, highlightMethodHint: SymbolicConstantType | None = None, dragMode: SymbolicConstantType = 'AS_IS', antiAlias: BooleanType = 1, autoFitAfterRotate: BooleanType = 0, polygonOffsetConstant: float | None = None, polygonOffsetSlope: float | None = None, printPolygonOffsetConstant: float | None = None, printPolygonOffsetSlope: float | None = None, vertexArrays: BooleanType = 1, vertexArraysInDisplayLists: BooleanType = 1, viewManipDisplayListThreshold: int = 40, directRendering: BooleanType = 0, hardwareAcceleration: BooleanType = 1, hardwareOverlay: BooleanType = 0, textureMapping: BooleanType = 1, printTextureMapping: BooleanType = 1, backgroundStyle: SymbolicConstantType = 'SOLID', backgroundColor: str = '', backgroundBottomColor: str = '', backgroundOverride: BooleanType = 0, backfaceCulling: BooleanType = 1, accelerateOffScreen: BooleanType = 0, backingStore: BooleanType = 1, shadersAvailable: BooleanType = 0, translucencyMode: int = 4, options: str | None = None, contourRangeTexturePrecision: float = 0)[source]#

This method modifies the GraphicsOptions object.

Parameters:

graphicsDriver: A SymbolicConstant specifying the graphics driver to use. Abaqus/CAE currently uses OpenGL exclusively so the only possible value is OPEN_GL. OPEN_GL takes advantage of graphics adapter hardware acceleration.
doubleBuffering: A Boolean specifying whether double buffering is used. The default value is ON.Double buffering controls where Abaqus/CAE draws its graphics. When *doubleBuffering*=OFF, everything is drawn directly to the screen and on many systems you can see the progress of the drawing operations. Most users find this distracting, especially in dynamic situations such as view manipulation or animation of results. When *doubleBuffering*=ON, the drawing occurs in a separate graphics buffer that is displayed when all the drawing operations are complete. This results in a much smoother display during view changes or animation. It is recommended that you set double buffering to ON.
displayLists: A Boolean specifying whether a display list will be used to accelerate graphics performance. The default value is ON.When displayLists*=ON, drawing operations are recorded in a list that can be quickly replayed. This results in faster drawing on most systems but requires extra memory to record the drawing operations. In the Visualization module, display lists are only used during view manipulations and then their use is subject to the setting of *viewManipDisplayListThreshold.
highlightMethodHint: A sequence of SymbolicConstants specifying a hint used to modify the highlight method. Possible values are:HARDWARE_OVERLAY, specifying a hint of hardware overlay. The best graphics performance is achieved using hardware overlay, but not all systems and graphics adapters support hardware overlay.XOR, specifying a hint of XOR technique. The XOR technique uses a boolean pixel operation to simulate the drawing operations but can produce different colors depending on the color of the underlying pixels.SOFTWARE_OVERLAY, specifying a hint of software overlay. The software overlay method simulates the effect of hardware overlay.BLEND, specifying a hint of blend method. The blend method combines the color of the underlying pixel with the desired color producing an approximation of the transient graphics.The default value is (HARDWARE_OVERLAY, XOR, SOFTWARE_OVERLAY, BLEND).The values of this sequence are applied by Abaqus when you start a session in first to last order. The first successful value becomes the default highlight method. Not all graphics adapters support the HARDWARE_OVERLAY value and you must use the highlightMethodHint argument to provide an alternative.You can use a single value to set the first element of the list, or you can use a tuple with one to four unique values. Abaqus sets any remaining elements of the tuple to unique values based on the default order.
dragMode: A SymbolicConstant specifying which rendering is used during dynamic rotations of the view. Possible values are:FAST, specifying a rendering mode where the image is rendered in wireframe.AS_IS, specifying a rendering mode where the image is rendered as is.The default value is AS_IS.When set to *dragMode*=FAST, a wireframe outline is drawn during view changes by rotation, pan, or zoom. When *dragMode*=AS_IS, everything displayed in the window will be drawn during view changes; however, the display may lag behind the mouse movement when the model is complex especially if you are using an older or slower system. For newer systems with graphics hardware acceleration the AS_IS setting can be accommodated without significant loss of performance.
antiAlias: A Boolean specifying whether lines will be smoothed to reduce the jagged effect of rasterization. The default value is ON.
autoFitAfterRotate: A Boolean specifying whether the model is automatically resized to fit the viewport after each view rotation. The default value is OFF.
polygonOffsetConstant: A Float specifying the offset added when drawing the faces of a polygon. The polygonOffsetConstant argument affects the behavior of only the OpenGL driver. Possible values are 0.0 ≤≤ polygonOffsetConstant ≤≤ 100.0. The default value is platform dependent and is typically between 0.0 and 2.0.
polygonOffsetSlope: A Float specifying the factor that multiplies the slope of each line before the line is added to the vertexes of a polygon face. The polygonOffsetSlope argument affects the behavior of only the OpenGL driver. Possible values are 0.0 ≤≤ polygonOffsetSlope ≤≤ 100.0. The default value is platform dependent and is typically between 0.0 and 2.0.
printPolygonOffsetConstant: A Float specifying the offset added when drawing the faces of a polygon. printPolygonOffsetConstant is similar to polygonOffsetConstant; however, printPolygonOffsetConstant is used when printing and polygonOffsetConstant is used for display. Some systems, especially Windows, use different OpenGL drivers for printing and display, and you may have to use different offset values for each driver.
printPolygonOffsetSlope: A Float specifying the factor that multiplies the slope of each line before the line is added to the vertexes of a polygon face. printPolygonOffsetSlope is similar to polygonOffsetSlope; however, printPolygonOffsetSlope is used when printing and polygonOffsetSlope is used for display. Some systems, especially Windows, use different OpenGL drivers for printing and display, and you may have to use different offset values for each driver.
vertexArrays: A Boolean specifying how the three-dimensional vertices of the model are processed. When *vertexArrays*=OFF, each vertex of the model is processed separately. When *vertexArrays*=ON, the vertices are processed in large blocks resulting in faster display. Not all graphics adapters support this capability correctly. An indicator that the graphics adapters is not processing three-dimensional vertices correctly is the absence of graphics during rubber banding operations. For example, when dynamically dragging the radius of a circle in the Sketcher, the circle should be visible. The default value is ON.
vertexArraysInDisplayLists: A Boolean specifying whether the vertexArrays setting should temporarily be set to OFF when building a display list. The default value is ON.Some graphics adapters do not properly support using vertex arrays inside a display list. Setting vertexArraysInDisplayLists to OFF has a smaller impact on graphics performance than setting vertexArrays or displayLists to OFF.
viewManipDisplayListThreshold: An Int specifying how large a display list may be created in order to accelerate view manipulation operations. Increasing this value when viewing large models will increase the delay before a view manipulation operation begins in order to obtain improved graphics performance during the view manipulation. If set high with a large model, the delay can be many seconds. In excessive cases, graphics memory can be exceeded and the result may be an empty display list (no visible model) for the view manipulation. This setting is treated as 0 if displayLists*=OFF. Possible values are 0 ≤≤ *viewManipDisplayListThreshold ≤≤ 20000. The default value is 40.
directRendering: A Boolean specifying how Abaqus renders X11 graphics operations. When directRendering*=OFF, the graphics are rendered through the X Server. When *directRendering*=ON, the graphics operations are sent directly to the graphics adapter producing faster displays. For maximum performance, the initial value is ON. This argument is used only when you first start Abaqus/CAE; you cannot configure *directRendering during a session.
hardwareAcceleration: A Boolean specifying whether a hardware accelerated OpenGL graphics driver will be used on Windows platforms. The default value is ON.When hardwareAcceleration*=OFF, the graphics driver uses a software implementation of OpenGL that is included with the operating system. This results in slower drawing on most systems; however, you may have to use the software implementation of OpenGL if the hardware graphics driver is incompatible with Abaqus/CAE.*hardwareAcceleration is used only when you first start Abaqus/CAE on a Windows platform; you cannot configure hardwareAcceleration during a session.*hardwareAcceleration* is not used when you start Abaqus/CAE on an X-Windows platform and display to a Windows platform running Exceed or any other X-Windows server.
hardwareOverlay: A Boolean specifying whether hardware overlay planes will be used if available. The default value is the same value as the hardwareOverlayAvailable member.When hardwareOverlayAvailable*=OFF, it will not be possible to set *hardwareOverlay to ON and the HARDWARE_OVERLAY highlight method will not be available. If viewports display a solid color and will not display the model, it will be necessary to inhibit hardware overlay completely by setting the ABAQUS_EMULATE_OVERLAYS environment variable (to any value) before starting Abaqus/CAE.*hardwareOverlay* is used only when you first start Abaqus/CAE; you cannot configure hardwareOverlay during a session.
textureMapping: A Boolean specifying whether textures will be used to display contour plots. The default value is ON.Turning off texture mapping is necessary only if viewports will not correctly display a contour plot of your model.
printTextureMapping: A Boolean specifying whether textures will be used to display contour plots. The default value is ON.Turning off texture mapping for printing is necessary only if printed output does not correctly display a contour plot of your model. printTextureMapping is similar to textureMapping; however, printTextureMapping is used when printing and textureMapping is used for display. Some systems, especially Windows, use different OpenGL drivers for printing and display, and you may have to use different settings for each driver.
backgroundStyle: A SymbolicConstant specifying the background style to be used for all viewport windows. Possible values are SOLID and GRADIENT. The default value is SOLID.If backgroundStyle*=SOLID, the viewport background will appear as a solid color as specified by *backgroundColor. If backgroundStyle*=GRADIENT, the viewport background will be drawn as a gradient beginning with the *backgroundColor at the top of the viewport and gradually blending to the backgroundBottomColor at the bottom of the viewport.
backgroundColor: A String specifying one of the two background colors for all viewport windows. The initial color is black. A list of valid color strings is in the colors map in the Session object.
backgroundBottomColor: A String specifying one of the two background colors for all viewport windows. This color is used only if backgroundStyle =GRADIENT. The initial color is black. A list of valid color strings is in the colors map in the Session object.
backgroundOverride: A Boolean specifying whether a viewport background style of GRADIENT can be overridden when displaying certain objects, such as sketches or XY plots. When overridden, the background will be the top color of the gradient background.
backfaceCulling: A Boolean specifying whether facets that are determined to be facing away from the viewer will be drawn. The default value is ON. backfaceCulling provides a performance enhancement when displaying solid elements where the front side of the element occludes the back side of the element. Set *backfaceCulling*=OFF if it appears that you are seeing the back side of an element and the front side is missing. You should also set *backfaceCulling*=OFF if you believe the display is not complete.
accelerateOffScreen: A Boolean specifying whether the hardware accelerated graphics driver will be used for off-screen rendering. The default value is ON if graphics hardware acceleration is available and has not been disabled via the hardwareAcceleration option, and the graphics driver supports the underlying technology. When set to OFF, an alternate (slower) technique will be used to create off-screen images. Off-screen rendering is used for Printing, Probe, and backing store (viewport refresh). Setting this value to OFF will force printed images to be rendered without hardware acceleration. This is useful when writing automated tests to produce raster images that you will want to compare across multiple machines that may have different graphics environments.
backingStore: A Boolean specifying whether a backing store will be used to refresh a viewport after a window occluding the viewport is moved or dismissed. The default value is ON.
shadersAvailable: A Boolean specifying if the graphics hardware supports the OpenGL Shading Language (GLSL).
translucencyMode: An Int specifying whether speed or accuracy is more important when drawing translucent objects. Lower values optimize for speed while higher values optimize for accuracy. The actual meaning of each setting will depend on the setting of shadersAvailable and the capabilities of the graphics hardware and driver. Possible values are 1 ≤≤ translucencyMode ≤≤ 6. The default value is 4.
options: None or a GraphicsOptions object specifying the object from which values are to be copied. If other arguments are also supplied to setValues, they will override the values in the options member. The default value is None.
contourRangeTexturePrecision: A Float specifying a tolerance used when computing the appropriate scale for transforming result (contour) values to texture values. When set too low the ‘out of range’ colors may be incorrectly shown for values near the range limits. The default value is 0.5×10–5.

Raises:

RangeError

InteractionDisplayOptions#

class InteractionDisplayOptions[source]#

The InteractionDisplayOptions object stores settings that specify how assemblies are to be displayed in a particular viewport when session.viewports[name].assemblyDisplay.interactions=ON The InteractionDisplayOptions object has no constructor. When you create a new viewport, the settings are copied from the current viewport.

Notes

This object can be accessed by:

session.viewports[name].assemblyDisplay.interactionOptions
session.viewports[name].layers[name].assemblyDisplay.interactionOptions

Methods

setValues([surfaceContact, selfContact, ...])

This method modifies the InteractionDisplayOptions object.

setValues(surfaceContact: BooleanType = 1, selfContact: BooleanType = 1, elasticFoundation: BooleanType = 1, actuatorSensor: BooleanType = 1, radiationAmbient: BooleanType = 1, filmCondition: BooleanType = 1, concentratedRadiationToAmbient: BooleanType = 1, concentratedFilmCondition: BooleanType = 1)[source]#

This method modifies the InteractionDisplayOptions object.

Parameters:

surfaceContact: A Boolean specifying whether surface contact symbols are shown. The default value is ON.
selfContact: A Boolean specifying whether self contact symbols are shown. The default value is ON.
elasticFoundation: A Boolean specifying whether elastic foundation symbols are shown. The default value is ON.
actuatorSensor: A Boolean specifying whether actuator/sensor symbols are shown. The default value is ON.
radiationAmbient: A Boolean specifying whether surface radiation-to-ambient symbols are shown. The default value is ON.
filmCondition: A Boolean specifying whether surface film condition symbols are shown. The default value is ON.
concentratedRadiationToAmbient: A Boolean specifying whether concentrated radiation-to-ambient symbols are shown. The default value is ON.
concentratedFilmCondition: A Boolean specifying whether concentrated film condition symbols are shown. The default value is ON.

Raises:

RangeError

Light#

class Light[source]#

The Light object stores settings that control how objects are lit when the renderStyle is set to SHADED. The Light object has no constructor; Abaqus creates them as part of the defaultLightOptions and the lightOptions objects when a session is started.

Notes

This object can be accessed by:

session.defaultLightOptions.lights[i]
session.viewports[name].lightOptions.lights[i]

Methods

setValues([enabled, type, latitude, ...])

This method modifies the Light object.

setValues(enabled: BooleanType = 0, type: SymbolicConstantType = 'DIRECTIONAL', latitude: float = 0, longitude: float = 0, diffuseColor: str = '', specularColor: str = '')[source]#

This method modifies the Light object.

Parameters:

enabled: A Boolean specifying whether the light is on or off. The default value is OFF.
type: A SymbolicConstant specifying how the effect of the light should be calculated. Possible values are:DIRECTIONAL, specifying a constant vector should be used for the direction from the light to a vertex.POINT, specifying the vector from the light to each vertex should be calculated.The default value is DIRECTIONAL.When set to type =DIRECTIONAL, a constant vector is used for the direction from the light to a vertex. When type =POINT, the result is more realistic because the actual vector from the light to each vertex is calculated. However, overall performance is decreased.
latitude: A Float specifying the altitude of the light above or below the camera. Possible values are -90.0 ≤≤ latitude ≤≤ 90.0. The default value is 0.0.
longitude: A Float specifying the east/west position of the light to the left or right of the camera. Possible values are -90.0 ≤≤ longitude ≤≤ 90.0. The default value is 0.0.
diffuseColor: A String specifying the color of the light added to the scene by this light source. The initial value is 70% gray. A list of valid color strings is in the colors map in the session object.
specularColor: A String specifying the color of the specular highlights created by this light source. The initial value is 36% gray. A list of valid color strings is in the colors map in the session object.

Raises:

RangeError

LightArray#

class LightArray(iterable=(), /)[source]#

Methods

findAt

LightOptions#

class LightOptions[source]#

The LightOptions object stores settings that control how objects are lit when the renderStyle is set to SHADED. LightOptions objects are accessed in one of two ways: - The default light options. These settings are used as defaults when you start a session and by the Defaults button on the Light ConstrainedSketchOptions dialog box. - The light options associated with a particular viewport. The LightOptions object has no constructor; Abaqus creates the defaultLightOptions member when a session is started. When a new viewport is created, the lightOptions member is copied from the current viewport.

Notes

This object can be accessed by:

session.defaultLightOptions
session.viewports[name].lightOptions

Attributes:

shading: SymbolicConstant: A SymbolicConstant specifying the shading technique that should be used to fill facets for geometric bodies when renderStyle =SHADED. The lighting of facets for meshed geometry is not affected by this setting. Possible values are:GOURAUD, specifying that lighting values should be computed for each corner of a facet and interpolated to fill the remainder of the facet.PHONG, specifying that lighting values should be computed for each pixel of a facet.The default value is GOURAUD.When set to shading =GOURAUD, lighting values are computed for each corner of a facet and the lighting for the remainder of the facet is interpolated from the corner values. When shading =PHONG, lighting values are computed for each pixel of a facet.Note:The shading technique can only be set to PHONG when the shadersAvailable member of GraphicsOptions is True.Printed output will only contain Phong shading if the output format is raster and the accelerateOffScreen member of GraphicsOptions is ON.The renderStyle setting is part of AssemblyDisplayOptions, PartDisplayOptions, and various other options objects not listed here since they are generally used for meshed geometry.
viewpoint: SymbolicConstant: A SymbolicConstant specifying how specular highlights should be calculated. Possible values are:INFINITE, specifying that a constant vector should be used for the direction from the camera to a vertex when computing specular highlights.LOCAL, specifying that the vector from the camera to each vertex should be calculated when computing specular highlights.The default value is INFINITE.When set to viewpoint =INFINITE, a constant vector is used for the direction from the camera (viewpoint) to a vertex. When viewpoint =LOCAL, the result is more realistic because the actual vector from the camera to each vertex is calculated. However, overall performance is decreased.
materialShininess: float: A Float specifying the degree to which specular reflection is focused. The higher the materialShininess argument, the more focused the specular highlight. Possible values are 0.0 ≤≤ polygonOffsetConstant ≤≤ 128.0. The default value is 105.0.
lights: LightArray: A LightArray object of length 8.
ambientColor: str: A String specifying the light applied evenly to the entire scene independent of any individual light. The initial value is 20% gray. A list of valid color strings is in the colors map in the session object.

Methods

setValues([shading, viewpoint, ...])

This method modifies the LightOptions object.

setValues(shading: SymbolicConstantType = 'GOURAUD', viewpoint: SymbolicConstantType = 'INFINITE', ambientColor: str = '', materialShininess: float = 105)[source]#

This method modifies the LightOptions object.

Parameters:

shading: A SymbolicConstant specifying the shading technique that should be used to fill facets for geometric bodies when renderStyle =SHADED. The lighting of facets for meshed geometry is not affected by this setting. Possible values are:GOURAUD, specifying that lighting values should be computed for each corner of a facet and interpolated to fill the remainder of the facet.PHONG, specifying that lighting values should be computed for each pixel of a facet.The default value is GOURAUD.When set to shading =GOURAUD, lighting values are computed for each corner of a facet and the lighting for the remainder of the facet is interpolated from the corner values. When shading =PHONG, lighting values are computed for each pixel of a facet.Note:The shading technique can only be set to PHONG when the shadersAvailable member of GraphicsOptions is True.Printed output will only contain Phong shading if the output format is raster and the accelerateOffScreen member of GraphicsOptions is ON.The renderStyle setting is part of AssemblyDisplayOptions, PartDisplayOptions, and various other options objects not listed here since they are generally used for meshed geometry.
viewpoint: A SymbolicConstant specifying how specular highlights should be calculated. Possible values are:INFINITE, specifying that a constant vector should be used for the direction from the camera to a vertex when computing specular highlights.LOCAL, specifying that the vector from the camera to each vertex should be calculated when computing specular highlights.The default value is INFINITE.When set to viewpoint =INFINITE, a constant vector is used for the direction from the camera (viewpoint) to a vertex. When viewpoint =LOCAL, the result is more realistic because the actual vector from the camera to each vertex is calculated. However, overall performance is decreased.
ambientColor: A String specifying the light applied evenly to the entire scene independent of any individual light. The initial value is 20% gray. A list of valid color strings is in the colors map in the session object.
materialShininess: A Float specifying the degree to which specular reflection is focused. The higher the materialShininess argument, the more focused the specular highlight. Possible values are 0.0 ≤≤ polygonOffsetConstant ≤≤ 128.0. The default value is 105.0.

Raises:

RangeError

LoadDisplayOptions#

class LoadDisplayOptions[source]#

The LoadDisplayOptions object stores settings that specify how assemblies are to be displayed in a particular viewport when session.viewports[name].assemblyDisplay.loads=ON The LoadDisplayOptions object has no constructor. When you create a new viewport, the settings are copied from the current viewport.

Notes

This object can be accessed by:

session.viewports[name].assemblyDisplay.loadOptions
session.viewports[name].layers[name].assemblyDisplay.loadOptions

Methods

setValues([concentratedForce, moment, ...])

This method modifies the LoadDisplayOptions object. concentratedForce A Boolean specifying whether concentrated force symbols are shown. The default value is ON. moment A Boolean specifying whether moment symbols are shown. The default value is ON. pressure A Boolean specifying whether pressure symbols are shown. The default value is ON. pipePressure A Boolean specifying whether pipe pressure symbols are shown. The default value is ON. bodyForce A Boolean specifying whether body force symbols are shown. The default value is ON. lineLoad A Boolean specifying whether line load symbols are shown. The default value is ON. gravity A Boolean specifying whether gravity symbols are shown. The default value is ON. boltLoad A Boolean specifying whether bolt load symbols are shown. The default value is ON. pegLoad A Boolean specifying whether PEG load symbols are shown. The default value is ON. connectorForce A Boolean specifying whether connector force symbols are shown. The default value is ON. connectorMoment A Boolean specifying whether connector moment symbols are shown. The default value is ON. inertiaRelief A Boolean specifying whether inertia relief symbols are shown. The default value is ON. rotationalIntertiaLoad A Boolean specifying whether rotational inertia load symbols are shown. The default value is ON. coriolisForce A Boolean specifying whether coriolis force symbols are shown. The default value is ON. bodyHeatFlux A Boolean specifying whether body heat flux symbols are shown. The default value is ON. surfaceHeatFlux A Boolean specifying whether surface heat flux symbols are shown. The default value is ON. concentratedHeatFlux A Boolean specifying whether concentrated heat flux symbols are shown. The default value is ON. concentratedPoreFluid A Boolean specifying whether concentrated pore fluid symbols are shown. The default value is ON. surfacePoreFluid A Boolean specifying whether surface pore fluid symbols are shown. The default value is ON. hydroFluidFlow A Boolean specifying whether hydro fluid flow symbols are shown. The default value is ON. concentratedCharge A Boolean specifying whether concentrated charge symbols are shown. The default value is ON. concentratedCurrent A Boolean specifying whether concentrated current symbols are shown. The default value is ON. surfaceCharge A Boolean specifying whether surface charge symbols are shown. The default value is ON. surfaceCurrent A Boolean specifying whether surface current symbols are shown. The default value is ON. bodyCharge A Boolean specifying whether body charge symbols are shown. The default value is ON. bodyCurrent A Boolean specifying whether body current symbols are shown. The default value is ON. inwardVolAccel A Boolean specifying whether inward volume acceleration symbols are shown. The default value is ON. bodyConcentrationFlux A Boolean specifying whether body concentration flux symbols are shown. The default value is ON. surfaceConcentrationFlux A Boolean specifying whether surface concentration flux symbols are shown. The default value is ON. concentratedConcentrationFlux A Boolean specifying whether concentrated concentration flux symbols are shown. The default value is ON.

setValues(concentratedForce: str = 1, moment: str = 1, pressure: str = 1, pipePressure: str = 1, bodyForce: str = 1, lineLoad: str = 1, gravity: str = 1, boltLoad: str = 1, pegLoad: str = 1, connectorForce: str = 1, connectorMoment: str = 1, inertiaRelief: str = 1, rotationalIntertiaLoad: str = 1, coriolisForce: str = 1, bodyHeatFlux: str = 1, surfaceHeatFlux: str = 1, concentratedHeatFlux: str = 1, concentratedPoreFluid: str = 1, surfacePoreFluid: str = 1, hydroFluidFlow: str = 1, concentratedCharge: str = 1, concentratedCurrent: str = 1, surfaceCharge: str = 1, surfaceCurrent: str = 1, bodyCharge: str = 1, bodyCurrent: str = 1, inwardVolAccel: str = 1, bodyConcentrationFlux: str = 1, surfaceConcentrationFlux: str = 1, concentratedConcentrationFlux: str = 1)[source]#

This method modifies the LoadDisplayOptions object. concentratedForce

A Boolean specifying whether concentrated force symbols are shown. The default value is ON.

moment: A Boolean specifying whether moment symbols are shown. The default value is ON.
pressure: A Boolean specifying whether pressure symbols are shown. The default value is ON.
pipePressure: A Boolean specifying whether pipe pressure symbols are shown. The default value is ON.
bodyForce: A Boolean specifying whether body force symbols are shown. The default value is ON.
lineLoad: A Boolean specifying whether line load symbols are shown. The default value is ON.
gravity: A Boolean specifying whether gravity symbols are shown. The default value is ON.
boltLoad: A Boolean specifying whether bolt load symbols are shown. The default value is ON.
pegLoad: A Boolean specifying whether PEG load symbols are shown. The default value is ON.
connectorForce: A Boolean specifying whether connector force symbols are shown. The default value is ON.
connectorMoment: A Boolean specifying whether connector moment symbols are shown. The default value is ON.
inertiaRelief: A Boolean specifying whether inertia relief symbols are shown. The default value is ON.
rotationalIntertiaLoad: A Boolean specifying whether rotational inertia load symbols are shown. The default value is ON.
coriolisForce: A Boolean specifying whether coriolis force symbols are shown. The default value is ON.
bodyHeatFlux: A Boolean specifying whether body heat flux symbols are shown. The default value is ON.
surfaceHeatFlux: A Boolean specifying whether surface heat flux symbols are shown. The default value is ON.
concentratedHeatFlux: A Boolean specifying whether concentrated heat flux symbols are shown. The default value is ON.
concentratedPoreFluid: A Boolean specifying whether concentrated pore fluid symbols are shown. The default value is ON.
surfacePoreFluid: A Boolean specifying whether surface pore fluid symbols are shown. The default value is ON.
hydroFluidFlow: A Boolean specifying whether hydro fluid flow symbols are shown. The default value is ON.
concentratedCharge: A Boolean specifying whether concentrated charge symbols are shown. The default value is ON.
concentratedCurrent: A Boolean specifying whether concentrated current symbols are shown. The default value is ON.
surfaceCharge: A Boolean specifying whether surface charge symbols are shown. The default value is ON.
surfaceCurrent: A Boolean specifying whether surface current symbols are shown. The default value is ON.
bodyCharge: A Boolean specifying whether body charge symbols are shown. The default value is ON.
bodyCurrent: A Boolean specifying whether body current symbols are shown. The default value is ON.
inwardVolAccel: A Boolean specifying whether inward volume acceleration symbols are shown. The default value is ON.
bodyConcentrationFlux: A Boolean specifying whether body concentration flux symbols are shown. The default value is ON.
surfaceConcentrationFlux: A Boolean specifying whether surface concentration flux symbols are shown. The default value is ON.
concentratedConcentrationFlux: A Boolean specifying whether concentrated concentration flux symbols are shown. The default value is ON.

Raises:

RangeError

MeshDisplayOptions#

class MeshDisplayOptions[source]#

The MeshDisplayOptions object stores settings that specify how the assembly is displayed in a particular viewport when session.viewports[name].assemblyDisplay.mesh=ON The MeshDisplayOptions object has no constructor. When you create a new viewport, the settings are copied from the current viewport.

Notes

This object can be accessed by:

session.viewports[name].assemblyDisplay.meshOptions
session.viewports[name].layers[name].assemblyDisplay.meshOptions
session.viewports[name].layers[name].partDisplay.meshOptions
session.viewports[name].partDisplay.meshOptions

Methods

setValues([nodeLabels, elementLabels, ...])

This method modifies the MeshDisplayOptions object.

setValues(nodeLabels: BooleanType = 0, elementLabels: BooleanType = 0, meshVisibleEdges: SymbolicConstantType = 'EXTERIOR', featureAngle: float = 20, meshEdgesInShaded: BooleanType = 1, meshTechnique: BooleanType = 0, seeds: BooleanType = 0)[source]#

This method modifies the MeshDisplayOptions object.

Parameters:

nodeLabels

A Boolean specifying whether node labels are shown. The default value is OFF.

elementLabels

A Boolean specifying whether element labels are shown. The default value is OFF.

meshVisibleEdges

A SymbolicConstant specifying how the mesh’s edges are drawn. Possible values are:

ALL, specifying that all edges are shown.
EXTERIOR, specifying that only exterior edges are shown.
FEATURE, specifying that edges are shown based on featureAngle.
FREE, specifying that only free edges are shown.
NONE, specifying that no display edges are shown.

The default value is EXTERIOR.

featureAngle

A Float specifying the angle in degrees to be used in calculating a feature edge plot. Possible values are 0 ≤≤ featureAngle ≤≤ 90. The default value is 20.0.

meshEdgesInShaded

A Boolean specifying whether mesh edges are displayed in shaded mode. The default value is ON.

meshTechnique

A Boolean specifying whether the regions of the assembly will be color coded based on the meshing technique assigned to the regions. This argument is ignored in partDisplay. The default value is OFF.

seeds

A Boolean specifying whether seeds are shown. This argument is ignored in partDisplay. The default value is OFF.

Raises:

RangeError

OptimizationTaskDisplayOptions#

class OptimizationTaskDisplayOptions[source]#

The OptimizationTaskDisplayOptions object stores settings that specify how assemblies are to be displayed in a particular viewport when session.viewports[name].assemblyDisplay.optimizationTasks=ON The OptimizationTaskDisplayOptions object has no constructor. When you create a new viewport, the settings are copied from the current viewport.

Notes

This object can be accessed by:

session.viewports[name].assemblyDisplay.optimizationTaskOptions
session.viewports[name].layers[name].assemblyDisplay.optimizationTaskOptions

Methods

setValues([topologyTask, shapeTask])

This method modifies the OptimizationTaskDisplayOptions object.

setValues(topologyTask: BooleanType = 1, shapeTask: BooleanType = 1)[source]#

This method modifies the OptimizationTaskDisplayOptions object.

Parameters:

topologyTask: A Boolean specifying whether topology task symbols are shown. The default value is ON.
shapeTask: A Boolean specifying whether shape task symbols are shown. The default value is ON.

Raises:

RangeError

PartDisplayOptions#

class PartDisplayOptions[source]#

The PartDisplayOptions object stores settings that specify how parts are to be displayed in a particular viewport. The PartDisplayOptions object has no constructor. When you create a new viewport, the settings are copied from the current viewport.

Notes

This object can be accessed by:

session.viewports[name].layers[name].partDisplay
import part
session.viewports[name].partDisplay

Attributes:

engineeringFeatures: Boolean: A Boolean specifying whether engineering features are shown. The default value is OFF.
renderBeamProfiles: Boolean: A Boolean specifying whether to render the beam profiles. The default value is OFF.
beamScaleFactor: float: A Float specifying the beam profile scale factor. The beamScaleFactor must be greater than zero. The default value is 1.0.
mesh: Boolean: A Boolean specifying whether the mesh should be displayed.
renderStyle: SymbolicConstant: A SymbolicConstant specifying how the image in the viewport is rendered. Possible values are WIREFRAME, HIDDEN, and SHADED. The default value is WIREFRAME.
displayGroup: DisplayGroup: A DisplayGroup object specifying the current display group an object in the displayGroups member of Session.
displayGroupInstances: dict[str, DisplayGroupInstance]: A repository of DisplayGroupInstance objects.
engineeringFeatureOptions: EngineeringFeatureDisplayOptions: An EngineeringFeatureDisplayOptions object.
geometryOptions: GeometryDisplayOptions: A GeometryDisplayOptions object.
meshOptions: MeshDisplayOptions: A MeshDisplayOptions object.

Methods

setValues([renderStyle, ...])

This method modifies the PartDisplayOptions object.

setValues(renderStyle: SymbolicConstantType = 'WIREFRAME', visibleDisplayGroups: tuple[DisplayGroup] = (), engineeringFeatures: BooleanType = 0, renderBeamProfiles: BooleanType = 0, beamScaleFactor: float = 1)[source]#

This method modifies the PartDisplayOptions object.

Parameters:

renderStyle: A SymbolicConstant specifying how the image in the viewport is rendered. Possible values are WIREFRAME, HIDDEN, and SHADED. The default value is WIREFRAME.
visibleDisplayGroups: A sequence of DisplayGroup objects specifying the DisplayGroups visible in the viewport. Currently the sequence can contain a maximum of one DisplayGroup object. The default value is an empty sequence.
engineeringFeatures: A Boolean specifying whether engineering features are shown. The default value is OFF.
renderBeamProfiles: A Boolean specifying whether to render the beam profiles. The default value is OFF.
beamScaleFactor: A Float specifying the beam profile scale factor. The beamScaleFactor must be greater than zero. The default value is 1.0.

Raises:

RangeError

PredefinedFieldDisplayOptions#

class PredefinedFieldDisplayOptions[source]#

The PredefinedFieldDisplayOptions object stores settings that specify how assemblies are to be displayed in a particular viewport when session.viewports[name].assemblyDisplay.predefinedFields=ON The PredefinedFieldDisplayOptions object has no constructor. When you create a new viewport, the settings are copied from the current viewport.

Notes

This object can be accessed by:

session.viewports[name].assemblyDisplay.predefinedFieldOptions
session.viewports[name].layers[name].assemblyDisplay.predefinedFieldOptions

Methods

setValues([temperatureField, velocityField, ...])

This method modifies the PredefinedFieldDisplayOptions object.

setValues(temperatureField: BooleanType = 1, velocityField: BooleanType = 1, generalField: BooleanType = 1, stressField: BooleanType = 1, hardeningField: BooleanType = 1)[source]#

This method modifies the PredefinedFieldDisplayOptions object.

Parameters:

temperatureField: A Boolean specifying whether temperature field symbols are shown. The default value is ON.
velocityField: A Boolean specifying whether translational velocity symbols are shown. The default value is ON.
generalField: A Boolean specifying whether general field symbols are shown. The default value is ON.
stressField: A Boolean specifying whether stress field symbols are shown. The default value is ON.
hardeningField: A Boolean specifying whether hardening field symbols are shown. The default value is ON.

Raises:

RangeError

StopConditionDisplayOptions#

class StopConditionDisplayOptions[source]#

The StopConditionDisplayOptions object stores settings that specify how assemblies are to be displayed in a particular viewport when session.viewports[name].assemblyDisplay.stopConditions=ON The StopConditionDisplayOptions object has no constructor. When you create a new viewport, the settings are copied from the current viewport.

Notes

This object can be accessed by:

session.viewports[name].assemblyDisplay.stopConditionOptions
session.viewports[name].layers[name].assemblyDisplay.stopConditionOptions

Methods

setValues([localStopCondition])

This method modifies the StopConditionDisplayOptions object.

setValues(localStopCondition: BooleanType = 1)[source]#

This method modifies the StopConditionDisplayOptions object.

Parameters:

localStopCondition: A Boolean specifying whether local stop condition symbols are shown. The default value is ON.

Raises:

RangeError

SymbolDisplayOptions#

class SymbolDisplayOptions[source]#

The SymbolDisplayOptions object stores settings that specify how the assembly is displayed in a particular viewport. The SymbolDisplayOptions object has no constructor. When you create a new viewport, the settings are copied from the current viewport.

Notes

This object can be accessed by:

session.viewports[name].assemblyDisplay.symbolOptions
session.viewports[name].layers[name].assemblyDisplay.symbolOptions

Methods

setValues([otherSymbolSize, ...])

This method modifies the SymbolDisplayOptions object.

setValues(otherSymbolSize: int = 12, arrowSymbolSize: int = 12, faceSymbolDensity: int = 5, edgeSymbolDensity: int = 5, meshSymbolFraction: float = 1, showFields: BooleanType = 1)[source]#

This method modifies the SymbolDisplayOptions object.

Parameters:

otherSymbolSize: An Int specifying the size of the scalar attribute symbols. Possible values are 1 ≤≤ scalarSymbolSize ≤≤ 30. The default value is 12.
arrowSymbolSize: An Int specifying the size of the vector and tensor attribute symbols. Possible values are 1 ≤≤ vectorSymbolSize ≤≤ 30. The default value is 12.
faceSymbolDensity: An Int specifying the relative density of the attribute symbols drawn on geometric faces. Possible values are 1 ≤≤ faceSymbolDensity ≤≤ 10. The default value is 5.
edgeSymbolDensity: An Int specifying the relative density of the attribute symbols drawn on geometric edges. Possible values are 1 ≤≤ edgeSymbolDensity ≤≤ 10. The default value is 5.
meshSymbolFraction: A Float specifying the fraction of the attribute symbols drawn on orphan mesh regions. Possible values are 0.0 ≤≤ meshSymbolFraction ≤≤ 1.0. The default value is 1.0.
showFields: A Boolean specifying whether symbols should be scaled based on analytical field value. The default value is ON.

ViewportAnnotationOptions#

class ViewportAnnotationOptions[source]#

The ViewportAnnotationOptions object stores settings that control how annotations are rendered in a particular viewport. ViewportAnnotationOptions objects are accessed in one of two ways: - The default viewport annotations. These settings are used as defaults when other viewportAnnotationOptions members are created and can be set to customize user preferences. - The viewport annotations associated with a particular viewport. The ViewportAnnotationOptions object has no constructor; Abaqus creates the defaultViewportAnnotationOptions member when a session is started. When a new viewport is created, the settings are copied from the current viewport.

Notes

This object can be accessed by:

session.defaultViewportAnnotationOptions
session.viewports[name].viewportAnnotationOptions

Methods

setValues([triad, triadPosition, ...])

This method modifies the ViewportAnnotationOptions object.

setValues(triad: BooleanType = 1, triadPosition: int | None = None, triadColor: str = '', triadLabels: SymbolicConstantType = 'NUMBERS', triadFont: str = '', triadSize: int = 4, legend: BooleanType = 1, legendMinMax: BooleanType = 0, legendBox: BooleanType = 1, legendDecimalPlaces: int = 3, legendPosition: int | None = None, legendFont: str = '', legendTextColor: str = '', legendBackgroundStyle: SymbolicConstantType = 'TRANSPARENT', legendBackgroundColor: str = '', title: BooleanType = 1, titleBox: BooleanType = 0, titlePosition: int | None = None, titleFont: str = '', titleTextColor: str = '', titleBackgroundStyle: SymbolicConstantType = 'TRANSPARENT', titleBackgroundColor: str = '', state: BooleanType = 1, stateBox: BooleanType = 0, statePosition: int | None = None, stateFont: str = '', stateTextColor: str = '', stateBackgroundStyle: SymbolicConstantType = 'TRANSPARENT', stateBackgroundColor: str = '', compass: BooleanType = 1, compassScale: float = 0, compassPrivilegedPlane: SymbolicConstantType = 'XZPLANE')[source]#

This method modifies the ViewportAnnotationOptions object.

Parameters:

triad: A Boolean specifying whether the view orientation triad is shown. The default value is ON.
triadPosition: A pair of Ints specifying the position of the view orientation triad as a percentage of the viewport size. Possible values are (0, 0) ≤≤ triadPosition ≤≤ (100, 100). The default value is (6, 12).
triadColor: A String specifying the color of the view orientation triad. Possible values are any valid color. The default value is “White”.
triadLabels: A SymbolicConstant specifying how the view orientation triad is labeled. Possible values are:NUMBERS, specifying the label axes 1, 2, 3.LETTERS, specifying the label axes X, Y, Z.The default value is NUMBERS.
triadFont: A String specifying the font of the view orientation triad labels. Possible values are any valid font. The default value is “--verdana-bold-r-normal–120-“.
triadSize: An Int specifying the length of each triad axis as a percentage of the viewport size. Possible values are 1 ≤≤ legendDecimalPlaces ≤≤ 50. The default value is 4.
legend: A Boolean specifying whether the legend is shown. The default value is ON.
legendMinMax: A Boolean specifying whether the minimum and maximum values for X–Y and contour plots are shown. The default value is OFF.
legendBox: A Boolean specifying whether the box around the legend is shown. The default value is ON.
legendDecimalPlaces: An Int specifying the number of decimal places to display in the legend. Possible values are 0 ≤≤ legendDecimalPlaces ≤≤ 9. The default value is 3.
legendPosition: A pair of Ints specifying the position of the legend as a percentage of the viewport size. Possible values are (0, 0)≤≤ legendPosition ≤≤ (100, 100). The default value is (2, 98).
legendFont: A String specifying the font of the legend labels. Possible values are any valid font. The default value is “--verdana-medium-r----120-----iso8859-1”.
legendTextColor: A String specifying the color of the legend. Possible values are any valid color. The default value is “White”.
legendBackgroundStyle: A SymbolicConstant specifying the legend background style. Possible values are MATCH, TRANSPARENT, and OTHER. The default value is TRANSPARENT.The default color when OTHER is specified is the background color (black).
legendBackgroundColor: A String specifying the color of the legend background. Possible values are any valid color. The initial value matches the viewport background.
title: A Boolean specifying whether the title block is shown. The default value is ON.
titleBox: A Boolean specifying whether the box around the title block is shown. The default value is OFF.
titlePosition: A pair of Ints specifying the position of the title block as a percentage of the viewport size. Possible values are (0, 0) ≤≤ titlePosition ≤≤ (100, 100). The default value is (13, 20).
titleFont: A String specifying the font of the title. Possible values are any valid font. The default value is “--verdana-medium-r----120-----iso8859-1”.
titleTextColor: A String specifying the color of the title. Possible values are any valid color. The default value is “White”.
titleBackgroundStyle: A SymbolicConstant specifying the title block background style. Possible values are MATCH, TRANSPARENT, and OTHER. The default value is TRANSPARENT.The default color when OTHER is specified is the background color (black).
titleBackgroundColor: A String specifying the color of the title block background. Possible values are any valid color. The initial value matches the viewport background.
state: A Boolean specifying whether the state block is shown. The default value is ON.
stateBox: A Boolean specifying whether the box around the state block is shown. The default value is OFF.
statePosition: A pair of Ints specifying the position of the state block as a percentage of the viewport size. Possible values are (0, 0) ≤≤ statePosition ≤≤ (100, 100). The default value is (13, 12).
stateFont: A String specifying the font of the state label. Possible values are any valid font. The default value is “--verdana-medium-r----120-----iso8859-1”.
stateTextColor: A String specifying the color of the state block label. Possible values are any valid color. The default value is “White”.
stateBackgroundStyle: A SymbolicConstant specifying the state block background style. Possible values are MATCH, TRANSPARENT, and OTHER. The default value is TRANSPARENT.The default color when OTHER is specified is the background color (black).
stateBackgroundColor: A String specifying the color of the state block background. Possible values are any valid color. The initial value matches the viewport background.
compass: A Boolean specifying whether the 3D Compass is shown. The default value is ON.
compassScale: A Float specifying the relative size of the 3D Compass in the viewport. Possible values are 0.5 ≤≤ compassScale ≤≤ 2.0. The default value is 0.8.
compassPrivilegedPlane: A SymbolicConstant specifying the plane that will be used for the base of the 3D Compass. Possible values are XYPLANE, XZPLANE, and YZPLANE. The default value is XZPLANE.

Raises:

RangeError