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=BOTTOM_LEFT,
endAnchor=BOTTOM_LEFT,
startHeadStyle=NONE,
endHeadStyle=FILLED_ARROW,
startGap=0.0,
endGap=0.0,
color='White',
lineStyle=SOLID,
lineThickness=VERY_THIN,
)[源代码]

This method creates an Arrow object.

备注

This function can be accessed by:

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

备注

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

参数:
name

A String specifying the annotation repository key.

startPoint=(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=(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=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=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=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=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=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=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='White'

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

lineStyle=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=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.

返回:

An Arrow object.

返回类型:

Arrow

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

This method creates a Text object.

备注

This function can be accessed by:

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

备注

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

参数:
name

A String specifying the annotation repository key.

text=''

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

offset=()

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=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=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=0

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

color='White'

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

font='-*-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=TRANSPARENT

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

backgroundColor=''

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=0

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

justification=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.

返回:

A Text object.

返回类型:

Text

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

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

备注

This function can be accessed by:

session.odbs[name].userData.XYData

备注

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

参数:
name

A String specifying the repository key.

data

A sequence of pairs of Floats specifying the X - Y data pairs.

sourceDescription=''

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=''

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=''

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

legendLabel=''

A String specifying the label to be used in the legend. The default value is the name of the XYData object.

xValuesLabel=''

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=''

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=None

A QuantityType object specifying the QuantityType object associated to the X -axis1- values.

axis2QuantityType=None

A QuantityType object specifying the QuantityType object associated to the Y -axis2- values.

返回:

An XYData object.

返回类型:

XYData

Other Classes

class AnimationUserData[源代码]

基类：UserDataBase

Member Details:

Arrow(
name,
startPoint=(0.0, 0.0),
endPoint=(0.0, 0.0),
startAnchor=BOTTOM_LEFT,
endAnchor=BOTTOM_LEFT,
startHeadStyle=NONE,
endHeadStyle=FILLED_ARROW,
startGap=0.0,
endGap=0.0,
color='White',
lineStyle=SOLID,
lineThickness=VERY_THIN,
)[源代码]

This method creates an Arrow object.

备注

This function can be accessed by:

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

备注

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

参数:
name

A String specifying the annotation repository key.

startPoint=(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=(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=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=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=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=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=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=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='White'

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

lineStyle=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=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.

返回:

An Arrow object.

返回类型:

Arrow

Text(
name,
text='',
offset=(),
anchor=BOTTOM_LEFT,
referencePoint=BOTTOM_LEFT,
rotationAngle=0,
color='White',
font='-*-verdana-medium-r-normal--120-*',
backgroundStyle=TRANSPARENT,
backgroundColor='',
box=0,
justification=JUSTIFY_LEFT,
)[源代码]

This method creates a Text object.

备注

This function can be accessed by:

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

备注

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

参数:
name

A String specifying the annotation repository key.

text=''

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

offset=()

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=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=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=0

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

color='White'

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

font='-*-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=TRANSPARENT

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

backgroundColor=''

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=0

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

justification=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.

返回:

A Text object.

返回类型:

Text

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

基类：Annotation, _OptionsBase

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

备注

This object can be accessed by:

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

备注

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

Member Details:

color : --is-rst--:py:class:`str` = 'White'[源代码]

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

endAnchor : --is-rst--:py:data:`~typing.Union`\ \[:py:class:`~abaqus.UtilityAndView.SymbolicConstant.SymbolicConstant`, :py:class:`float`] = '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.

endGap : --is-rst--:py:class:`float` = 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.

endHeadStyle : --is-rst--:py:class:`~abaqus.UtilityAndView.SymbolicConstant.SymbolicConstant` = '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.

endPoint : --is-rst--:py:class:`~typing.Sequence`\ \[:py:class:`float`] = (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).

lineStyle : --is-rst--:py:class:`~abaqus.UtilityAndView.SymbolicConstant.SymbolicConstant` = '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 : --is-rst--:py:class:`~abaqus.UtilityAndView.SymbolicConstant.SymbolicConstant` = '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.

setValues(
startPoint=(0.0, 0.0),
endPoint=(0.0, 0.0),
startAnchor=BOTTOM_LEFT,
endAnchor=BOTTOM_LEFT,
startHeadStyle=NONE,
endHeadStyle=FILLED_ARROW,
startGap=0.0,
endGap=0.0,
color='White',
lineStyle=SOLID,
lineThickness=VERY_THIN,
)[源代码]

This method modifies the Arrow object.

备注

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

参数:
startPoint=(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=(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=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=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=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=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=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=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='White'

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

lineStyle=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=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 : --is-rst--:py:data:`~typing.Union`\ \[:py:class:`~abaqus.UtilityAndView.SymbolicConstant.SymbolicConstant`, :py:class:`float`] = '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.

startGap : --is-rst--:py:class:`float` = 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.

startHeadStyle : --is-rst--:py:class:`~abaqus.UtilityAndView.SymbolicConstant.SymbolicConstant` = '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.

startPoint : --is-rst--:py:class:`~typing.Sequence`\ \[:py:class:`float`] = (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).

translateEndPoint(x=None, y=None)[源代码]

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

备注

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

参数:
x=None

A Float specifying the X translation amount in millimeters.

y=None

A Float specifying the*Y* translation amount in millimeters.

translateStartPoint(x=None, y=None)[源代码]

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

备注

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

参数:
x=None

A Float specifying the X translation amount in millimeters.

y=None

A Float specifying the*Y* translation amount in millimeters.

class Text(
name,
text='',
offset=(0.0, 0.0),
anchor=BOTTOM_LEFT,
referencePoint=BOTTOM_LEFT,
rotationAngle=0.0,
color='White',
font='-*-verdana-medium-r-normal--120-*',
backgroundStyle=TRANSPARENT,
backgroundColor='',
box=0,
justification=JUSTIFY_LEFT,
)[源代码]

基类：Annotation, _OptionsBase

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

备注

This object can be accessed by:

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

备注

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

Member Details:

anchor : --is-rst--:py:data:`~typing.Union`\ \[:py:class:`~abaqus.UtilityAndView.SymbolicConstant.SymbolicConstant`, :py:class:`float`] = '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.

backgroundColor : --is-rst--:py:class:`str` = ''[源代码]

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 : --is-rst--:py:class:`~abaqus.UtilityAndView.SymbolicConstant.SymbolicConstant` = 'TRANSPARENT'[源代码]

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

box : --is-rst--:py:data:`~typing.Union`\ \[:py:class:`~abaqus.UtilityAndView.AbaqusBoolean.AbaqusBoolean`, :py:class:`bool`] = 0[源代码]

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

color : --is-rst--:py:class:`str` = 'White'[源代码]

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

font : --is-rst--:py:class:`str` = '-*-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-“.

height : --is-rst--:py:class:`float` | :py:obj:`None` = None[源代码]

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

justification : --is-rst--:py:class:`~abaqus.UtilityAndView.SymbolicConstant.SymbolicConstant` = '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.

offset : --is-rst--:py:class:`~typing.Sequence`\ \[:py:class:`float`] = (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).

referencePoint : --is-rst--:py:data:`~typing.Union`\ \[:py:class:`~abaqus.UtilityAndView.SymbolicConstant.SymbolicConstant`, :py:class:`float`] = '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 : --is-rst--:py:class:`float` = 0.0[源代码]

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=BOTTOM_LEFT,
referencePoint=BOTTOM_LEFT,
rotationAngle=0.0,
color='White',
font='-*-verdana-medium-r-normal--120-*',
backgroundStyle=TRANSPARENT,
backgroundColor='',
box=0,
justification=JUSTIFY_LEFT,
)[源代码]

This method modifies the Text object.

备注

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

参数:
text=''

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

offset=(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=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=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=0.0

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

color='White'

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

font='-*-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=TRANSPARENT

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

backgroundColor=''

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=0

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

justification=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 : --is-rst--:py:class:`str` = ''[源代码]

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

width : --is-rst--:py:class:`float` | :py:obj:`None` = None[源代码]

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

class Annotation[源代码]

基类：object

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.

备注

This object can be accessed by:

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

备注

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

Member Details:

bringForward()[源代码]

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

bringToFront()[源代码]

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

moveAfter(name)[源代码]

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

备注

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

参数:
name

A String specifying the name of the other Annotation object.

moveBefore(name)[源代码]

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

备注

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

参数:
name

A String specifying the name of the other Annotation object.

name : --is-rst--:py:class:`str` = ''[源代码]

A String specifying the annotation repository key.

sendBackward()[源代码]

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

sendToBack()[源代码]

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

translate(x=None, y=None)[源代码]

This method translates the Annotation object on the viewport plane.

备注

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

参数:
x=None

A Float specifying the X translation amount in millimeters.

y=None

A Float specifying the Y translation amount in millimeters.

class AnnotationViewport(
name,
origin=(0.0, 0.0),
width=120.0,
height=80.0,
border=1,
titleBar=1,
titleStyle=SYSTEM,
customTitleString='',
)[源代码]

基类：ViewportBase

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

备注

This object can be accessed by:

import annotationToolset

备注

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

Member Details:

plotAnnotation(annotation, index=0)[源代码]

This method plots an Annotation object in aViewport.

备注

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

参数:
annotation

An Annotation object to plot.

index=0

An Int specifying the index of the Annotation object in the sequence of annotations to plot. The default value is zero.

class AnnotationsToPlotArray[源代码]

基类：List[Annotation]

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.

备注

This object can be accessed by:

import annotationToolset
session.viewports[name].annotationsToPlot

备注

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

Member Details:

bringForward(index)[源代码]

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

备注

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

参数:
index

An Int specifying the index of the Annotation object in the AnnotationsToPlotArray sequence.

bringToFront(index)[源代码]

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

备注

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

参数:
index

An Int specifying the index of the Annotation object in the AnnotationsToPlotArray sequence.

moveAfter(index, other)[源代码]

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

备注

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

参数:
index

An Integer specifying the index of the Annotation object in the AnnotationsToPlotArray sequence.

other

An Integer specifying the index of the other Annotation object in the AnnotationsToPlotArray sequence after which this object will be moved.

moveBefore(index, other)[源代码]

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

备注

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

参数:
index

An Int specifying the index of the Annotation object in the AnnotationsToPlotArray sequence.

other

An Int specifying the index of the other Annotation object in the AnnotationsToPlotArray sequence before which this object will be moved.

sendBackward(index)[源代码]

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

备注

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

参数:
index

An Int specifying the index of the Annotation object in the AnnotationsToPlotArray sequence.

sendToBack(index)[源代码]

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

备注

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

参数:
index

An Int specifying the index of the Annotation object in the AnnotationsToPlotArray sequence.