10592831335

Committed 28 Aug 2024 08:14AM UTC coverage: 74.12% (+0.2%) from 73.933%

Build # 10592831335

Build Type

push

github

Committed by

haiiliin

Commit Message

Add future annotations imports for all files

Run Details

339 of 375 new or added lines in 375 files covered. (90.4%)

34 existing lines in 34 files now uncovered.

24507 of 33064 relevant lines covered (74.12%)

0.74 hits per line

Source File
Press 'n' to go to next uncovered line, 'b' for previous

0.0

/src/abaqus/PlotOptions/OptionArg.py

from __future__ import annotations

from typing_extensions import Literal

from abqpy.decorators import abaqus_class_doc, abaqus_method_doc

from ..UtilityAndView.abaqusConstants import (
    FEATURE,
    OFF,
    ON,
    SOLID,
    VERY_THIN,
    WIREFRAME,
    Boolean,
    SymbolicConstant,
)
from ..UtilityAndView.abaqusConstants import abaqusConstants as C


@abaqus_class_doc
class OptionArg:
    """The OptionArg object is used to store values and attributes as a temporary object to be associated with a
    viewCutOptions object. The OptionArg object has only a constructor command.

    .. note::
        This object can be accessed by::

            import visualization
            session.defaultOdbDisplay.viewCutOptions.aboveOptions
            session.defaultOdbDisplay.viewCutOptions.belowOptions
            session.defaultOdbDisplay.viewCutOptions.onOptions
            session.viewports[name].layers[name].odbDisplay.viewCutOptions.aboveOptions
            session.viewports[name].layers[name].odbDisplay.viewCutOptions.belowOptions
            session.viewports[name].layers[name].odbDisplay.viewCutOptions.onOptions
            session.viewports[name].odbDisplay.viewCutOptions.aboveOptions
            session.viewports[name].odbDisplay.viewCutOptions.belowOptions
            session.viewports[name].odbDisplay.viewCutOptions.onOptions
    """

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

    #: A SymbolicConstant specifying which edges to plot. Possible values are ALL, EXTERIOR,
    #: FEATURE, FREE, and NONE. The default value is FEATURE.NONE can be used only when
    #: **renderStyle** = SHADED.
    visibleEdges: SymbolicConstant = FEATURE

    #: A String specifying the color to be used to plot the edges of the undeformed plot when
    #: **renderStyle** = WIREFRAME or HIDDEN. The default value is "Green".
    edgeColorWireHide: str = ""

    #: A String specifying the color to be used to plot the edges of the undeformed plot when
    #: **renderStyle** = FILLED or SHADED. The default value is "Black".
    edgeColorFillShade: str = ""

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

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

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

    #: A String specifying the color to be used to fill elements when **renderStyle** = FILLED or
    #: SHADED. The default value is "Green".
    fillColor: str = ""

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

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

    @abaqus_method_doc
    def __init__(
        self,
        renderStyle: Literal[C.SHADED, C.FILLED, C.WIREFRAME, C.HIDDEN] = WIREFRAME,
        visibleEdges: Literal[C.FEATURE, C.EXTERIOR, C.ALL, C.FREE, C.NONE, C.SHADED] = FEATURE,
        edgeColorWireHide: str = "",
        edgeColorFillShade: str = "",
        edgeLineStyle: Literal[C.DASHED, C.SOLID, C.DOT_DASH, C.DOTTED] = SOLID,
        edgeLineThickness: Literal[C.THIN, C.THICK, C.VERY_THIN, C.MEDIUM] = VERY_THIN,
        colorCodeOverride: Boolean = ON,
        fillColor: str = "",
        translucency: Boolean = OFF,
        translucencyFactor: float = 0,
    ):
        """This method creates an OptionArg object.

        .. note::
            This function can be accessed by::

                visualization.OptionArg

        Parameters
        ----------
        renderStyle
            A SymbolicConstant specifying the render style of the plot. Possible values are
            WIREFRAME, FILLED, HIDDEN, and SHADED. The default value is WIREFRAME.
        visibleEdges
            A SymbolicConstant specifying which edges to plot. Possible values are ALL, EXTERIOR,
            FEATURE, FREE, and NONE. The default value is FEATURE.NONE can be used only when
            **renderStyle** = SHADED.
        edgeColorWireHide
            A String specifying the color to be used to plot the edges of the undeformed plot when
            **renderStyle** = WIREFRAME or HIDDEN. The default value is "Green".
        edgeColorFillShade
            A String specifying the color to be used to plot the edges of the undeformed plot when
            **renderStyle** = FILLED or SHADED. The default value is "Black".
        edgeLineStyle
            A SymbolicConstant specifying the edge line style. Possible values are SOLID, DASHED,
            DOTTED, and DOT_DASH. The default value is SOLID.
        edgeLineThickness
            A SymbolicConstant specifying the edge line thickness. Possible values are VERY_THIN,
            THIN, MEDIUM, and THICK. The default value is VERY_THIN.
        colorCodeOverride
            A Boolean specifying whether to allow color coded items in the output database to
            override the edge and fill color settings. The default value is ON.
        fillColor
            A String specifying the color to be used to fill elements when **renderStyle** = FILLED or
            SHADED. The default value is "Green".
        translucency
            A Boolean specifying whether to set translucency. The default value is OFF.
        translucencyFactor
            A Float specifying the translucency factor when **translucency** = ON. Possible values are
            0.0 ≤ **translucencyFactor** ≤ 1.0. The default value is 0.3.

        Returns
        -------
        OptionArg
            An OptionArg object.

        Raises
        ------
        RangeError
        """
        self.renderStyle = renderStyle
        self.visibleEdges = visibleEdges
        self.edgeColorWireHide = edgeColorWireHide
        self.edgeColorFillShade = edgeColorFillShade
        self.edgeLineStyle = edgeLineStyle
        self.edgeLineThickness = edgeLineThickness
        self.colorCodeOverride = colorCodeOverride
        self.fillColor = fillColor
        self.translucency = translucency
        self.translucencyFactor = translucencyFactor

NEW 1	from __future__ import annotations	×
2
UNCOV 3	from typing_extensions import Literal	×
4
5	from abqpy.decorators import abaqus_class_doc, abaqus_method_doc	×
6
7	from ..UtilityAndView.abaqusConstants import (	×
8	FEATURE,
9	OFF,
10	ON,
11	SOLID,
12	VERY_THIN,
13	WIREFRAME,
14	Boolean,
15	SymbolicConstant,
16	)
17	from ..UtilityAndView.abaqusConstants import abaqusConstants as C	×
18
19
20	@abaqus_class_doc	×
21	class OptionArg:	×
22	"""The OptionArg object is used to store values and attributes as a temporary object to be associated with a
23	viewCutOptions object. The OptionArg object has only a constructor command.
24
25	.. note::
26	This object can be accessed by::
27
28	import visualization
29	session.defaultOdbDisplay.viewCutOptions.aboveOptions
30	session.defaultOdbDisplay.viewCutOptions.belowOptions
31	session.defaultOdbDisplay.viewCutOptions.onOptions
32	session.viewports[name].layers[name].odbDisplay.viewCutOptions.aboveOptions
33	session.viewports[name].layers[name].odbDisplay.viewCutOptions.belowOptions
34	session.viewports[name].layers[name].odbDisplay.viewCutOptions.onOptions
35	session.viewports[name].odbDisplay.viewCutOptions.aboveOptions
36	session.viewports[name].odbDisplay.viewCutOptions.belowOptions
37	session.viewports[name].odbDisplay.viewCutOptions.onOptions
38	"""
39
40	#: A SymbolicConstant specifying the render style of the plot. Possible values are
41	#: WIREFRAME, FILLED, HIDDEN, and SHADED. The default value is WIREFRAME.
42	renderStyle: SymbolicConstant = WIREFRAME	×
43
44	#: A SymbolicConstant specifying which edges to plot. Possible values are ALL, EXTERIOR,
45	#: FEATURE, FREE, and NONE. The default value is FEATURE.NONE can be used only when
46	#: renderStyle = SHADED.
47	visibleEdges: SymbolicConstant = FEATURE	×
48
49	#: A String specifying the color to be used to plot the edges of the undeformed plot when
50	#: renderStyle = WIREFRAME or HIDDEN. The default value is "Green".
51	edgeColorWireHide: str = ""	×
52
53	#: A String specifying the color to be used to plot the edges of the undeformed plot when
54	#: renderStyle = FILLED or SHADED. The default value is "Black".
55	edgeColorFillShade: str = ""	×
56
57	#: A SymbolicConstant specifying the edge line style. Possible values are SOLID, DASHED,
58	#: DOTTED, and DOT_DASH. The default value is SOLID.
59	edgeLineStyle: SymbolicConstant = SOLID	×
60
61	#: A SymbolicConstant specifying the edge line thickness. Possible values are VERY_THIN,
62	#: THIN, MEDIUM, and THICK. The default value is VERY_THIN.
63	edgeLineThickness: SymbolicConstant = VERY_THIN	×
64
65	#: A Boolean specifying whether to allow color coded items in the output database to
66	#: override the edge and fill color settings. The default value is ON.
67	colorCodeOverride: Boolean = ON	×
68
69	#: A String specifying the color to be used to fill elements when renderStyle = FILLED or
70	#: SHADED. The default value is "Green".
71	fillColor: str = ""	×
72
73	#: A Boolean specifying whether to set translucency. The default value is OFF.
74	translucency: Boolean = OFF	×
75
76	#: A Float specifying the translucency factor when translucency = ON. Possible values are
77	#: 0.0 ≤ translucencyFactor ≤ 1.0. The default value is 0.3.
78	translucencyFactor: float = 0	×
79
80	@abaqus_method_doc	×
81	def __init__(	×
82	self,
83	renderStyle: Literal[C.SHADED, C.FILLED, C.WIREFRAME, C.HIDDEN] = WIREFRAME,
84	visibleEdges: Literal[C.FEATURE, C.EXTERIOR, C.ALL, C.FREE, C.NONE, C.SHADED] = FEATURE,
85	edgeColorWireHide: str = "",
86	edgeColorFillShade: str = "",
87	edgeLineStyle: Literal[C.DASHED, C.SOLID, C.DOT_DASH, C.DOTTED] = SOLID,
88	edgeLineThickness: Literal[C.THIN, C.THICK, C.VERY_THIN, C.MEDIUM] = VERY_THIN,
89	colorCodeOverride: Boolean = ON,
90	fillColor: str = "",
91	translucency: Boolean = OFF,
92	translucencyFactor: float = 0,
93	):
94	"""This method creates an OptionArg object.
95
96	.. note::
97	This function can be accessed by::
98
99	visualization.OptionArg
100
101	Parameters
102	----------
103	renderStyle
104	A SymbolicConstant specifying the render style of the plot. Possible values are
105	WIREFRAME, FILLED, HIDDEN, and SHADED. The default value is WIREFRAME.
106	visibleEdges
107	A SymbolicConstant specifying which edges to plot. Possible values are ALL, EXTERIOR,
108	FEATURE, FREE, and NONE. The default value is FEATURE.NONE can be used only when
109	renderStyle = SHADED.
110	edgeColorWireHide
111	A String specifying the color to be used to plot the edges of the undeformed plot when
112	renderStyle = WIREFRAME or HIDDEN. The default value is "Green".
113	edgeColorFillShade
114	A String specifying the color to be used to plot the edges of the undeformed plot when
115	renderStyle = FILLED or SHADED. The default value is "Black".
116	edgeLineStyle
117	A SymbolicConstant specifying the edge line style. Possible values are SOLID, DASHED,
118	DOTTED, and DOT_DASH. The default value is SOLID.
119	edgeLineThickness
120	A SymbolicConstant specifying the edge line thickness. Possible values are VERY_THIN,
121	THIN, MEDIUM, and THICK. The default value is VERY_THIN.
122	colorCodeOverride
123	A Boolean specifying whether to allow color coded items in the output database to
124	override the edge and fill color settings. The default value is ON.
125	fillColor
126	A String specifying the color to be used to fill elements when renderStyle = FILLED or
127	SHADED. The default value is "Green".
128	translucency
129	A Boolean specifying whether to set translucency. The default value is OFF.
130	translucencyFactor
131	A Float specifying the translucency factor when translucency = ON. Possible values are
132	0.0 ≤ translucencyFactor ≤ 1.0. The default value is 0.3.
133
134	Returns
135	-------
136	OptionArg
137	An OptionArg object.
138
139	Raises
140	------
141	RangeError
142	"""
143	self.renderStyle = renderStyle	×
144	self.visibleEdges = visibleEdges	×
145	self.edgeColorWireHide = edgeColorWireHide	×
146	self.edgeColorFillShade = edgeColorFillShade	×
147	self.edgeLineStyle = edgeLineStyle	×
148	self.edgeLineThickness = edgeLineThickness	×
149	self.colorCodeOverride = colorCodeOverride	×
150	self.fillColor = fillColor	×
151	self.translucency = translucency	×
152	self.translucencyFactor = translucencyFactor	×

haiiliin / abqpy / 10592831335

Source File Press 'n' to go to next uncovered line, 'b' for previous

Source File
Press 'n' to go to next uncovered line, 'b' for previous