CommonOptions object

The CommonOptions object stores values and attributes that are common to all plot states. The CommonOptions object has no constructor command. Abaqus creates a defaultOdbDisplay.commonOptions member when you import the Visualization module. Abaqus creates a commonOptions member when it creates the OdbDisplay object, using the values from defaultOdbDisplay.commonOptions. Abaqus creates the odbDisplay member when a viewport is created, using the values from defaultOdbDisplay.

CommonOptions objects are accessed in one of two ways:

  • The default common options. These settings are used as defaults when other commonOptions members are created. These settings can be set to customize user preferences.

  • The common options associated with a particular viewport.

The CommonOptions object is derived from the DGCommonOptions object.

The following topics are discussed:

Access

import visualization
session.defaultOdbDisplay.commonOptions
session.viewports[name].assemblyDisplay.displayGroupInstances[name]\
.odbDisplayOptions.commonOptions
session.viewports[name].layers[name].assemblyDisplay\
.displayGroupInstances[name].odbDisplayOptions.commonOptions
session.viewports[name].layers[name].odbDisplay.commonOptions
session.viewports[name].layers[name].odbDisplay\
.displayGroupInstances[name].odbDisplayOptions.commonOptions
session.viewports[name].layers[name].partDisplay\
.displayGroupInstances[name].odbDisplayOptions.commonOptions
session.viewports[name].odbDisplay.commonOptions
session.viewports[name].odbDisplay.displayGroupInstances[name]\
.odbDisplayOptions.commonOptions
session.viewports[name].partDisplay.displayGroupInstances[name]\
.odbDisplayOptions.commonOptions

setValues(...)

This method modifies the CommonOptions object.

Required arguments

None.

Optional arguments

options

A CommonOptions object from which values are to be copied. If other arguments are also supplied to setValues, they will override the values in options. The default value is None.

renderStyle

A SymbolicConstant specifying the render style of the plot. Possible values are WIREFRAME, FILLED, HIDDEN, and SHADED. The default value is SHADED.

visibleEdges

A SymbolicConstant specifying which edges to plot. Possible values are ALL, EXTERIOR, FEATURE, FREE, and NONE. The default value is EXTERIOR.

NONE can be used only when renderStyle=SHADED.

deformationScaling

A SymbolicConstant specifying the deformation scale factor mode. Possible values are AUTO, UNIFORM, and NONUNIFORM. The default value is AUTO.

uniformScaleFactor

A Float specifying the uniform deformation scaling constant when deformationScaling=UNIFORM. The default value is autoDeformationScaleValue.

nonuniformScaleFactor

A sequence of three Floats specifying the deformation scaling in each of the three coordinate directions when deformationScaling=NONUNIFORM. The default value is (autoDeformationScaleValue, autoDeformationScaleValue, autoDeformationScaleValue).

edgeColorWireHide

A String specifying the color to be used to plot the edges of the model when renderStyle=WIREFRAME or HIDDEN. The default value is "White".

edgeColorFillShade

A String specifying the color to be used to plot the edges of the model when renderStyle=FILLED or SHADED. The default value is "Black".

edgeLineStyle

A SymbolicConstant specifying the edge line style. Possible values are SOLID, DASHED, DOTTED, and DOT_DASH. The default value is SOLID.

edgeLineThickness

A SymbolicConstant specifying the edge line thickness. Possible values are VERY_THIN, THIN, MEDIUM, and THICK. The default value is VERY_THIN.

fillColor

A String specifying the color to be used to fill elements when renderStyle=FILLED or SHADED. The default value is "White".

colorCodeOverride

A Boolean specifying whether to allow color coded items in the output database to override the edge and fill color settings. The default value is ON.

labelFont

A String specifying the label font to be used for all model labels. The default value is "-*-courier-medium-r-normal-*-*-120-*-*-m-*-*-*".

elemLabels

A Boolean specifying whether to plot the element labels. The default value is OFF.

elemLabelColor

A String specifying the color to be used to plot the element labels. The default value is "Cyan".

faceLabels

A Boolean specifying whether to plot the face labels. The default value is OFF.

faceLabelColor

A String specifying the color to be used to plot the face labels. The default value is "Red".

nodeLabels

A Boolean specifying whether to plot the node labels. The default value is OFF.

nodeLabelColor

A String specifying the color to be used to plot the node labels. The default value is "Yellow".

nodeSymbols

A Boolean specifying whether to plot the node symbols. The default value is OFF.

nodeSymbolType

A SymbolicConstant specifying the node symbol types. Possible values are:

  • FILLED_CIRCLE

  • FILLED_SQUARE

  • FILLED_DIAMOND

  • FILLED_TRI

  • HOLLOW_CIRCLE

  • HOLLOW_SQUARE

  • HOLLOW_DIAMOND

  • HOLLOW_TRI

  • CROSS

  • XMARKER

The default value is HOLLOW_CIRCLE.

nodeSymbolColor

A String specifying the color to be used to plot the node symbols. The default value is "Yellow".

nodeSymbolSize

A SymbolicConstant specifying the node symbol size. Possible values are SMALL, MEDIUM, and LARGE. The default value is SMALL.

elementShrink

A Boolean specifying whether elements are displayed in a shrunk format. The default value is OFF.

elementShrinkFactor

An Int specifying the percentage to shrink the elements when elementShrink=ON. Possible values are 0≤ elementShrinkPercentage ≤ 90. The default value is 5.

coordinateScale

A Boolean specifying whether to scale coordinates. The default value is OFF.

coordinateScaleFactors

A sequence of three Floats specifying the coordinate scaling in each of the three coordinate directions when coordinateScale=ON. The default value is (1, 1, 1).

normals

A Boolean specifying whether to draw arrows that indicate the directions of element and surface normals. The default value is OFF.

normalDisplay

A SymbolicConstant specifying whether to draw element normals or surface normals. Possible values are ELEMENT and SURFACE. The default value is ELEMENT.

faceNormalColor

A String specifying the color to be used to plot the normal to a nonbeam element or to a surface. The default value is "Red".

beamN1Color

A String specifying the color to be used to plot an arrow along the beam n1-direction. The default value is "Blue".

beamN2Color

A String specifying the color to be used to plot an arrow along the beam n2-direction. The default value is "Red".

beamTangentColor

A String specifying the color to be used to plot an arrow along the tangent to a beam. The default value is "White".

normalArrowLength

A SymbolicConstant specifying the length of the normal arrows. Possible values are SHORT, MEDIUM, and LONG. The default value is MEDIUM.

normalLineThickness

A SymbolicConstant specifying the thickness of the normal arrows. Possible values are VERY_THIN, THIN, MEDIUM, and THICK. The default value is VERY_THIN.

normalArrowheadStyle

A SymbolicConstant specifying the arrowhead style of the normal arrows. Possible values are NONE, FILLED, and WIRE. The default value is WIRE.

translucency

A Boolean specifying whether to set translucency. The default value is OFF.

translucencyFactor

A Float specifying the translucency factor when translucency=ON. Possible values are 0.0≤ translucencyFactor ≤ 1.0. The default value is 0.3.

Return value

None.

Exceptions

RangeError.

Members

The CommonOptions object can have the following members:

deformationScaling

A SymbolicConstant specifying the deformation scale factor mode. Possible values are AUTO, UNIFORM, and NONUNIFORM. The default value is AUTO.

uniformScaleFactor

A Float specifying the uniform deformation scaling constant when deformationScaling=UNIFORM. The default value is autoDeformationScaleValue.

autoDeformationScaleValue

A Float specifying the deformation scale factor value when deformationScaling=AUTO. This value is read-only.

nonuniformScaleFactor

A tuple of three Floats specifying the deformation scaling in each of the three coordinate directions when deformationScaling=NONUNIFORM. The default value is (autoDeformationScaleValue, autoDeformationScaleValue, autoDeformationScaleValue).

renderStyle

A SymbolicConstant specifying the render style of the plot. Possible values are WIREFRAME, FILLED, HIDDEN, and SHADED. The default value is SHADED.

visibleEdges

A SymbolicConstant specifying which edges to plot. Possible values are ALL, EXTERIOR, FEATURE, FREE, and NONE. The default value is EXTERIOR.

NONE can be used only when renderStyle=SHADED.

edgeLineStyle

A SymbolicConstant specifying the edge line style. Possible values are SOLID, DASHED, DOTTED, and DOT_DASH. The default value is SOLID.

edgeLineThickness

A SymbolicConstant specifying the edge line thickness. Possible values are VERY_THIN, THIN, MEDIUM, and THICK. The default value is VERY_THIN.

colorCodeOverride

A Boolean specifying whether to allow color coded items in the output database to override the edge and fill color settings. The default value is ON.

elemLabels

A Boolean specifying whether to plot the element labels. The default value is OFF.

faceLabels

A Boolean specifying whether to plot the face labels. The default value is OFF.

nodeLabels

A Boolean specifying whether to plot the node labels. The default value is OFF.

nodeSymbols

A Boolean specifying whether to plot the node symbols. The default value is OFF.

nodeSymbolType

A SymbolicConstant specifying the node symbol types. Possible values are:

  • FILLED_CIRCLE

  • FILLED_SQUARE

  • FILLED_DIAMOND

  • FILLED_TRI

  • HOLLOW_CIRCLE

  • HOLLOW_SQUARE

  • HOLLOW_DIAMOND

  • HOLLOW_TRI

  • CROSS

  • XMARKER

The default value is HOLLOW_CIRCLE.

nodeSymbolSize

A SymbolicConstant specifying the node symbol size. Possible values are SMALL, MEDIUM, and LARGE. The default value is SMALL.

elementShrink

A Boolean specifying whether elements are displayed in a shrunk format. The default value is OFF.

elementShrinkFactor

An Int specifying the percentage to shrink the elements when elementShrink=ON. Possible values are 0≤ elementShrinkPercentage ≤ 90. The default value is 5.

coordinateScale

A Boolean specifying whether to scale coordinates. The default value is OFF.

normals

A Boolean specifying whether to draw arrows that indicate the directions of element and surface normals. The default value is OFF.

normalDisplay

A SymbolicConstant specifying whether to draw element normals or surface normals. Possible values are ELEMENT and SURFACE. The default value is ELEMENT.

normalArrowLength

A SymbolicConstant specifying the length of the normal arrows. Possible values are SHORT, MEDIUM, and LONG. The default value is MEDIUM.

normalLineThickness

A SymbolicConstant specifying the thickness of the normal arrows. Possible values are VERY_THIN, THIN, MEDIUM, and THICK. The default value is VERY_THIN.

normalArrowheadStyle

A SymbolicConstant specifying the arrowhead style of the normal arrows. Possible values are NONE, FILLED, and WIRE. The default value is WIRE.

translucency

A Boolean specifying whether to set translucency. The default value is OFF.

translucencyFactor

A Float specifying the translucency factor when translucency=ON. Possible values are 0.0≤ translucencyFactor ≤ 1.0. The default value is 0.3.

edgeColorWireHide

A String specifying the color to be used to plot the edges of the model when renderStyle=WIREFRAME or HIDDEN. The default value is "White".

edgeColorFillShade

A String specifying the color to be used to plot the edges of the model when renderStyle=FILLED or SHADED. The default value is "Black".

fillColor

A String specifying the color to be used to fill elements when renderStyle=FILLED or SHADED. The default value is "White".

labelFont

A String specifying the label font to be used for all model labels. The default value is "-*-courier-medium-r-normal-*-*-120-*-*-m-*-*-*".

elemLabelColor

A String specifying the color to be used to plot the element labels. The default value is "Cyan".

faceLabelColor

A String specifying the color to be used to plot the face labels. The default value is "Red".

nodeLabelColor

A String specifying the color to be used to plot the node labels. The default value is "Yellow".

nodeSymbolColor

A String specifying the color to be used to plot the node symbols. The default value is "Yellow".

faceNormalColor

A String specifying the color to be used to plot the normal to a nonbeam element or to a surface. The default value is "Red".

beamN1Color

A String specifying the color to be used to plot an arrow along the beam n1-direction. The default value is "Blue".

beamN2Color

A String specifying the color to be used to plot an arrow along the beam n2-direction. The default value is "Red".

beamTangentColor

A String specifying the color to be used to plot an arrow along the tangent to a beam. The default value is "White".

coordinateScaleFactors

A tuple of three Floats specifying the coordinate scaling in each of the three coordinate directions when coordinateScale=ON. The default value is (1, 1, 1).