Annotation#

Annotation commands are used to create, position, and modify viewport annotations.

Create annotations#

AnimationUserData.Arrow(name, startPoint=(0.0, 0.0), endPoint=(0.0, 0.0), startAnchor=abaqusConstants.BOTTOM_LEFT, endAnchor=abaqusConstants.BOTTOM_LEFT, startHeadStyle=abaqusConstants.NONE, endHeadStyle=abaqusConstants.FILLED_ARROW, startGap=0.0, endGap=0.0, color='White', lineStyle=abaqusConstants.SOLID, lineThickness=abaqusConstants.VERY_THIN)[source]#

This method creates an Arrow object.

Note

This function can be accessed by:

mdb.Arrow
session.odbs[name].userData.Arrow

Note

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

Parameters:

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

  • startPoint (Tuple[float, ...], default: (0.0, 0.0)) – A pair of Floats specifying the start point X- and Y-offsets in millimeters from startAnchor. The default value is (0, 0).

  • endPoint (Tuple[float, ...], default: (0.0, 0.0)) – A pair of Floats specifying the end point X- and Y-offsets in millimeters from endAnchor. The default value is (0, 0).

  • startAnchor (Union[SymbolicConstant, float], default: BOTTOM_LEFT) –

    A SymbolicConstant or a sequence of Floats specifying a point. A sequence of two Floats specifies the X- and Y-coordinates as percentages of the viewport width and height. A sequence of three Floats specifies the X-, Y-, and Z-coordinates of a point in the model coordinate system. A SymbolicConstant indicates a relative position. Possible values are:

    • BOTTOM_LEFT,,

    • BOTTOM_CENTER

    • BOTTOM_RIGHT

    • CENTER_LEFT

    • CENTER

    • CENTER_RIGHT

    • TOP_LEFT

    • TOP_CENTER

    • TOP_RIGHT

    The default value is BOTTOM_LEFT.

  • endAnchor (Union[SymbolicConstant, float], default: BOTTOM_LEFT) –

    A SymbolicConstant or a sequence of Floats specifying a point. A sequence of two Floats specifies the X- and Y-coordinates as percentages of the viewport width and height. A Sequence of three Floats specifies the X-, Y-, and Z-coordinates of a point in the model coordinate system. A SymbolicConstant indicates a relative position. Possible values are:

    • BOTTOM_LEFT

    • BOTTOM_CENTER

    • BOTTOM_RIGHT

    • CENTER_LEFT

    • CENTER

    • CENTER_RIGHT

    • TOP_LEFT

    • TOP_CENTER

    • TOP_RIGHT

    The default value is BOTTOM_LEFT.

  • startHeadStyle (SymbolicConstant, default: NONE) –

    A SymbolicConstant specifying the style of the start head. Possible values are:

    • ARROW

    • FILLED_ARROW

    • HOLLOW_CIRCLE

    • FILLED_CIRCLE

    • HOLLOW_DIAMOND

    • FILLED_DIAMOND

    • HOLLOW_SQUARE

    • FILLED_SQUARE

    • NONE

    The default value is NONE.

  • endHeadStyle (SymbolicConstant, default: FILLED_ARROW) –

    A SymbolicConstant specifying the style of the end head. Possible values are:

    • ARROW

    • FILLED_ARROW

    • HOLLOW_CIRCLE

    • FILLED_CIRCLE

    • HOLLOW_DIAMOND

    • FILLED_DIAMOND

    • HOLLOW_SQUARE

    • FILLED_SQUARE

    • NONE

    The default value is FILLED_ARROW.

  • startGap (float, default: 0.0) – A Float specifying the distance in millimeters between the arrow start point and the arrow start head. The default value is 0.0.

  • endGap (float, default: 0.0) – A Float specifying the distance in millimeters between the arrow end point and the arrow end head. The default value is 0.0.

  • color (str, default: 'White') – A String specifying the color of the arrow. Possible string values are any valid color. The default value is “White”.

  • lineStyle (SymbolicConstant, default: SOLID) – A SymbolicConstant specifying the line style of the arrow. Possible values are SOLID, DASHED, DOTTED, and DOT_DASH. The default value is SOLID.

  • lineThickness (SymbolicConstant, default: VERY_THIN) – A SymbolicConstant specifying the line thickness of the arrow. Possible values are VERY_THIN, THIN, MEDIUM, and THICK. The default value is VERY_THIN.

Returns:

An Arrow object.

Return type:

Arrow

AnimationUserData.Text(name, text='', offset=(), anchor=abaqusConstants.BOTTOM_LEFT, referencePoint=abaqusConstants.BOTTOM_LEFT, rotationAngle=0, color='White', font='-*-verdana-medium-r-normal--120-*', backgroundStyle=abaqusConstants.TRANSPARENT, backgroundColor='', box=OFF, justification=abaqusConstants.JUSTIFY_LEFT)[source]#

This method creates a Text object.

Note

This function can be accessed by:

mdb.Text
session.odbs[name].userData.Text

Note

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

Parameters:

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

  • text (str, default: '') – A String specifying the text of the Text object. The default value is an empty string.

  • offset (Tuple[float, ...], default: ()) – A pair of Floats specifying the X- and Y-offsets in millimeters of the Text object from anchor. The default value is (0, 0).

  • anchor (Union[SymbolicConstant, float], default: BOTTOM_LEFT) –

    A SymbolicConstant or a sequence of Floats specifying a point. A sequence of two Floats specifies the X- and Y coordinates as percentages of the viewport width and height. A Sequence of three Floats specifies the X-, Y-, and Z-coordinates of a point in the model coordinate system. A SymbolicConstant specifies a relative position. Possible values are:

    • BOTTOM_LEFT

    • BOTTOM_CENTER

    • BOTTOM_RIGHT

    • CENTER_LEFT

    • CENTER

    • CENTER_RIGHT

    • TOP_LEFT

    • TOP_CENTER

    • TOP_RIGHT

    The default value is BOTTOM_LEFT.

  • referencePoint (Union[SymbolicConstant, float], default: BOTTOM_LEFT) –

    A SymbolicConstant or a sequence of Floats specifying a point. The sequence of two Floats specifies the X- and Y-coordinates of the reference point of the Text annotation given as percentages of its width and height. The SymbolicConstant indicates a relative position. Possible values are:

    • BOTTOM_LEFT

    • BOTTOM_CENTER

    • BOTTOM_RIGHT

    • CENTER_LEFT

    • CENTER

    • CENTER_RIGHT

    • TOP_LEFT

    • TOP_CENTER

    • TOP_RIGHT

    The default value is BOTTOM_LEFT.

  • rotationAngle (float, default: 0) – A Float specifying the amount of rotation in degrees about referencePoint. The default value is 0.0.

  • color (str, default: 'White') – A String specifying the color of the Text object. Possible string values are any valid color. The default value is “White”.

  • font (str, default: '-*-verdana-medium-r-normal--120-*') – A String specifying the font of the Text object. Possible string values are any valid font specification. The default value is “--verdana-medium-r-normal–120-“.

  • backgroundStyle (SymbolicConstant, default: TRANSPARENT) – A SymbolicConstant specifying the Text object background style. Possible values are MATCH, TRANSPARENT, and OTHER. The default value is TRANSPARENT.

  • backgroundColor (str, default: '') – A String specifying the color of the Text object background. Possible string values are any valid color. The default value matches the viewport background.

  • box (Union[AbaqusBoolean, bool], default: OFF) – A Boolean specifying whether the box around the text is shown. The default value is OFF.

  • justification (SymbolicConstant, default: JUSTIFY_LEFT) – A SymbolicConstant specifying the Text object justification for multiline text. Possible values are JUSTIFY_LEFT, JUSTIFY_CENTER, and JUSTIFY_RIGHT. The default value is JUSTIFY_LEFT.

Returns:

A Text object.

Return type:

Text

AnimationUserData.XYData(name, data, sourceDescription='', contentDescription='', positionDescription='', legendLabel='', xValuesLabel='', yValuesLabel='', axis1QuantityType=None, axis2QuantityType=None)[source]#

This method creates an XYData object from a sequence of X - Y data pairs.

Note

This function can be accessed by:

session.odbs[name].userData.XYData

Note

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

Parameters:

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

  • data (tuple) – A sequence of pairs of Floats specifying the X - Y data pairs.

  • sourceDescription (str, default: '') – A String specifying the source of the X - Y data (e.g., “Entered from keyboard”, “Taken from ASCII file”, “Read from an ODB”, etc.). The default value is an empty string.

  • contentDescription (str, default: '') – A String specifying the content of the X - Y data (e.g., “field 1 vs. field 2”). The default value is an empty string.

  • positionDescription (str, default: '') – A String specifying additional information about the X - Y data (e.g., “for whole model”). The default value is an empty string.

  • legendLabel (str, default: '') – A String specifying the label to be used in the legend. The default value is the name of the XYData object.

  • xValuesLabel (str, default: '') – A String specifying the label for the X-values. This value may be overridden if the X - Y data are combined with other X - Y data. The default value is an empty string.

  • yValuesLabel (str, default: '') – A String specifying the label for the Y-values. This value may be overridden if the X - Y data are combined with other X - Y data. The default value is an empty string.

  • axis1QuantityType (Optional[QuantityType], default: None) – A QuantityType object specifying the QuantityType object associated to the X -axis1- values.

  • axis2QuantityType (Optional[QuantityType], default: None) – A QuantityType object specifying the QuantityType object associated to the Y -axis2- values.

Returns:

An XYData object.

Return type:

XYData

Object features#

Annotation#

class Annotation[source]#

The Annotation object is the abstract base type for other Annotation objects. The Annotation object has no explicit constructor. The methods and members of the Annotation object are common to all objects derived from Annotation.

Note

This object can be accessed by:

import annotationToolset
mdb.annotations[name]
session.odbs[name].userData.annotations[name]
session.viewports[name].annotationsToPlot[i]

Note

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

Public Data Attributes:

name

A String specifying the annotation repository key.

Public Methods:

bringToFront()

This method brings the Annotation object to the top of the annotation stack.

sendToBack()

This method sends the Annotation object to the bottom of the annotation stack.

bringForward()

This method brings the Annotation object one position up in the annotation stack.

sendBackward()

This method sends the Annotation object one position down in the annotation stack.

moveBefore(name)

This method moves the Annotation object before another object in the same repository.

moveAfter(name)

This method moves the Annotation object after another object in the same repository.

translate([x, y])

This method translates the Annotation object on the viewport plane.
bringForward()[source]#

This method brings the Annotation object one position up in the annotation stack.

bringToFront()[source]#

This method brings the Annotation object to the top of the annotation stack.

moveAfter(name)[source]#

This method moves the Annotation object after another object in the same repository.

Note

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

Parameters:

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

moveBefore(name)[source]#

This method moves the Annotation object before another object in the same repository.

Note

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

Parameters:

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

name: str = ''[source]#

A String specifying the annotation repository key.

sendBackward()[source]#

This method sends the Annotation object one position down in the annotation stack.

sendToBack()[source]#

This method sends the Annotation object to the bottom of the annotation stack.

translate(x=None, y=None)[source]#

This method translates the Annotation object on the viewport plane.

Note

Check Annotation.translate on help.3ds.com/0.1..

Parameters:

  • x (Optional[float], default: None) – A Float specifying the X translation amount in millimeters.

  • y (Optional[float], default: None) – A Float specifying the Y translation amount in millimeters.

AnnotationsToPlotArray#

class AnnotationsToPlotArray[source]#

The AnnotationsToPlotArray object is a sequence that stores references to plotted annotations. By adding annotations to and removing annotations from this sequence, you can control which annotations are displayed in a particular viewport.

Note

This object can be accessed by:

import annotationToolset
session.viewports[name].annotationsToPlot

Note

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

Public Methods:

__new__(cls)

bringForward(index)

This method brings the Annotation object one position forward in the AnnotationsToPlotArray sequence.

bringToFront(index)

This method brings the Annotation object to the beginning of the AnnotationsToPlotArray sequence.

moveAfter(index, other)

This method moves the Annotation object after another object in the same AnnotationsToPlotArray sequence.

moveBefore(index, other)

This method moves the Annotation object before another object in the same AnnotationsToPlotArray sequence.

sendBackward(index)

This method sends the Annotation object one position backward in the AnnotationsToPlotArray sequence.

sendToBack(index)

This method sends the Annotation object to the end of the AnnotationsToPlotArray sequence.
Inherited from list

__repr__()

Return repr(self).

__getattribute__(name, /)

Return getattr(self, name).

__lt__(value, /)

Return self<value.

__le__(value, /)

Return self<=value.

__eq__(value, /)

Return self==value.

__ne__(value, /)

Return self!=value.

__gt__(value, /)

Return self>value.

__ge__(value, /)

Return self>=value.

__iter__()

Implement iter(self).

__init__(*args, **kwargs)

__len__()

Return len(self).

__getitem__

x.__getitem__(y) <==> x[y]

__setitem__(key, value, /)

Set self[key] to value.

__delitem__(key, /)

Delete self[key].

__add__(value, /)

Return self+value.

__mul__(value, /)

Return self*value.

__rmul__(value, /)

Return value*self.

__contains__(key, /)

Return key in self.

__iadd__(value, /)

Implement self+=value.

__imul__(value, /)

Implement self*=value.

__reversed__()

Return a reverse iterator over the list.

__sizeof__()

Return the size of the list in memory, in bytes.

clear()

Remove all items from list.

copy()

Return a shallow copy of the list.

append(object, /)

Append object to the end of the list.

insert(index, object, /)

Insert object before index.

extend(iterable, /)

Extend list by appending elements from the iterable.

pop([index])

Remove and return item at index (default last).

remove(value, /)

Remove first occurrence of value.

index(value[, start, stop])

Return first index of value.

count(value, /)

Return number of occurrences of value.

reverse()

Reverse IN PLACE.

sort(*[, key, reverse])

Sort the list in ascending order and return None.

__class_getitem__

See PEP 585
Inherited from Generic

__class_getitem__

See PEP 585

__init_subclass__(*args, **kwargs)

This method is called when a class is subclassed.

Private Data Attributes:

Inherited from Generic

_is_protocol

bringForward(index)[source]#

This method brings the Annotation object one position forward in the AnnotationsToPlotArray sequence.

Note

Check AnnotationsToPlotArray.bringForward on help.3ds.com/0.1..

Parameters:

index (str) – An Int specifying the index of the Annotation object in the AnnotationsToPlotArray sequence.

bringToFront(index)[source]#

This method brings the Annotation object to the beginning of the AnnotationsToPlotArray sequence.

Note

Check AnnotationsToPlotArray.bringToFront on help.3ds.com/0.1..

Parameters:

index (str) – An Int specifying the index of the Annotation object in the AnnotationsToPlotArray sequence.

moveAfter(index, other)[source]#

This method moves the Annotation object after another object in the same AnnotationsToPlotArray sequence.

Note

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

Parameters:

  • index (str) – An Integer specifying the index of the Annotation object in the AnnotationsToPlotArray sequence.

  • other (str) – An Integer specifying the index of the other Annotation object in the AnnotationsToPlotArray sequence after which this object will be moved.

moveBefore(index, other)[source]#

This method moves the Annotation object before another object in the same AnnotationsToPlotArray sequence.

Note

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

Parameters:

  • index (str) – An Int specifying the index of the Annotation object in the AnnotationsToPlotArray sequence.

  • other (str) – An Int specifying the index of the other Annotation object in the AnnotationsToPlotArray sequence before which this object will be moved.

sendBackward(index)[source]#

This method sends the Annotation object one position backward in the AnnotationsToPlotArray sequence.

Note

Check AnnotationsToPlotArray.sendBackward on help.3ds.com/0.1..

Parameters:

index (str) – An Int specifying the index of the Annotation object in the AnnotationsToPlotArray sequence.

sendToBack(index)[source]#

This method sends the Annotation object to the end of the AnnotationsToPlotArray sequence.

Note

Check AnnotationsToPlotArray.sendToBack on help.3ds.com/0.1..

Parameters:

index (str) – An Int specifying the index of the Annotation object in the AnnotationsToPlotArray sequence.

AnnotationViewport#

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

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.
plotAnnotation(annotation, index=0)[source]#

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.

Arrow#

class Arrow(name, startPoint=(0.0, 0.0), endPoint=(0.0, 0.0), startAnchor=abaqusConstants.BOTTOM_LEFT, endAnchor=abaqusConstants.BOTTOM_LEFT, startHeadStyle=abaqusConstants.NONE, endHeadStyle=abaqusConstants.FILLED_ARROW, startGap=0.0, endGap=0.0, color='White', lineStyle=abaqusConstants.SOLID, lineThickness=abaqusConstants.VERY_THIN)[source]#

The Arrow object stores the visual settings and location of an arrow annotation. The Arrow object is derived from the Annotation object.

Note

This object can be accessed by:

import annotationToolset
mdb.annotations[name]
session.odbs[name].userData.annotations[name]
session.viewports[name].annotationsToPlot[i]

Note

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

Public Data Attributes:

startPoint

A pair of Floats specifying the start point X- and Y-offsets in millimeters from startAnchor.

endPoint

A pair of Floats specifying the end point X- and Y-offsets in millimeters from endAnchor.

startAnchor

A SymbolicConstant or a sequence of Floats specifying a point.

endAnchor

A SymbolicConstant or a sequence of Floats specifying a point.

startHeadStyle

A SymbolicConstant specifying the style of the start head.

endHeadStyle

A SymbolicConstant specifying the style of the end head.

startGap

A Float specifying the distance in millimeters between the arrow start point and the arrow start head.

endGap

A Float specifying the distance in millimeters between the arrow end point and the arrow end head.

color

A String specifying the color of the arrow.

lineStyle

A SymbolicConstant specifying the line style of the arrow.

lineThickness

A SymbolicConstant specifying the line thickness of the arrow.
Inherited from Annotation

name

A String specifying the annotation repository key.

Public Methods:

__init__(name[, startPoint, endPoint, ...])

This method creates an Arrow object.

translateStartPoint([x, y])

This method translates the start point of the Arrow object on the viewport plane.

translateEndPoint([x, y])

This method translates the end point of the Arrow object on the viewport plane.

setValues([startPoint, endPoint, ...])

This method modifies the Arrow object.
Inherited from Annotation

bringToFront()

This method brings the Annotation object to the top of the annotation stack.

sendToBack()

This method sends the Annotation object to the bottom of the annotation stack.

bringForward()

This method brings the Annotation object one position up in the annotation stack.

sendBackward()

This method sends the Annotation object one position down in the annotation stack.

moveBefore(name)

This method moves the Annotation object before another object in the same repository.

moveAfter(name)

This method moves the Annotation object after another object in the same repository.

translate([x, y])

This method translates the Annotation object on the viewport plane.
Inherited from _OptionsBase

get_user_attributes()

Returns a list of the user attributes of the class.

setValues([startPoint, endPoint, ...])

This method modifies the Arrow object.
color: str = 'White'[source]#

A String specifying the color of the arrow. Possible string values are any valid color. The default value is “White”.

endAnchor: Union[SymbolicConstant, float] = BOTTOM_LEFT[source]#

A SymbolicConstant or a sequence of Floats specifying a point. A sequence of two Floats specifies the X- and Y-coordinates as percentages of the viewport width and height. A Sequence of three Floats specifies the X-, Y-, and Z-coordinates of a point in the model coordinate system. A SymbolicConstant indicates a relative position. Possible values are:

  • BOTTOM_LEFT

  • BOTTOM_CENTER

  • BOTTOM_RIGHT

  • CENTER_LEFT

  • CENTER

  • CENTER_RIGHT

  • TOP_LEFT

  • TOP_CENTER

  • TOP_RIGHT

The default value is BOTTOM_LEFT.

endGap: float = 0.0[source]#

A Float specifying the distance in millimeters between the arrow end point and the arrow end head. The default value is 0.0.

endHeadStyle: SymbolicConstant = FILLED_ARROW[source]#

A SymbolicConstant specifying the style of the end head. Possible values are:

  • ARROW

  • FILLED_ARROW

  • HOLLOW_CIRCLE

  • FILLED_CIRCLE

  • HOLLOW_DIAMOND

  • FILLED_DIAMOND

  • HOLLOW_SQUARE

  • FILLED_SQUARE

  • NONE

The default value is FILLED_ARROW.

endPoint: Tuple[float, ...] = (0.0, 0.0)[source]#

A pair of Floats specifying the end point X- and Y-offsets in millimeters from endAnchor. The default value is (0, 0).

lineStyle: SymbolicConstant = SOLID[source]#

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

lineThickness: SymbolicConstant = VERY_THIN[source]#

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

setValues(startPoint=(0.0, 0.0), endPoint=(0.0, 0.0), startAnchor=abaqusConstants.BOTTOM_LEFT, endAnchor=abaqusConstants.BOTTOM_LEFT, startHeadStyle=abaqusConstants.NONE, endHeadStyle=abaqusConstants.FILLED_ARROW, startGap=0.0, endGap=0.0, color='White', lineStyle=abaqusConstants.SOLID, lineThickness=abaqusConstants.VERY_THIN)[source]#

This method modifies the Arrow object.

Note

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

Parameters:

  • startPoint (Tuple[float, ...], default: (0.0, 0.0)) – A pair of Floats specifying the start point X- and Y-offsets in millimeters from startAnchor. The default value is (0, 0).

  • endPoint (Tuple[float, ...], default: (0.0, 0.0)) – A pair of Floats specifying the end point X- and Y-offsets in millimeters from endAnchor. The default value is (0, 0).

  • startAnchor (Union[SymbolicConstant, float], default: BOTTOM_LEFT) –

    A SymbolicConstant or a sequence of Floats specifying a point. A sequence of two Floats specifies the X- and Y-coordinates as percentages of the viewport width and height. A sequence of three Floats specifies the X-, Y-, and Z-coordinates of a point in the model coordinate system. A SymbolicConstant indicates a relative position. Possible values are:

    • BOTTOM_LEFT

    • BOTTOM_CENTER

    • BOTTOM_RIGHT

    • CENTER_LEFT

    • CENTER

    • CENTER_RIGHT

    • TOP_LEFT

    • TOP_CENTER

    • TOP_RIGHT

    The default value is BOTTOM_LEFT.

  • endAnchor (Union[SymbolicConstant, float], default: BOTTOM_LEFT) –

    A SymbolicConstant or a sequence of Floats specifying a point. A sequence of two Floats specifies the X- and Y-coordinates as percentages of the viewport width and height. A Sequence of three Floats specifies the X-, Y-, and Z-coordinates of a point in the model coordinate system. A SymbolicConstant indicates a relative position. Possible values are:

    • BOTTOM_LEFT

    • BOTTOM_CENTER

    • BOTTOM_RIGHT

    • CENTER_LEFT

    • CENTER

    • CENTER_RIGHT

    • TOP_LEFT

    • TOP_CENTER

    • TOP_RIGHT

    The default value is BOTTOM_LEFT.

  • startHeadStyle (SymbolicConstant, default: NONE) –

    A SymbolicConstant specifying the style of the start head. Possible values are:

    • ARROW

    • FILLED_ARROW

    • HOLLOW_CIRCLE

    • FILLED_CIRCLE

    • HOLLOW_DIAMOND

    • FILLED_DIAMOND

    • HOLLOW_SQUARE

    • FILLED_SQUARE

    • NONE

    The default value is NONE.

  • endHeadStyle (SymbolicConstant, default: FILLED_ARROW) –

    A SymbolicConstant specifying the style of the end head. Possible values are:

    • ARROW

    • FILLED_ARROW

    • HOLLOW_CIRCLE

    • FILLED_CIRCLE

    • HOLLOW_DIAMOND

    • FILLED_DIAMOND

    • HOLLOW_SQUARE

    • FILLED_SQUARE

    • NONE

    The default value is FILLED_ARROW.

  • startGap (float, default: 0.0) – A Float specifying the distance in millimeters between the arrow start point and the arrow start head. The default value is 0.0.

  • endGap (float, default: 0.0) – A Float specifying the distance in millimeters between the arrow end point and the arrow end head. The default value is 0.0.

  • color (str, default: 'White') – A String specifying the color of the arrow. Possible string values are any valid color. The default value is “White”.

  • lineStyle (SymbolicConstant, default: SOLID) – A SymbolicConstant specifying the line style of the arrow. Possible values are SOLID, DASHED, DOTTED, and DOT_DASH. The default value is SOLID.

  • lineThickness (SymbolicConstant, default: VERY_THIN) – A SymbolicConstant specifying the line thickness of the arrow. Possible values are VERY_THIN, THIN, MEDIUM, and THICK. The default value is VERY_THIN.

startAnchor: Union[SymbolicConstant, float] = BOTTOM_LEFT[source]#

A SymbolicConstant or a sequence of Floats specifying a point. A sequence of two Floats specifies the X- and Y-coordinates as percentages of the viewport width and height. A sequence of three Floats specifies the X-, Y-, and Z-coordinates of a point in the model coordinate system. A SymbolicConstant indicates a relative position. Possible values are:

  • BOTTOM_LEFT

  • BOTTOM_CENTER

  • BOTTOM_RIGHT

  • CENTER_LEFT

  • CENTER

  • CENTER_RIGHT

  • TOP_LEFT

  • TOP_CENTER

  • TOP_RIGHT

The default value is BOTTOM_LEFT.

startGap: float = 0.0[source]#

A Float specifying the distance in millimeters between the arrow start point and the arrow start head. The default value is 0.0.

startHeadStyle: SymbolicConstant = NONE[source]#

A SymbolicConstant specifying the style of the start head. Possible values are:

  • ARROW

  • FILLED_ARROW

  • HOLLOW_CIRCLE

  • FILLED_CIRCLE

  • HOLLOW_DIAMOND

  • FILLED_DIAMOND

  • HOLLOW_SQUARE

  • FILLED_SQUARE

  • NONE

The default value is NONE.

startPoint: Tuple[float, ...] = (0.0, 0.0)[source]#

A pair of Floats specifying the start point X- and Y-offsets in millimeters from startAnchor. The default value is (0, 0).

translateEndPoint(x=None, y=None)[source]#

This method translates the end point of the Arrow object on the viewport plane.

Note

Check Arrow.translateEndPoint on help.3ds.com/0.1..

Parameters:

  • x (Optional[float], default: None) – A Float specifying the X translation amount in millimeters.

  • y (Optional[float], default: None) – A Float specifying the*Y* translation amount in millimeters.

translateStartPoint(x=None, y=None)[source]#

This method translates the start point of the Arrow object on the viewport plane.

Note

Check Arrow.translateStartPoint on help.3ds.com/0.1..

Parameters:

  • x (Optional[float], default: None) – A Float specifying the X translation amount in millimeters.

  • y (Optional[float], default: None) – A Float specifying the*Y* translation amount in millimeters.

Text#

class Text(name, text='', offset=(0.0, 0.0), anchor=abaqusConstants.BOTTOM_LEFT, referencePoint=abaqusConstants.BOTTOM_LEFT, rotationAngle=0.0, color='White', font='-*-verdana-medium-r-normal--120-*', backgroundStyle=abaqusConstants.TRANSPARENT, backgroundColor='', box=OFF, justification=abaqusConstants.JUSTIFY_LEFT)[source]#

The Text object stores the text settings and location of a text annotation. The Text object is derived from the Annotation object.

Note

This object can be accessed by:

import annotationToolset
mdb.annotations[name]
session.odbs[name].userData.annotations[name]
session.viewports[name].annotationsToPlot[i]

Note

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

anchor: Union[SymbolicConstant, float] = BOTTOM_LEFT[source]#

A SymbolicConstant or a sequence of Floats specifying a point. A sequence of two Floats specifies the X- and Y coordinates as percentages of the viewport width and height. A Sequence of three Floats specifies the X-, Y-, and Z-coordinates of a point in the model coordinate system. A SymbolicConstant specifies a relative position. Possible values are:

  • BOTTOM_LEFT

  • BOTTOM_CENTER

  • BOTTOM_RIGHT

  • CENTER_LEFT

  • CENTER

  • CENTER_RIGHT

  • TOP_LEFT

  • TOP_CENTER

  • TOP_RIGHT

The default value is BOTTOM_LEFT.

backgroundColor: str = ''[source]#

A String specifying the color of the Text object background. Possible string values are any valid color. The default value matches the viewport background.

backgroundStyle: SymbolicConstant = TRANSPARENT[source]#

A SymbolicConstant specifying the Text object background style. Possible values are MATCH, TRANSPARENT, and OTHER. The default value is TRANSPARENT.

box: Union[AbaqusBoolean, bool] = OFF[source]#

A Boolean specifying whether the box around the text is shown. The default value is OFF.

color: str = 'White'[source]#

A String specifying the color of the Text object. Possible string values are any valid color. The default value is “White”.

font: str = '-*-verdana-medium-r-normal--120-*'[source]#

A String specifying the font of the Text object. Possible string values are any valid font specification. The default value is “--verdana-medium-r-normal–120-“.

height: Optional[float] = None[source]#

A Float specifying the height in millimeters of the Text object.

justification: SymbolicConstant = JUSTIFY_LEFT[source]#

A SymbolicConstant specifying the Text object justification for multiline text. Possible values are JUSTIFY_LEFT, JUSTIFY_CENTER, and JUSTIFY_RIGHT. The default value is JUSTIFY_LEFT.

offset: Tuple[float, ...] = (0.0, 0.0)[source]#

A pair of Floats specifying the X- and Y-offsets in millimeters of the Text object from anchor. The default value is (0, 0).

referencePoint: Union[SymbolicConstant, float] = BOTTOM_LEFT[source]#

A SymbolicConstant or a sequence of Floats specifying a point. The sequence of two Floats specifies the X- and Y-coordinates of the reference point of the Text annotation given as percentages of its width and height. The SymbolicConstant indicates a relative position. Possible values are:

  • BOTTOM_LEFT

  • BOTTOM_CENTER

  • BOTTOM_RIGHT

  • CENTER_LEFT

  • CENTER

  • CENTER_RIGHT

  • TOP_LEFT

  • TOP_CENTER

  • TOP_RIGHT

The default value is BOTTOM_LEFT.

rotationAngle: float = 0.0[source]#

A Float specifying the amount of rotation in degrees about referencePoint. The default value is 0.0.

setValues(text='', offset=(0.0, 0.0), anchor=abaqusConstants.BOTTOM_LEFT, referencePoint=abaqusConstants.BOTTOM_LEFT, rotationAngle=0.0, color='White', font='-*-verdana-medium-r-normal--120-*', backgroundStyle=abaqusConstants.TRANSPARENT, backgroundColor='', box=OFF, justification=abaqusConstants.JUSTIFY_LEFT)[source]#

This method modifies the Text object.

Note

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

Parameters:

  • text (str, default: '') – A String specifying the text of the Text object. The default value is an empty string.

  • offset (Tuple[float, ...], default: (0.0, 0.0)) – A pair of Floats specifying the X- and Y-offsets in millimeters of the Text object from anchor. The default value is (0, 0).

  • anchor (Union[SymbolicConstant, float], default: BOTTOM_LEFT) –

    A SymbolicConstant or a sequence of Floats specifying a point. A sequence of two Floats specifies the X- and Y coordinates as percentages of the viewport width and height. A Sequence of three Floats specifies the X-, Y-, and Z-coordinates of a point in the model coordinate system. A SymbolicConstant specifies a relative position. Possible values are:

    • BOTTOM_LEFT

    • BOTTOM_CENTER

    • BOTTOM_RIGHT

    • CENTER_LEFT

    • CENTER

    • CENTER_RIGHT

    • TOP_LEFT

    • TOP_CENTER

    • TOP_RIGHT

    The default value is BOTTOM_LEFT.

  • referencePoint (Union[SymbolicConstant, float], default: BOTTOM_LEFT) –

    A SymbolicConstant or a sequence of Floats specifying a point. The sequence of two Floats specifies the X- and Y-coordinates of the reference point of the Text annotation given as percentages of its width and height. The SymbolicConstant indicates a relative position. Possible values are:

    • BOTTOM_LEFT

    • BOTTOM_CENTER

    • BOTTOM_RIGHT

    • CENTER_LEFT

    • CENTER

    • CENTER_RIGHT

    • TOP_LEFT

    • TOP_CENTER

    • TOP_RIGHT

    The default value is BOTTOM_LEFT.

  • rotationAngle (float, default: 0.0) – A Float specifying the amount of rotation in degrees about referencePoint. The default value is 0.0.

  • color (str, default: 'White') – A String specifying the color of the Text object. Possible string values are any valid color. The default value is “White”.

  • font (str, default: '-*-verdana-medium-r-normal--120-*') – A String specifying the font of the Text object. Possible string values are any valid font specification. The default value is “--verdana-medium-r-normal–120-“.

  • backgroundStyle (SymbolicConstant, default: TRANSPARENT) – A SymbolicConstant specifying the Text object background style. Possible values are MATCH, TRANSPARENT, and OTHER. The default value is TRANSPARENT.

  • backgroundColor (str, default: '') – A String specifying the color of the Text object background. Possible string values are any valid color. The default value matches the viewport background.

  • box (Union[AbaqusBoolean, bool], default: OFF) – A Boolean specifying whether the box around the text is shown. The default value is OFF.

  • justification (SymbolicConstant, default: JUSTIFY_LEFT) – A SymbolicConstant specifying the Text object justification for multiline text. Possible values are JUSTIFY_LEFT, JUSTIFY_CENTER, and JUSTIFY_RIGHT. The default value is JUSTIFY_LEFT.

text: str = ''[source]#

A String specifying the text of the Text object. The default value is an empty string.

width: Optional[float] = None[source]#

A Float specifying the width in millimeters of the Text object.