Canvas

Canvas commands are used to create, position, and modify canvas objects. The Canvas commands need only the abaqus module to be imported; no additional modules need to be imported.

Create layers in a viewport

Viewport

class Viewport(name, origin=(0.0, 0.0), width=120.0, height=80.0, border=ON, titleBar=ON, titleStyle=abaqusConstants.SYSTEM, customTitleString='')

Public Data Attributes:

Inherited from ViewportBase

origin	A pair of Floats specifying the X- and Y-coordinates in millimeters in the canvas coordinate system of the lower left corner of the viewport.
width	A Float specifying the width in millimeters of the viewport.
height	A Float specifying the height in millimeters of the viewport.
border	A Boolean specifying whether the viewport border is visible in a printed image.
titleBar	A Boolean specifying whether the viewport title should be displayed in a printed image.
titleStyle	A SymbolicConstant specifying which title to use for the viewport title.
customTitleString	A String specifying the viewport title when titleStyle =CUSTOM.
displayMode	A SymbolicConstant specifying the display mode of the viewport.
viewManipLayers	A SymbolicConstant specifying which layer or layers will be controlled by the view manipulation tools when displayMode = OVERLAY.
layerOffset	A Float specifying a factor to be used in offsetting layers in the screen Z direction.
windowState	A SymbolicConstant specifying the current state of a viewport.
currentWidth	A Float specifying the width in millimeters of the current viewport, regardless of the value of windowState.
currentHeight	A Float specifying the height in millimeters of the current viewport, regardless of the value of windowState, and including the title bar.
applyLinkedCommands	A Boolean specifying whether the viewport is linked for synchronization.
activeColorModes	A SymbolicConstant specifying the currently active color mappings.
colorMode	A SymbolicConstant specifying the last applied color mapping.
translucency	A Float specifying the translucency that will be applied to objects colored using initialColor and it needs to be set along with initialColor.
animationConnect	A Boolean specifying whether an animation is connected to the viewport.
colorMappings	A repository of AttributeColorMap objects specifying the objects cannot be constructed but the following attribute maps are supported:
initialColor	A String specifying the color that will be applied to all objects in the viewport at the start of color coding.
currentLayer	A String specifying which layer is affected by options settings when displayMode =OVERLAY.
displayedObject	A Displayable object specifying the object to be displayed.
layers	A repository of Layer objects specifying the key to the repository is a String with the name of the layer.
view	A View object specifying the object that controls viewing of the viewport content.
odbDisplay	An OdbDisplay object specifying the display options for the Odb object.
partDisplay	A PartDisplayOptions object specifying the display options for the Part object.
assemblyDisplay	An AssemblyDisplayOptions object specifying the display options for the Assembly object.
viewportAnnotationOptions	A ViewportAnnotationOptions object.
detailPlotOptions	A DetailPlotOptions object.
annotationsToPlot	An AnnotationsToPlotArray object.
visibleLayers	A tuple of Strings specifying the names of layers that will be displayed in the viewport when displayMode = OVERLAY.
currentOrigin	A pair of Floats specifying the X- and Y-coordinates in millimeters in the canvas coordinate system of the lower left corner of the current viewport, regardless of the value of windowState.
iconOrigin	A pair of Floats specifying the X- and Y-coordinates in millimeters of the lower left corner of the current viewport from a coordinate system having its origin in the lower left corner of the drawing area.
lightOptions	A LightOptions object.
imageOptions	An ImageOptions object.
movieOptions	A MovieOptions object.
animationController	An AnimationController object.
drawings	A tuple of Strings specifying keys to the session.drawings repository.

Public Methods:

Layer(name[, copyViewName])

This method creates a Layer object in the Layer repository.

Inherited from AnnotationViewport

plotAnnotation(annotation[, index])

This method plots an Annotation object in aViewport.

Inherited from ViewportBase

__init__(name[, origin, width, height, ...])	This method creates a Viewport object with the specified origin and dimensions.
bringToFront()	This method moves the Viewport object to the front.
disableMultipleColors()	This method disables applying multiple color mappings that was enabled using enableMultipleColors
disableRefresh()	This method disables Viewport refresh.
disableColorCodeUpdates()	This method disables Viewport updates and internal computations triggered because of color coding.
enableMultipleColors()	This method enables multiple color mappings to be applied at the same time.
enableRefresh()	This method enables Viewport refresh disabled using disableRefresh.
enableColorCodeUpdates()	This method enables Viewport color code updates disabled using disableColorCodeUpdates.
getActiveElementLabels([useCut, printResults])	This method returns the element labels currently active in the viewport based on the current display group.
getActiveNodeLabels([useCut, printResults])	This method returns the node labels currently active in the viewport based on the current display group.
getPrimVarMinMaxLoc()	This method returns a dictionary containing the minimum, maximum and their location for the current primary variable.
makeCurrent()	This method makes theViewport object the current viewport.
maximize()	This method maximizes the Viewport object to fill the drawing area.
minimize()	This method minimizes the Viewport object to appear as an abbreviated title bar.
offset([deltaX, deltaY])	This method modifies the current X-Y location of the viewport by the specified distance.
restore()	This method restores a maximized or minimized Viewport object to its previous size and location.
sendToBack()	This method moves the Viewport object to the back.
setColor(*args, **kwargs)
forceRefresh()	This method causes the Viewport to refresh immediately.
setValues([displayedObject, displayMode, ...])	This method modifies the Viewport object.
addDrawings([names])	This method identifies the names of Drawing objects to be rendered in the Viewport.
removeDrawings([names])	This method identifies the names of Drawing objects to no longer be rendered in the Viewport.
timeDisplay([numFrames, numSeconds, ...])	This method refreshes the Viewport display numFrames times and then checks to see if numSeconds seconds have elapsed.

Inherited from _OptionsBase

get_user_attributes()	Returns a list of the user attributes of the class.
setValues([displayedObject, displayMode, ...])	This method modifies the Viewport object.

---

Layer(name, copyViewName='')

This method creates a Layer object in the Layer repository.

Note

This function can be accessed by:

session.viewports[name].Layer

Note

Check Layer on help.3ds.com/0.1..

Parameters:

• name (str) – A String specifying the repository key.

• copyViewName (str, default: '') – A String specifying the name of the layer to copy.

Returns:

A Layer object.

Return type:

Layer

Object features

Annotation features of Viewport

class AnnotationViewport(name, origin=(0.0, 0.0), width=120.0, height=80.0, border=ON, titleBar=ON, titleStyle=abaqusConstants.SYSTEM, customTitleString='')

The following commands operate on Viewport objects. For more information about the Viewport object, see Viewport object.

Note

This object can be accessed by:

import annotationToolset

Note

Check AnnotationViewport on help.3ds.com/0.1..

Public Data Attributes:

Inherited from ViewportBase

origin	A pair of Floats specifying the X- and Y-coordinates in millimeters in the canvas coordinate system of the lower left corner of the viewport.
width	A Float specifying the width in millimeters of the viewport.
height	A Float specifying the height in millimeters of the viewport.
border	A Boolean specifying whether the viewport border is visible in a printed image.
titleBar	A Boolean specifying whether the viewport title should be displayed in a printed image.
titleStyle	A SymbolicConstant specifying which title to use for the viewport title.
customTitleString	A String specifying the viewport title when titleStyle =CUSTOM.
displayMode	A SymbolicConstant specifying the display mode of the viewport.
viewManipLayers	A SymbolicConstant specifying which layer or layers will be controlled by the view manipulation tools when displayMode = OVERLAY.
layerOffset	A Float specifying a factor to be used in offsetting layers in the screen Z direction.
windowState	A SymbolicConstant specifying the current state of a viewport.
currentWidth	A Float specifying the width in millimeters of the current viewport, regardless of the value of windowState.
currentHeight	A Float specifying the height in millimeters of the current viewport, regardless of the value of windowState, and including the title bar.
applyLinkedCommands	A Boolean specifying whether the viewport is linked for synchronization.
activeColorModes	A SymbolicConstant specifying the currently active color mappings.
colorMode	A SymbolicConstant specifying the last applied color mapping.
translucency	A Float specifying the translucency that will be applied to objects colored using initialColor and it needs to be set along with initialColor.
animationConnect	A Boolean specifying whether an animation is connected to the viewport.
colorMappings	A repository of AttributeColorMap objects specifying the objects cannot be constructed but the following attribute maps are supported:
initialColor	A String specifying the color that will be applied to all objects in the viewport at the start of color coding.
currentLayer	A String specifying which layer is affected by options settings when displayMode =OVERLAY.
displayedObject	A Displayable object specifying the object to be displayed.
layers	A repository of Layer objects specifying the key to the repository is a String with the name of the layer.
view	A View object specifying the object that controls viewing of the viewport content.
odbDisplay	An OdbDisplay object specifying the display options for the Odb object.
partDisplay	A PartDisplayOptions object specifying the display options for the Part object.
assemblyDisplay	An AssemblyDisplayOptions object specifying the display options for the Assembly object.
viewportAnnotationOptions	A ViewportAnnotationOptions object.
detailPlotOptions	A DetailPlotOptions object.
annotationsToPlot	An AnnotationsToPlotArray object.
visibleLayers	A tuple of Strings specifying the names of layers that will be displayed in the viewport when displayMode = OVERLAY.
currentOrigin	A pair of Floats specifying the X- and Y-coordinates in millimeters in the canvas coordinate system of the lower left corner of the current viewport, regardless of the value of windowState.
iconOrigin	A pair of Floats specifying the X- and Y-coordinates in millimeters of the lower left corner of the current viewport from a coordinate system having its origin in the lower left corner of the drawing area.
lightOptions	A LightOptions object.
imageOptions	An ImageOptions object.
movieOptions	A MovieOptions object.
animationController	An AnimationController object.
drawings	A tuple of Strings specifying keys to the session.drawings repository.

Public Methods:

plotAnnotation(annotation[, index])

This method plots an Annotation object in aViewport.

Inherited from ViewportBase

__init__(name[, origin, width, height, ...])	This method creates a Viewport object with the specified origin and dimensions.
bringToFront()	This method moves the Viewport object to the front.
disableMultipleColors()	This method disables applying multiple color mappings that was enabled using enableMultipleColors
disableRefresh()	This method disables Viewport refresh.
disableColorCodeUpdates()	This method disables Viewport updates and internal computations triggered because of color coding.
enableMultipleColors()	This method enables multiple color mappings to be applied at the same time.
enableRefresh()	This method enables Viewport refresh disabled using disableRefresh.
enableColorCodeUpdates()	This method enables Viewport color code updates disabled using disableColorCodeUpdates.
getActiveElementLabels([useCut, printResults])	This method returns the element labels currently active in the viewport based on the current display group.
getActiveNodeLabels([useCut, printResults])	This method returns the node labels currently active in the viewport based on the current display group.
getPrimVarMinMaxLoc()	This method returns a dictionary containing the minimum, maximum and their location for the current primary variable.
makeCurrent()	This method makes theViewport object the current viewport.
maximize()	This method maximizes the Viewport object to fill the drawing area.
minimize()	This method minimizes the Viewport object to appear as an abbreviated title bar.
offset([deltaX, deltaY])	This method modifies the current X-Y location of the viewport by the specified distance.
restore()	This method restores a maximized or minimized Viewport object to its previous size and location.
sendToBack()	This method moves the Viewport object to the back.
setColor(*args, **kwargs)
forceRefresh()	This method causes the Viewport to refresh immediately.
setValues([displayedObject, displayMode, ...])	This method modifies the Viewport object.
addDrawings([names])	This method identifies the names of Drawing objects to be rendered in the Viewport.
removeDrawings([names])	This method identifies the names of Drawing objects to no longer be rendered in the Viewport.
timeDisplay([numFrames, numSeconds, ...])	This method refreshes the Viewport display numFrames times and then checks to see if numSeconds seconds have elapsed.

Inherited from _OptionsBase

get_user_attributes()	Returns a list of the user attributes of the class.
setValues([displayedObject, displayMode, ...])	This method modifies the Viewport object.

---

name: str

A String specifying the repository key.

plotAnnotation(annotation, index=0)

This method plots an Annotation object in aViewport.

Note

Check AnnotationViewport.plotAnnotation on help.3ds.com/0.1..

Parameters:

• annotation (Annotation) – An Annotation object to plot.

• index (int, default: 0) – An Int specifying the index of the Annotation object in the sequence of annotations to plot. The default value is zero.

AttributeColorMap

class AttributeColorMap

The AttributeColorMap object is used to store values and attributes associated with AttributeColorMap type objects. AttributeColorMap objects can be modified using the methods described below. The methods accessed via the Viewport object cause the AttributeColorMap object to be updated in the session.viewports[name].colorMappings repository.

Note

This object can be accessed by:

session.viewports[name].colorMappings[name]

Note

Check AttributeColorMap on help.3ds.com/0.1..

Public Data Attributes:

mapType	A SymbolicConstant specifying the type of AttributeColorMap .
overrides
defaultOverrides	A Dictionary object specifying a custom color mapping similar to overrides.
attributeColors	A Dictionary object specifying the color settings of each attribute as described in the abaqus.Canvas.AttributeColorMap.updateOverrides() method.

Public Methods:

setDefaults()	This method resets the AttributeColorMap object to its default state.
setValues([overrides, defaultOverrides])	This method modifies the AttributeColorMap object.
updateOverrides([overrides, defaultOverrides])	This method specifies additional overrides to be added to the current object definition.

Inherited from _OptionsBase

get_user_attributes()	Returns a list of the user attributes of the class.
setValues([overrides, defaultOverrides])	This method modifies the AttributeColorMap object.

---

attributeColors: Optional[dict] = None

A Dictionary object specifying the color settings of each attribute as described in the abaqus.Canvas.AttributeColorMap.updateOverrides() method.

defaultOverrides: Optional[dict] = None

A Dictionary object specifying a custom color mapping similar to overrides. For example: defaultOverrides = {‘Copper’:(1,’’#00FF00’, ‘#00CCFF’, ‘#00FF00’)} The color mapping can contain keys that have not been created. When the key is created, it gets the appropriate values from this mapping.

mapType: Optional[SymbolicConstant] = None

A SymbolicConstant specifying the type of AttributeColorMap . Possible values are MATERIAL_MAP, SECTION_MAP, PART_MAP, ELSET_MAP, AVERAGING_REGION_MAP, and ELTYPE_MAP.

overrides: Optional[dict] = None

setDefaults()

This method resets the AttributeColorMap object to its default state.

setValues(overrides=None, defaultOverrides=None)

This method modifies the AttributeColorMap object.

Note

Check AttributeColorMap.setValues on help.3ds.com/0.1..

Parameters:

• overrides (Optional[dict], default: None) – A Dictionary object specifying a color mapping. Each key is of String type and specifies an attribute in the map; the corresponding values specify the color definition to apply to that attribute in the form (0|1, wire color, edge color, face color). The 0|1 defines the active status for the attribute. For example: overrides = {‘Part-1’:(1,’#00FF00’, ‘#00CCFF’, ‘#00FF00’)}

• defaultOverrides (Optional[dict], default: None) – A Dictionary object specifying a custom color mapping similar to overrides. For example: defaultOverrides = {‘Copper’:(1,’’#00FF00’, ‘#00CCFF’, ‘#00FF00’)}. The color mapping can contain keys that have not been created. When the key is created, it gets the appropriate values from this mapping.

updateOverrides(overrides=None, defaultOverrides=None)

This method specifies additional overrides to be added to the current object definition.

Note

Check AttributeColorMap.updateOverrides on help.3ds.com/0.1..

Parameters:

• overrides (Optional[dict], default: None) – A Dictionary object specifying a color mapping. Each key is of String type and specifies an attribute in the map; the corresponding values specify the color definition to apply to that attribute in the form (0|1, wire color, edge color, face color). The 0|1 defines the active status for the attribute. For example: overrides = {‘Part-1’:(1,’#00FF00’, ‘#00CCFF’, ‘#00FF00’)}

• defaultOverrides (Optional[dict], default: None) – A Dictionary object specifying a custom color mapping similar to overrides. For example: defaultOverrides={‘Copper’:(1,’’#00FF00’, ‘#00CCFF’, ‘#00FF00’)} The color mapping can contain keys that have not been created. When the key is created, it gets the appropriate values from this mapping.

Canvas

class Canvas

Displayable

class Displayable

DrawingArea

class DrawingArea

The DrawingArea object specifies the location and size of the drawing area used for placement of viewports.

Note

This object can be accessed by:

session.drawingArea

Note

Check DrawingArea on help.3ds.com/0.1..

Public Data Attributes:

width	A Float specifying the width in millimeters.
height	A Float specifying the height in millimeters.
origin	A pair of Floats specifying the coordinates of the bottom left hand corner in millimeters.

---

height: Optional[float] = None

A Float specifying the height in millimeters.

origin: Tuple[float, ...] = (0.0, 0.0)

A pair of Floats specifying the coordinates of the bottom left hand corner in millimeters.

width: Optional[float] = None

A Float specifying the width in millimeters.

Highlight

The Highlight commands are used to highlight objects in the current viewport and to remove the highlighting.

highlight(object)

This method highlights an object in the current viewport.

Note

This function can be accessed by:

highlight

Note

Check Highlight.highlight on help.3ds.com/0.1..

Parameters:

object –

An object specifying the object in the current viewport to be highlighted. You can specify only a single object. Abaqus/CAE highlights only the edges of a face when highlighting a surface and a face together. The following objects are supported:

• For the MDB

  • ConstrainedSketchVertex

  • Edge

  • Face

  • Surface

  • Cell

  • Node

  • Element

  • Element face

  • Element edge

  • Feature

  • Datum

  • Instance

  • Set

  • Load

  • Boundary condition

  • Predefined field

  • Display group

• For the ODB

  • Node

  • Element

  • Display group

unhighlight(object)

This method removes highlighting from an object in the current viewport.

Note

This function can be accessed by:

unhighlight

Note

Check Highlight.unhighlight on help.3ds.com/0.1..

Parameters:

object – An object specifying the object in the current viewport from which the highlighting will be removed. You can specify only a single object. See highlight for a list of supported objects.

ImageOptions

class ImageOptions

The ImageOptions object stores settings that control how an image is rendered in a particular viewport. ImageOptions objects are accessed from the image options associated with a particular viewport. The ImageOptions object has no constructor; Abaqus creates the imageOptions member for a viewport when the viewport is created using the values in the imageOptions member of the current viewport.

Note

This object can be accessed by:

session.viewports[name].imageOptions

Note

Check ImageOptions on help.3ds.com/0.1..

Public Data Attributes:

imageName	A String specifying the name of the image.
showImage	A Boolean specifying whether an image should be displayed in the viewport background.
positionMethod	A SymbolicConstant specifying which positioning method is used to determine how the image will be scaled and positioned in the viewport.
fitMethod	A SymbolicConstant specifying which type of fit is performed to scale and position the image in the viewport.
alignment	A SymbolicConstant specifying the relative position of the image in the viewport when positionMethod =AUTO_ALIGN.
xScale	A Float specifying the scale applied to the image width.
yScale	A Float specifying the scale applied to the image height.
origin	A pair of Floats specifying the X- and Y-offsets in millimeters from the lower-left corner of the viewport.
translucency	A Float specifying the translucency factor to use when displaying the image.

Public Methods:

setValues([imageName, showImage, ...])

This method modifies the ImageOptions object.

Inherited from _CopyOptionsBase

setValues([imageName, showImage, ...])

This method modifies the ImageOptions object.

Inherited from _OptionsBase

get_user_attributes()	Returns a list of the user attributes of the class.
setValues([imageName, showImage, ...])	This method modifies the ImageOptions object.

---

alignment: SymbolicConstant = CENTER

A SymbolicConstant specifying the relative position of the image in the viewport when positionMethod =AUTO_ALIGN. Possible values are:

• BOTTOM_LEFT

• BOTTOM_CENTER

• BOTTOM_RIGHT

• CENTER_LEFT

• CENTER

• CENTER_RIGHT

• TOP_LEFT

• TOP_CENTER

• TOP_RIGHT

The default value is CENTER.

fitMethod: SymbolicConstant = BEST_FIT

A SymbolicConstant specifying which type of fit is performed to scale and position the image in the viewport. Possible values are:

• BEST_FIT, specifying a mode where the image is scaled to completely fit within the viewport.

• FIT_WIDTH, specifying a mode where the image width is scaled to match the viewport width.

• FIT_HEIGHT, specifying a mode where the image height is scaled to match the viewport height.

The default value is BEST_FIT.

imageName: str = ''

A String specifying the name of the image. A list of valid image names is in the images repository in the session object.

origin: Tuple[float, ...] = (0.0, 0.0)

A pair of Floats specifying the X- and Y-offsets in millimeters from the lower-left corner of the viewport. The origin argument is ignored unless positionMethod =MANUAL. The default value is (0, 0).

positionMethod: SymbolicConstant = FIT_TO_VIEWPORT

A SymbolicConstant specifying which positioning method is used to determine how the image will be scaled and positioned in the viewport. Possible values are:

• FIT_TO_VIEWPORT, specifying a display mode where the image is scaled to fit in the viewport using the specified fitMethod.

• AUTO_ALIGN, specifying a display mode where the image is scaled as specified by xScale and yScale and then positioned in the viewport using the specified alignment.

• MANUAL, specifying a display mode where the image is scaled as specified by xScale and yScale and then positioned in the viewport using the specified origin.

The default value is FIT_TO_VIEWPORT.

setValues(imageName='', showImage=OFF, positionMethod=abaqusConstants.FIT_TO_VIEWPORT, fitMethod=abaqusConstants.BEST_FIT, alignment=abaqusConstants.CENTER, xScale=1.0, yScale=1.0, origin=(0.0, 0.0), translucency=1.0, options=None)

This method modifies the ImageOptions object.

Note

Check ImageOptions.setValues on help.3ds.com/0.1..

Parameters:

• imageName (str, default: '') – A String specifying the name of the image. A list of valid image names is in the images repository in the session object.

• showImage (Union[AbaqusBoolean, bool], default: OFF) – A Boolean specifying whether an image should be displayed in the viewport background. The default value is OFF.

• positionMethod (SymbolicConstant, default: FIT_TO_VIEWPORT) –

  A SymbolicConstant specifying which positioning method is used to determine how the image will be scaled and positioned in the viewport. Possible values are:

  • FIT_TO_VIEWPORT, specifying a display mode where the image is scaled to fit in the viewport using the specified fitMethod.

  • AUTO_ALIGN, specifying a display mode where the image is scaled as specified by xScale and yScale and then positioned in the viewport using the specified alignment.

  • MANUAL, specifying a display mode where the image is scaled as specified by xScale and yScale and then positioned in the viewport using the specified origin.

  The default value is FIT_TO_VIEWPORT.

• fitMethod (SymbolicConstant, default: BEST_FIT) –

  A SymbolicConstant specifying which type of fit is performed to scale and position the image in the viewport when positionMethod =FIT_TO_VIEWPORT. Possible values are:

  • BEST_FIT, specifying a mode where the image is scaled to completely fit within the viewport.

  • FIT_WIDTH, specifying a mode where the image width is scaled to match the viewport width.

  • FIT_HEIGHT, specifying a mode where the image height is scaled to match the viewport height.

  The default value is BEST_FIT.

• alignment (SymbolicConstant, default: CENTER) –

  A SymbolicConstant specifying the relative position of the image in the viewport when positionMethod =AUTO_ALIGN. Possible values are:

  • BOTTOM_LEFT

  • BOTTOM_CENTER

  • BOTTOM_RIGHT

  • CENTER_LEFT

  • CENTER

  • CENTER_RIGHT

  • TOP_LEFT

  • TOP_CENTER

  • TOP_RIGHT

  The default value is CENTER.

• xScale (float, default: 1.0) – A Float specifying the scale applied to the image width. The xScale argument is ignored when positionMethod =FIT_TO_VIEWPORT. The default value is 1.0.When xScale is negative, the image is mirrored about its y-axis but its position is not affected.

• yScale (float, default: 1.0) – A Float specifying the scale applied to the image height. The yScale argument is ignored when positionMethod =FIT_TO_VIEWPORT. The default value is 1.0.When yScale is negative, the image is mirrored about its x-axis but its position is not affected.

• origin (Tuple[float, ...], default: (0.0, 0.0)) – A pair of Floats specifying the X- and Y-offsets in millimeters from the lower-left corner of the viewport. The origin argument is ignored unless positionMethod =MANUAL. The default value is (0, 0).

• translucency (float, default: 1.0) – A Float specifying the translucency factor to use when displaying the image. Possible values are 0.0 ≤ translucency ≤ 1.0 with 0.0 being invisible and 1.0 being opaque. The default value is 1.0.

• options (Optional[ImageOptions], default: None) – None or an ImageOptions 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.

Raises:

RangeError –

showImage: Union[AbaqusBoolean, bool] = OFF

A Boolean specifying whether an image should be displayed in the viewport background. The default value is OFF.

translucency: float = 1.0

A Float specifying the translucency factor to use when displaying the image. Possible values are 0.0 ≤ translucency ≤ 1.0 with 0.0 being invisible and 1.0 being opaque. The default value is 1.0.

xScale: float = 1.0

A Float specifying the scale applied to the image width. The xScale argument is ignored when positionMethod =FIT_TO_VIEWPORT. The default value is 1.0.When xScale is negative, the image is mirrored about its y-axis but its position is not affected.

yScale: float = 1.0

A Float specifying the scale applied to the image height. The yScale argument is ignored when positionMethod =FIT_TO_VIEWPORT. The default value is 1.0.When yScale is negative, the image is mirrored about its x-axis but its position is not affected.

Layer

class Layer(name, copyViewName='')

Objects can be superimposed by displaying them in different layers of a viewport.

Note

This object can be accessed by:

session.viewports[name].layers[name]

Note

Check Layer on help.3ds.com/0.1..

Public Data Attributes:

displayedObject	A Displayable object specifying the object to be displayed.
view	A View object specifying the object that controls viewing of the layer.
odbDisplay	An OdbDisplay object specifying the display options for the Odb object.
partDisplay	A PartDisplayOptions object specifying the display options for the Part object.
assemblyDisplay	An AssemblyDisplayOptions object specifying the display options for the Assembly object.
copyViewName	A String specifying the name of the layer to copy.

Public Methods:

__init__(name[, copyViewName])	This method creates a Layer object in the Layer repository.
moveBefore(name)	This method moves the layer object before another object in the layer repository.
moveAfter(name)	This method moves the layer object after another object in the layer repository.

---

assemblyDisplay: AssemblyDisplayOptions = <abaqus.DisplayOptions.AssemblyDisplayOptions.AssemblyDisplayOptions object>

An AssemblyDisplayOptions object specifying the display options for the Assembly object.

copyViewName: str = ''

A String specifying the name of the layer to copy.

displayedObject: Displayable = <abaqus.Canvas.Displayable.Displayable object>

A Displayable object specifying the object to be displayed. The Displayable type is an abstract generalization. The concrete possible types are Part, Assembly, ConstrainedSketch, Odb, or XYPlot.

moveAfter(name)

This method moves the layer object after another object in the layer repository.

Note

Check Layer.moveAfter on help.3ds.com/0.1..

Parameters:

name (str) – A String specifying the name of the other Layer object.

moveBefore(name)

This method moves the layer object before another object in the layer repository.

Note

Check Layer.moveBefore on help.3ds.com/0.1..

Parameters:

name (str) – A String specifying the name of the other Layer object.

name: str

A String specifying the repository key.

odbDisplay: OdbDisplay = <abaqus.OdbDisplay.OdbDisplay.OdbDisplay object>

An OdbDisplay object specifying the display options for the Odb object.

partDisplay: PartDisplayOptions = <abaqus.DisplayOptions.PartDisplayOptions.PartDisplayOptions object>

A PartDisplayOptions object specifying the display options for the Part object.

view: Optional[View] = None

A View object specifying the object that controls viewing of the layer.

MovieOptions

class MovieOptions

The MovieOptions object stores settings that control how the movie background for an animation is rendered in a particular viewport. MovieOptions objects are accessed from the movie options associated with a particular viewport. The MovieOptions object has no constructor; Abaqus creates the movieOptions member for a viewport when the viewport is created using the values in the movieOptions member of the current viewport.

Note

This object can be accessed by:

session.viewports[name].movieOptions

Note

Check MovieOptions on help.3ds.com/0.1..

Public Data Attributes:

movieName	A String specifying the name of the movie.
showMovie	A Boolean specifying whether a movie should be displayed in the viewport during an animation.
positionMethod	A SymbolicConstant specifying which positioning method is used to determine how the image will be scaled and positioned in the viewport.
fitMethod	A SymbolicConstant specifying which type of fit is performed to scale and position the image in the viewport.
alignment	A SymbolicConstant specifying the relative position of the image in the viewport when positionMethod =AUTO_ALIGN.
xScale	A Float specifying the scale applied to the image width.
yScale	A Float specifying the scale applied to the image height.
origin	A pair of Floats specifying the X- and Y-offsets in millimeters from the lower-left corner of the viewport.
translucency	A Float specifying the translucency factor to use when displaying the image.

Public Methods:

setValues([movieName, showMovie, ...])

This method modifies the MovieOptions object.

Inherited from _CopyOptionsBase

setValues([movieName, showMovie, ...])

This method modifies the MovieOptions object.

Inherited from _OptionsBase

get_user_attributes()	Returns a list of the user attributes of the class.
setValues([movieName, showMovie, ...])	This method modifies the MovieOptions object.

---

alignment: SymbolicConstant = CENTER

A SymbolicConstant specifying the relative position of the image in the viewport when positionMethod =AUTO_ALIGN. Possible values are:

• BOTTOM_LEFT

• BOTTOM_CENTER

• BOTTOM_RIGHT

• CENTER_LEFT

• CENTER

• CENTER_RIGHT

• TOP_LEFT

• TOP_CENTER

• TOP_RIGHT

The default value is CENTER.

fitMethod: SymbolicConstant = BEST_FIT

A SymbolicConstant specifying which type of fit is performed to scale and position the image in the viewport. Possible values are:

• BEST_FIT, specifying a mode where the image is scaled to completely fit within the viewport.

• FIT_WIDTH, specifying a mode where the image width is scaled to match the viewport width.

• FIT_HEIGHT, specifying a mode where the image height is scaled to match the viewport height.

The default value is BEST_FIT.

movieName: str = ''

A String specifying the name of the movie. A list of valid movie names is in the movies repository in the session object.

origin: Tuple[float, ...] = (0.0, 0.0)

A pair of Floats specifying the X- and Y-offsets in millimeters from the lower-left corner of the viewport. The origin argument is ignored unless positionMethod =MANUAL. The default value is (0, 0).

positionMethod: SymbolicConstant = FIT_TO_VIEWPORT

A SymbolicConstant specifying which positioning method is used to determine how the image will be scaled and positioned in the viewport. Possible values are:

• FIT_TO_VIEWPORT, specifying a display mode where the image is scaled to fit in the viewport using the specified fitMethod.

• AUTO_ALIGN, specifying a display mode where the image is scaled as specified by xScale and yScale and then positioned in the viewport using the specified alignment.

• MANUAL, specifying a display mode where the image is scaled as specified by xScale and yScale and then positioned in the viewport using the specified origin.

The default value is FIT_TO_VIEWPORT.

setValues(movieName='', showMovie=OFF, positionMethod=abaqusConstants.FIT_TO_VIEWPORT, fitMethod=abaqusConstants.BEST_FIT, alignment=abaqusConstants.CENTER, xScale=1.0, yScale=1.0, origin=(0.0, 0.0), translucency=1.0, options=None)

This method modifies the MovieOptions object.

Note

Check MovieOptions.setValues on help.3ds.com/0.1..

Parameters:

• movieName (str, default: '') – A String specifying the name of the movie. A list of valid movie names is in the movies repository in the session object.

• showMovie (Union[AbaqusBoolean, bool], default: OFF) – A Boolean specifying whether a movie should be displayed in the viewport during an animation. The default value is OFF.

• positionMethod (SymbolicConstant, default: FIT_TO_VIEWPORT) –

  A SymbolicConstant specifying which positioning method is used to determine how the image will be scaled and positioned in the viewport. Possible values are:

  • FIT_TO_VIEWPORT, specifying a display mode where the image is scaled to fit in the viewport using the specified fitMethod.

  • AUTO_ALIGN, specifying a display mode where the image is scaled as specified by xScale and yScale and then positioned in the viewport using the specified alignment.

  • MANUAL, specifying a display mode where the image is scaled as specified by xScale and yScale and then positioned in the viewport using the specified origin.

  The default value is FIT_TO_VIEWPORT.

• fitMethod (SymbolicConstant, default: BEST_FIT) –

  A SymbolicConstant specifying which type of fit is performed to scale and position the image in the viewport when positionMethod =FIT_TO_VIEWPORT. Possible values are:

  • BEST_FIT, specifying a mode where the image is scaled to completely fit within the viewport.

  • FIT_WIDTH, specifying a mode where the image width is scaled to match the viewport width.

  • FIT_HEIGHT, specifying a mode where the image height is scaled to match the viewport height.

  The default value is BEST_FIT.

• alignment (SymbolicConstant, default: CENTER) –

  A SymbolicConstant specifying the relative position of the image in the viewport when positionMethod =AUTO_ALIGN. Possible values are:

  • BOTTOM_LEFT

  • BOTTOM_CENTER

  • BOTTOM_RIGHT

  • CENTER_LEFT

  • CENTER

  • CENTER_RIGHT

  • TOP_LEFT

  • TOP_CENTER

  • TOP_RIGHT

  The default value is CENTER.

• xScale (float, default: 1.0) – A Float specifying the scale applied to the movie frame width. The xScale argument is ignored when positionMethod =FIT_TO_VIEWPORT. The default value is 1.0.When xScale is negative, the movie frame is mirrored about its y-axis but its position is not affected.

• yScale (float, default: 1.0) – A Float specifying the scale applied to the movie frame height. The yScale argument is ignored when positionMethod =FIT_TO_VIEWPORT. The default value is 1.0.When yScale is negative, the movie frame is mirrored about its x-axis but its position is not affected.

• origin (Tuple[float, ...], default: (0.0, 0.0)) – A pair of Floats specifying the*X*- and Y-offsets in millimeters from the lower-left corner of the viewport. The origin argument is ignored unless positionMethod =MANUAL. The default value is (0, 0).

• translucency (float, default: 1.0) – A Float specifying the translucency factor to use when displaying the movie frame. Possible values are 0.0 ≤ translucency ≤ 1.0 with 0.0 being invisible and 1.0 being opaque. The default value is 1.0.

• options (Optional[str], default: None) – None or a MovieOptions 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.

Raises:

RangeError –

showMovie: Union[AbaqusBoolean, bool] = OFF

A Boolean specifying whether a movie should be displayed in the viewport during an animation. The default value is OFF.

translucency: float = 1.0

A Float specifying the translucency factor to use when displaying the image. Possible values are 0.0 ≤ translucency ≤ 1.0 with 0.0 being invisible and 1.0 being opaque. The default value is 1.0.

xScale: float = 1.0

A Float specifying the scale applied to the image width. The xScale argument is ignored when positionMethod =FIT_TO_VIEWPORT. The default value is 1.0.When xScale is negative, the image is mirrored about its y-axis but its position is not affected.

yScale: float = 1.0

A Float specifying the scale applied to the image height. The yScale argument is ignored when positionMethod =FIT_TO_VIEWPORT. The default value is 1.0.When yScale is negative, the image is mirrored about its x-axis but its position is not affected.

ViewportBase

class ViewportBase(name, origin=(0.0, 0.0), width=120.0, height=80.0, border=ON, titleBar=ON, titleStyle=abaqusConstants.SYSTEM, customTitleString='')

A viewport is the container for the graphics generated by the application. TheViewport object stores the various settings that determine how objects are displayed within that viewport.

Note

This object can be accessed by:

session.viewports[name]

Note

Check ViewportBase on help.3ds.com/0.1..

activeColorModes: Literal[DEFAULT_COLORS, PART_GEOM_MAP_COLORS, ASSEMBLY_MAP_COLORS, PART_MAP_COLORS, INSTANCE_MAP_COLORS, INSTANCE_TYPE_MAP_COLORS, SECTION_MAP_COLORS, MATERIAL_MAP_COLORS, LOAD_MAP_COLORS, BC_MAP_COLORS, INTERACTION_MAP_COLORS, CONSTRAINT_MAP_COLORS, SET_MAP_COLORS, SURFACE_MAP_COLORS, INTERNAL_SET_MAP_COLORS, INTERNAL_SURFACE_MAP_COLORS, DISPLAY_GRP_MAP_COLORS, SELECTION_GRP_MAP_COLORS, ELTYPE_MAP_COLORS, PLOT_MAP_COLORS, MESH_MAP_COLORS] = DEFAULT_COLORS

A SymbolicConstant specifying the currently active color mappings. Possible values are: DEFAULT_COLORS PART_GEOM_MAP_COLORS ASSEMBLY_MAP_COLORS PART_MAP_COLORS INSTANCE_MAP_COLORS INSTANCE_TYPE_MAP_COLORS SECTION_MAP_COLORS MATERIAL_MAP_COLORS LOAD_MAP_COLORS BC_MAP_COLORS INTERACTION_MAP_COLORS CONSTRAINT_MAP_COLORS SET_MAP_COLORS SURFACE_MAP_COLORS INTERNAL_SET_MAP_COLORS INTERNAL_SURFACE_MAP_COLORS DISPLAY_GRP_MAP_COLORS SELECTION_GRP_MAP_COLORS ELTYPE_MAP_COLORS PLOT_MAP_COLORS MESH_MAP_COLORS The default value is DEFAULT_COLORS.

addDrawings(names=())

This method identifies the names of Drawing objects to be rendered in the Viewport.

Note

Check ViewportBase.addDrawings on help.3ds.com/0.1..

Parameters:

names (tuple, default: ()) – A sequence of String values identifying keys in the session.drawings repository.

Raises:

ValueError –

animationConnect: Union[AbaqusBoolean, bool] = OFF

A Boolean specifying whether an animation is connected to the viewport.

animationController: AnimationController = <abaqus.Animation.AnimationController.AnimationController object>

An AnimationController object.

New in version 2020: The animationController attribute was added.

annotationsToPlot: AnnotationsToPlotArray = []

An AnnotationsToPlotArray object.

applyLinkedCommands: Union[AbaqusBoolean, bool] = ON

A Boolean specifying whether the viewport is linked for synchronization. The default value is ON.

assemblyDisplay: AssemblyDisplayOptions = <abaqus.DisplayOptions.AssemblyDisplayOptions.AssemblyDisplayOptions object>

An AssemblyDisplayOptions object specifying the display options for the Assembly object.

border: Union[AbaqusBoolean, bool] = ON

A Boolean specifying whether the viewport border is visible in a printed image. The default value is ON.

bringToFront()

This method moves the Viewport object to the front.

colorMappings: Dict[str, AttributeColorMap] = {}

A repository of AttributeColorMap objects specifying the objects cannot be constructed but the following attribute maps are supported:

• “type”

• “Element set”

• “Material”

• “Section”

• “Default”

• “Part”

• “Part instance”

• “Element type”

• “Averaging region”

• “Assembly”

• “Property”

• “Set”

• “Surface”

• “Skin”

• “Profile”

• “Part shape”

• “Part status”

• “Part geometry”

• “Meshability”

• “Instance type”

• “Load”

• “Boundary condition”

• “Interaction”

• “Constraint”

• “Interaction type”

• “Constraint type”

• “Display group”

• “Selection group”

• “Interaction property”

• “Connector”

• “Connector type”

• “Connector property”

• “Internal set”

• “Internal surface”

• “mapColors”

• “autoColors”

• “overrides”

• “defaultAutoColors”

• “defaultOverrides”

• “objectToCopy”

• “colorMapping”

• “colorMappings”

• “colorMode”

• “attributeColors”

• “updateOverrides”

• “colorCodeOverride”

• “initialColor”

• “Layup”

• “Ply”

colorMode: Literal[DEFAULT_COLORS, PART_GEOM_MAP_COLORS, ASSEMBLY_MAP_COLORS, PART_MAP_COLORS, INSTANCE_MAP_COLORS, INSTANCE_TYPE_MAP_COLORS, SECTION_MAP_COLORS, MATERIAL_MAP_COLORS, LOAD_MAP_COLORS, BC_MAP_COLORS, INTERACTION_MAP_COLORS, CONSTRAINT_MAP_COLORS, SET_MAP_COLORS, SURFACE_MAP_COLORS, INTERNAL_SET_MAP_COLORS, INTERNAL_SURFACE_MAP_COLORS, DISPLAY_GRP_MAP_COLORS, SELECTION_GRP_MAP_COLORS, ELTYPE_MAP_COLORS, PLOT_MAP_COLORS, MESH_MAP_COLORS] = DEFAULT_COLORS

A SymbolicConstant specifying the last applied color mapping. Possible values are: DEFAULT_COLORS PART_GEOM_MAP_COLORS ASSEMBLY_MAP_COLORS PART_MAP_COLORS INSTANCE_MAP_COLORS INSTANCE_TYPE_MAP_COLORS SECTION_MAP_COLORS MATERIAL_MAP_COLORS LOAD_MAP_COLORS BC_MAP_COLORS INTERACTION_MAP_COLORS CONSTRAINT_MAP_COLORS SET_MAP_COLORS SURFACE_MAP_COLORS INTERNAL_SET_MAP_COLORS INTERNAL_SURFACE_MAP_COLORS DISPLAY_GRP_MAP_COLORS SELECTION_GRP_MAP_COLORS ELTYPE_MAP_COLORS PLOT_MAP_COLORS MESH_MAP_COLORS The default value is DEFAULT_COLORS.

currentHeight: Optional[float] = None

A Float specifying the height in millimeters of the current viewport, regardless of the value of windowState, and including the title bar.

currentLayer: str = ''

A String specifying which layer is affected by options settings when displayMode =OVERLAY. The current layer is also the only layer affected by view manipulations when*viewManipLayers* =CURRENT.

currentOrigin: Tuple[float, ...] = ()

A pair of Floats specifying the X- and Y-coordinates in millimeters in the canvas coordinate system of the lower left corner of the current viewport, regardless of the value of windowState.

currentWidth: Optional[float] = None

A Float specifying the width in millimeters of the current viewport, regardless of the value of windowState.

customTitleString: str = ''

A String specifying the viewport title when titleStyle =CUSTOM. The default value is an empty string.

detailPlotOptions: DetailPlotOptions = <abaqus.PlotOptions.DetailPlotOptions.DetailPlotOptions object>

A DetailPlotOptions object.

disableColorCodeUpdates()

This method disables Viewport updates and internal computations triggered because of color coding. Performance improvement will be significant when color coding is ON and repeating operations are performed using a script each of which requires color code updates. No benefit will be had when color coding is OFF.

disableMultipleColors()

This method disables applying multiple color mappings that was enabled using enableMultipleColors

disableRefresh()

This method disables Viewport refresh. Some methods that require the Viewport to be up-to-date will override this setting. It is advisable to use this method sparingly.

displayMode: Optional[SymbolicConstant] = None

A SymbolicConstant specifying the display mode of the viewport. Possible values are:SINGLE, specifying a single displayedObject.OVERLAY, specifying one or more layers to be displayed simultaneously—each layer contains one displayedObject.

displayedObject: Displayable = <abaqus.Canvas.Displayable.Displayable object>

A Displayable object specifying the object to be displayed. The Displayable type is an abstract generalization. The concrete possible types are Part, Assembly, ConstrainedSketch, Odb, PlyStackPlot, or XYPlot. If displayedObject = None, Abaqus displays an empty viewport.

drawings: tuple = ()

A tuple of Strings specifying keys to the session.drawings repository. The default value is an empty sequence.

enableColorCodeUpdates()

This method enables Viewport color code updates disabled using disableColorCodeUpdates.

enableMultipleColors()

This method enables multiple color mappings to be applied at the same time. It also ensures that the Viewport is updated correctly when initialColor is set.

enableRefresh()

This method enables Viewport refresh disabled using disableRefresh.

forceRefresh()

This method causes the Viewport to refresh immediately. It is provided to allow scripts to refresh the Viewport before the script terminates. Normally, there would only be a single cumulative refresh that takes place immediately after the script completes.

getActiveElementLabels(useCut=OFF, printResults=OFF)

This method returns the element labels currently active in the viewport based on the current display group. The element labels are printed only when the displayedObject member in the Viewport object is set to an Odb. The getActiveElementLabels method has the following arguments:

Note

Check ViewportBase.getActiveElementLabels on help.3ds.com/0.1..

Parameters:

• useCut (Union[AbaqusBoolean, bool], default: OFF) – A Boolean flag to specify if any active cutting plane is to be considered in determining active elements.

• printResults (Union[AbaqusBoolean, bool], default: OFF) – A Boolean flag to specify if the active element labels are to be printed to the replay file.

Returns:

A Dictionary object of element labels, keyed by OdbInstance name. Returns None if the displayedObject member is not an Odb object.

Return type:

dict

getActiveNodeLabels(useCut=OFF, printResults=OFF)

This method returns the node labels currently active in the viewport based on the current display group. The node labels are printed only when the displayedObject member in the Viewport object is set to an Odb. The getActiveNodeLabels method has the following arguments:

Note

Check ViewportBase.getActiveNodeLabels on help.3ds.com/0.1..

Parameters:

• useCut (Union[AbaqusBoolean, bool], default: OFF) – A Boolean flag to specify if any active cutting plane is to be considered in determining active nodes.

• printResults (Union[AbaqusBoolean, bool], default: OFF) – A Boolean flag to specify if the active node labels are to be printed to the replay file.

Returns:

A Dictionary object of node labels, keyed by OdbInstance name. Returns None if the displayedObject member is not an Odb object.

Return type:

dict

getPrimVarMinMaxLoc()

This method returns a dictionary containing the minimum, maximum and their location for the current primary variable. A contour plot should be displayed in the current viewport or else the method will return None.

Returns:

A dictionary with keys ‘minPartInstanceName’, ‘minElementLabel’, ‘minNodeLabel’, ‘minPosition’, ‘maxPartInstanceName’, ‘maxElementLabel’, ‘maxNodeLabel’, ‘maxPosition’ .

Return type:

dict

height: float = 80.0

A Float specifying the height in millimeters of the viewport. This height includes the title bar. Possible values are 30 ≤ height ≤ (maxHeight). The default value is 80.0. Note: The maximum value of height (maxHeight) is the height of the screen in millimeters.

iconOrigin: Tuple[float, ...] = ()

A pair of Floats specifying the X- and Y-coordinates in millimeters of the lower left corner of the current viewport from a coordinate system having its origin in the lower left corner of the drawing area. This origin refers to the viewport location when windowState =MINIMIZED.

imageOptions: ImageOptions = <abaqus.Canvas.ImageOptions.ImageOptions object>

An ImageOptions object.

initialColor: str = ''

A String specifying the color that will be applied to all objects in the viewport at the start of color coding. The possible values are ‘As is’, ‘Default’ or a string with a hexadecimal representation of a color.

layerOffset: Optional[float] = None

A Float specifying a factor to be used in offsetting layers in the screen Z direction. Possible values are -1 to 1. A negative value reverses the apparent order in which the layers are plotted.

layers: Dict[str, Layer] = {}

A repository of Layer objects specifying the key to the repository is a String with the name of the layer.

lightOptions: LightOptions = <abaqus.DisplayOptions.LightOptions.LightOptions object>

A LightOptions object.

makeCurrent()

This method makes theViewport object the current viewport.

maximize()

This method maximizes the Viewport object to fill the drawing area.

minimize()

This method minimizes the Viewport object to appear as an abbreviated title bar.

movieOptions: MovieOptions = <abaqus.Canvas.MovieOptions.MovieOptions object>

A MovieOptions object.

name: str

A String specifying the repository key.

odbDisplay: OdbDisplay = <abaqus.OdbDisplay.OdbDisplay.OdbDisplay object>

An OdbDisplay object specifying the display options for the Odb object.

offset(deltaX=0, deltaY=0)

This method modifies the current X-Y location of the viewport by the specified distance.

Note

Check ViewportBase.offset on help.3ds.com/0.1..

Parameters:

• deltaX (float, default: 0) – A Float specifying the offset in millimeters of the X-component of the viewport origin. The default value is 0.

• deltaY (float, default: 0) – A Float specifying the offset in millimeters of the Y-component of the viewport origin. The default value is 0.

origin: Tuple[float, ...] = (0.0, 0.0)

A pair of Floats specifying the X- and Y-coordinates in millimeters in the canvas coordinate system of the lower left corner of the viewport. The default origin is (0, 0).

partDisplay: PartDisplayOptions = <abaqus.DisplayOptions.PartDisplayOptions.PartDisplayOptions object>

A PartDisplayOptions object specifying the display options for the Part object.

removeDrawings(names=())

This method identifies the names of Drawing objects to no longer be rendered in the Viewport.

Note

Check ViewportBase.removeDrawings on help.3ds.com/0.1..

Parameters:

names (tuple, default: ()) – A sequence of String values identifying keys in the Viewport sequence.

Raises:

ValueError –

restore()

This method restores a maximized or minimized Viewport object to its previous size and location.

sendToBack()

This method moves the Viewport object to the back.

setColor(initialColor: str, translucency: str = '')

setColor(colorMapping: AttributeColorMap)

setColor(leaf: Leaf, edgeColorWireHide: str = '', edgeColorFillShade: str = '', fillColor: str = '', nodeSymbolColor: str = '', nodeSymbolType: Literal[FILLED_CIRCLE, FILLED_SQUARE, FILLED_DIAMOND, FILLED_TRI, HOLLOW_CIRCLE, HOLLOW_SQUARE, HOLLOW_DIAMOND, HOLLOW_TRI, CROSS, XMARKER] = HOLLOW_CIRCLE, nodeSymbolSize: Literal[SMALL, MEDIUM, LARGE] = SMALL)

setValues(displayedObject=None, displayMode=None, visibleLayers=(), viewManipLayers=None, currentLayer='', layerOffset=None)

This method modifies the Viewport object. The arguments to setValues are the same as the arguments to the Viewport method, except for the name argument. In addition, the setValues method has the following arguments:

Note

Check ViewportBase.setValues on help.3ds.com/0.1..

Parameters:

• displayedObject (Optional[Displayable], default: None) – A Displayable object specifying the object to be displayed. The Displayable type is an abstract generalization. The concrete possible types are Part, Assembly, ConstrainedSketch, Odb, PlyStackPlot, or XYPlot. If displayedObject = None, Abaqus displays an empty viewport.

• displayMode (Optional[Literal[SINGLE, OVERLAY]], default: None) –

  A SymbolicConstant specifying the display mode of the viewport. Possible values are:

  • SINGLE, specifying a single displayedObject.

  • OVERLAY, specifying one or more layers to be displayed simultaneously—each layer contains one displayedObject.

• visibleLayers (Tuple[str, ...], default: ()) – A sequence of Strings specifying the names of layers that will be displayed in the viewport when displayMode = OVERLAY.

• viewManipLayers (Optional[Literal[ALL, CURRENT]], default: None) – A SymbolicConstant specifying which layer or layers will be controlled by the view manipulation tools when displayMode = OVERLAY. Possible values are ALL and CURRENT.

• currentLayer (str, default: '') – A String specifying which layer is affected by options settings when displayMode =OVERLAY. The current layer is also the only layer affected by view manipulations when*viewManipLayers* =CURRENT.

• layerOffset (Optional[float], default: None) – A Float specifying a factor to be used in offsetting layers in the screen Z direction. Possible values are -1 to 1. A negative value reverses the apparent order in which the layers are plotted.

Raises:

RangeError –

timeDisplay(numFrames=0, numSeconds=10, degreesPerFrame=0)

This method refreshes the Viewport display numFrames times and then checks to see if numSeconds seconds have elapsed. If not, it will continue refreshing the Viewport until the time has elapsed. At completion, the actual number of refreshes (frames) rendered and elapsed time will be reported along with the calculated frames-per-second (fps).

Note

Check ViewportBase.timeDisplay on help.3ds.com/0.1..

Parameters:

• numFrames (int, default: 0) – An Int specifying the minimum number of times to refresh the Viewport. The default value is 0.

• numSeconds (int, default: 10) – An Int specifying the minimum number of seconds to spend refreshing the Viewport. The default value is 10.

• degreesPerFrame (float, default: 0) – A Float specifying the number of degrees to rotate the model view about its Z axis before each refresh. The default value is 0.0.

titleBar: Union[AbaqusBoolean, bool] = ON

A Boolean specifying whether the viewport title should be displayed in a printed image. The default value is ON.If border = OFF, the title will not be visible, even if titleBar =ON.

titleStyle: Literal[CUSTOM, SYSTEM] = SYSTEM

A SymbolicConstant specifying which title to use for the viewport title. Possible values are CUSTOM and SYSTEM. The default value is SYSTEM.If titleStyle = CUSTOM, customTitleString will be used. If titleStyle = SYSTEM, a system-generated string will be used.

translucency: Optional[float] = None

A Float specifying the translucency that will be applied to objects colored using initialColor and it needs to be set along with initialColor. If initialColor is set to ‘As is’ then translucency will have no effect.

view: Optional[View] = None

A View object specifying the object that controls viewing of the viewport content.

viewManipLayers: Optional[SymbolicConstant] = None

A SymbolicConstant specifying which layer or layers will be controlled by the view manipulation tools when displayMode = OVERLAY. Possible values are ALL and CURRENT.

viewportAnnotationOptions: ViewportAnnotationOptions = <abaqus.DisplayOptions.ViewportAnnotationOptions.ViewportAnnotationOptions object>

A ViewportAnnotationOptions object.

visibleLayers: tuple = ()

A tuple of Strings specifying the names of layers that will be displayed in the viewport when displayMode = OVERLAY.

width: float = 120.0

A Float specifying the width in millimeters of the viewport. Possible values are 30 ≤ width ≤ (maxWidth). The default value is 120. Note: The maximum value of width (maxWidth) is the width of the screen in millimeters.

windowState: Optional[SymbolicConstant] = None

A SymbolicConstant specifying the current state of a viewport. Possible values are NORMAL, MAXIMIZED, and MINIMIZED.