Display Group

Display group commands are used to select a subset of the entities displayed in the viewport.

Create display groups

class DisplayGroupSession[source]

Bases: SessionBase

Public Data Attributes:

Inherited from SessionBase

`attachedToGui`	A Boolean specifying whether an Abaqus interactive session is running.
`replayInProgress`	A Boolean specifying whether Abaqus is executing a replay file.
`kernelMemoryFootprint`	A Float specifying the memory usage value for the Abaqus/CAE kernel process in megabytes.
`kernelMemoryMaxFootprint`	A Float specifying the maximum value for the memory usage for the Abaqus/CAE kernel process in megabytes.
`kernelMemoryLimit`	A Float specifying the limit for the memory use for the Abaqus/CAE kernel process in megabytes.
`colors`	A repository of Color objects.
`journalOptions`	A JournalOptions object specifying how to record selection of geometry in the journal and replay files.
`memoryReductionOptions`	A MemoryReductionOptions object specifying options for running in reduced memory mode.
`nodeQuery`	A NodeQuery object specifying nodes and their coordinates in a path.
`sketcherOptions`	A ConstrainedSketcherOptions object specifying common options for all sketches.
`viewerOptions`	A ViewerOptions object.
`animationOptions`	An AnimationOptions object.
`aviOptions`	An AVIOptions object.
`imageAnimationOptions`	An ImageAnimationOptions object.
`imageAnimation`	An ImageAnimation object.
`quickTimeOptions`	A QuickTimeOptions object.
`viewports`	A repository of Viewport objects.
`customData`	A RepositorySupport object.
`defaultFieldReportOptions`	A FieldReportOptions object.
`defaultFreeBodyReportOptions`	A FreeBodyReportOptions object.
`fieldReportOptions`	A FieldReportOptions object.
`freeBodyReportOptions`	A FreeBodyReportOptions object.
`odbs`	A repository of Odb objects.
`scratchOdbs`	A repository of ScratchOdb objects.
`defaultOdbDisplay`	A DefaultOdbDisplay object.
`defaultPlot`	A DefaultPlot object.
`defaultChartOptions`	A DefaultChartOptions object.
`odbData`	A repository of OdbData objects.
`mdbData`	A repository of MdbData objects.
`paths`	A repository of Path objects.
`freeBodies`	A repository of FreeBody objects.
`streams`	A repository of Stream objects.
`spectrums`	A repository of Spectrum objects.
`currentProbeValues`	A CurrentProbeValues object.
`defaultProbeOptions`	A ProbeOptions object.
`probeOptions`	A ProbeOptions object.
`probeReport`	A ProbeReport object.
`defaultProbeReport`	A ProbeReport object.
`selectedProbeValues`	A SelectedProbeValues object.
`printOptions`	A PrintOptions object.
`epsOptions`	An EpsOptions object.
`pageSetupOptions`	A PageSetupOptions object.
`pngOptions`	A PngOptions object.
`psOptions`	A PsOptions object.
`svgOptions`	A SvgOptions object.
`tiffOptions`	A TiffOptions object.
`autoColors`	An AutoColors object specifying the color palette to be used for color coding.
`xyColors`	An AutoColors object specifying the color palette to be used forXYCurve objects.
`xyDataObjects`	A repository of XYData objects.
`curves`	A repository of XYCurve objects.
`xyPlots`	A repository of XYPlot objects.
`charts`	A repository of Chart objects.
`defaultXYReportOptions`	An XYReportOptions object.
`xyReportOptions`	An XYReportOptions object.
`views`	A repository of View objects.
`networkDatabaseConnectors`	A repository of NetworkDatabaseConnector objects.
`displayGroups`	A repository of DisplayGroup objects.
`graphicsInfo`	A GraphicsInfo object.
`defaultGraphicsOptions`	A GraphicsOptions object.
`graphicsOptions`	A GraphicsOptions object.
`defaultViewportAnnotationOptions`	A ViewportAnnotationOptions object.
`queues`	A repository of Queue objects.
`currentViewportName`	A String specifying the name of the current viewport.
`sessionState`	A Dictionary object specifying the viewports and their associated models.
`images`	A repository of Image objects.
`movies`	A repository of Movie objects.
`defaultLightOptions`	A LightOptions object.
`drawingArea`	A DrawingArea object.
`defaultMesherOptions`	A MesherOptions object specifying how to control default settings in the Mesh module.
`drawings`	A repository of Drawing objects.

Public Methods:

DisplayGroup(name, leaf)

This method creates a DisplayGroup object.

Inherited from SessionBase

`setValues`([kernelMemoryLimit])	This method modifies the Session object.
`enableCADConnection`(CADName[, portNum])	This method enables the Abaqus/CAE listening port for the specified CAD system.
`isCADConnectionEnabled`()	This method checks the status of CAD Connection.
`disableCADConnection`(CADName)	This method disables an associative import CAD connection that was enabled.
`enableParameterUpdate`(CADName, CADVersion[, ...])	This method enables parameter updates for ProE and NX by establishing a connection with the listening port previously setup by the CAD application.
`setCADPortNumber`(CADName, Port)	This method enables parameter updates for CATIA V5 and CATIA V6 by establishing a connection with the listening port previously setup by the CAD application.
`updateCADParameters`(modelName, CADName, ...)	This method updates the parameters for the specified model using the specified parameter file.
`disableParameterUpdate`(CADName)	This method disables an associative CAD connection using parameters.
`printToFile`(fileName[, format, ...])	This method prints canvas objects to a file using the attributes stored in the PrintOptions object and the appropriate format options object.
`printToPrinter`([printCommand, numCopies, ...])	This method prints canvas objects to a Windows printer or to a PostScript printer.
`saveOptions`(directory)	This method saves your customized display settings.
`writeVrmlFile`(fileName[, format, canvasObjects])	This method exports the current viewport objects to a file.
`write3DXMLFile`(fileName[, format, canvasObjects])	This method exports the current viewport objects to a file.
`writeOBJFile`(fileName[, canvasObjects])	This method exports the current viewport objects to a file.
`openOdb`(name[, path, readOnly])	This method opens an existing output database (.odb) file and creates a new Odb object. This method is accessed only via the session object inside Abaqus/CAE and adds the new Odb object to the session.odbs repository. This method allows you to open multiple output databases at the same time and to use the repository key to specify a particular output database. For example::.

Member Details:

DisplayGroup(name, leaf)[source]

This method creates a DisplayGroup object.

Note

This function can be accessed by:

session.DisplayGroup

Note

Check DisplayGroup on help.3ds.com/2023.

Parameters:

name (str) – A String specifying the repository key.
leaf (Leaf) – A Leaf object specifying the items in the display group.

Returns:

A DisplayGroup object.

Return type:

DisplayGroup

Other Classes

class DisplayGroup(name, leaf)[source]

Bases: object

DisplayGroup objects are used to select a subset of the entities displayed in the viewport.

Note

This object can be accessed by:

session.displayGroups[name]
import assembly
session.viewports[name].assemblyDisplay.displayGroup
session.viewports[name].layers[name].assemblyDisplay.displayGroup
import visualization
session.viewports[name].layers[name].odbDisplay.displayGroup
import part
session.viewports[name].layers[name].partDisplay.displayGroup
session.viewports[name].odbDisplay.displayGroup
session.viewports[name].partDisplay.displayGroup

Note

Check DisplayGroup on help.3ds.com/2023.

This method creates a DisplayGroup object.

Note

This function can be accessed by:

session.DisplayGroup

Parameters:

name (str) – A String specifying the repository key.
leaf (Leaf) – A Leaf object specifying the items in the display group.

Returns:

A DisplayGroup object.

Return type:

DisplayGroup

Member Details:

add(leaf)[source]

This method adds the specified items to the display group.

Note

Check DisplayGroup.add on help.3ds.com/2023.

Parameters:: leaf (Leaf) – A Leaf object specifying the items to add to the display group.

canRedo: Union[AbaqusBoolean, bool] = 0[source]: A Boolean specifying whether Redo is possible or not.

canUndo: Union[AbaqusBoolean, bool] = 0[source]: A Boolean specifying whether Undo is possible or not.

either(leaf)[source]

This method redefines the display group to be only those items that are not shared by the leaf argument and by the display group.

Note

Check DisplayGroup.either on help.3ds.com/2023.

Parameters:: leaf (Leaf) – A Leaf object specifying the items to be excluded from the display group.

intersect(leaf)[source]

This method redefines the display group to be only those items that are shared by the leaf argument and the display group.

Note

Check DisplayGroup.intersect on help.3ds.com/2023.

Parameters:: leaf (Leaf) – A Leaf object specifying the items to be included in the display group.

modelName: str = ''[source]: A String specifying the name of the model to which the display group belongs when the module is part- or assembly-based.

module: SymbolicConstant[source]: A SymbolicConstant specifying the module in which the display group has been created. The possible values are PART, ASSEMBLY, PART_ASSEMBLY, ODB, and ALL.

name: str = ''[source]: A String specifying the repository key.

partName: str = ''[source]: A String specifying the name of the part to which the display group belongs when the module is part-based.

redoLast()[source]: This method redoes the last undone operation on the display group.

remove(leaf)[source]

This method removes the specified items from the display group.

Note

Check DisplayGroup.remove on help.3ds.com/2023.

Parameters:: leaf (Leaf) – A Leaf object specifying the items to remove from the display group.

replace(leaf)[source]

This method replaces the contents of the display group with the specified items.

Note

Check DisplayGroup.replace on help.3ds.com/2023.

Parameters:: leaf (Leaf) – A Leaf object specifying the items with which to replace the current display group contents.

undoLast()[source]: This method undoes the last operation performed on the display group.

class Leaf(leafType)[source]

Bases: object

Leaf objects are used to specify the items in a display group. Leaf objects are constructed as temporary objects, which are then used as arguments to DisplayGroup commands. Leaf objects have similarities to Set objects; however, Leaf objects are evaluated when the DisplayGroup expression is evaluated, and they can have SymbolicConstant values (which are also evaluated when the DisplayGroup expression is evaluated).

Note

This object can be accessed by:

import displayGroupMdbToolset
import displayGroupOdbToolset

Note

Check Leaf on help.3ds.com/2023.

This method creates a Leaf object.

Note

This function can be accessed by:

Leaf

Parameters:: leafType (Literal[ALL_ELEMENTS, ALL_SURFACES, EMPTY_LEAF, DEFAULT_MODEL, ALL_NODES]) – A SymbolicConstant specifying the leaf type. Possible values are EMPTY_LEAF, DEFAULT_MODEL, ALL_ELEMENTS, ALL_NODES, and ALL_SURFACES.
Returns:: A Leaf object.
Return type:: Leaf

Member Details:

leafType: SymbolicConstant[source]: A SymbolicConstant specifying the leaf type. Possible values are EMPTY_LEAF, DEFAULT_MODEL, ALL_ELEMENTS, ALL_NODES, and ALL_SURFACES.

class DisplayGroupInstance[source]

Bases: object

A DisplayGroupInstance object stores the IDs of the entities displayed in a viewport. The DisplayGroupInstance object has no constructor. When you set a display group to be plotted in a viewport, Abaqus/CAE creates a DisplayGroupInstance object for each display group and places it in the DisplayGroupInstanceRepository object.

Note

This object can be accessed by:

import assembly
session.viewports[name].assemblyDisplay.displayGroupInstances[name]
session.viewports[name].layers[name].assemblyDisplay.displayGroupInstances[name]
import visualization
session.viewports[name].layers[name].odbDisplay.displayGroupInstances[name]
import part
session.viewports[name].layers[name].partDisplay.displayGroupInstances[name]
session.viewports[name].odbDisplay.displayGroupInstances[name]
session.viewports[name].partDisplay.displayGroupInstances[name]

Note

Check DisplayGroupInstance on help.3ds.com/2023.

Member Details:

elements()[source]

This method returns the list of elements present in the DisplayGroupInstance object. The elements method returns a Dictionary object that uses part instance names for the keys. The value of the items in the Dictionary object is a List of user element labels that belong to the part instance and are contained in the DisplayGroupInstance object. This method is available only for DisplayGroupInstance objects that are members of the DisplayGroupInstance repository member of the OdbDisplay object.

Returns:: A Dictionary object.
Return type:: dict

lockOptions: Union[AbaqusBoolean, bool] = 0[source]: A Boolean specifying whether the display options stored on the DisplayGroupInstance object should be synchronized with changes to the viewport display options. This member is available only for DisplayGroupInstance objects that are members of the DisplayGroupInstance repository member of the OdbDisplay object. The default value is OFF.

name: str = ''[source]: A String specifying the repository key.

nodes()[source]

This method is used to obtain the list of nodes present in the DisplayGroupInstance object. It returns a Dictionary object keyed by part instance names, the value of which is a list of user node labels belonging to the part instance and contained in the DisplayGroupInstance object. This method is available only for DisplayGroupInstance objects that are members of the DisplayGroupInstance repository member of OdbDisplay object.

Returns:: A Dictionary object.
Return type:: dict

odbDisplayOptions: OdbDisplayOptions = <abaqus.PlotOptions.OdbDisplayOptions.OdbDisplayOptions object>[source]: An OdbDisplayOptions object specifying this member is available only for DisplayGroupInstance objects that are members of the DisplayGroupInstance repository member of the OdbDisplay object.

setValues(lockOptions=0)[source]

This method modifies the DisplayGroupInstance object. The setValues method is available only for DisplayGroupInstance objects that are members of the DisplayGroupInstance repository member of the OdbDisplay object.

Note

Check DisplayGroupInstance.setValues on help.3ds.com/2023.

Parameters:: lockOptions (Union[AbaqusBoolean, bool], default: 0) – A Boolean specifying whether the display options stored on the DisplayGroupInstance object should be synchronized with changes to the viewport display options. This member is available only for DisplayGroupInstance objects that are members of the DisplayGroupInstance repository member of the OdbDisplay object. The default value is OFF.

class DisplayGroupInstanceRepository[source]

Bases: object

The DisplayGroupInstanceRepository object stores DisplayGroupInstance objects. In addition to all the standard Python repository methods, the DisplayGroupInstance repository defines additional methods as described below.

Note

This object can be accessed by:

import visualization
session.viewports[name].layers[name].odbDisplay.displayGroupInstances
session.viewports[name].odbDisplay.displayGroupInstances

Note

Check DisplayGroupInstanceRepository on help.3ds.com/2023.

Member Details:

syncOptions(name, updateInstances=1)[source]

This method synchronizes the display options stored on the OdbDisplay object with the display options stored on the DisplayGroupInstance object.

Note

Check DisplayGroupInstanceRepository.syncOptions on help.3ds.com/2023.

Parameters:

name (str) – A String specifying the repository key.
updateInstances (Union[AbaqusBoolean, bool], default: 1) – A Boolean specifying whether to synchronize the display options on all the DisplayGroupInstance objects stored in the DisplayGroupInstanceRepository for which lockOptions is OFF. The default value of updateInstances is ON.

class LeafFromConstraintNames(name, type)[source]

Bases: Leaf

The LeafFromConstraintNames object can be used whenever a Leaf object is expected as an argument. A Leaf object is used used to specify the items in a display group. Leaf objects are constructed as temporary objects that are used as arguments to DisplayGroup (DisplayGroup object) commands. The LeafFromConstraintNames object is derived from the Leaf object.

Note

This object can be accessed by:

import displayGroupOdbToolset

New in version 2019: The LeafFromConstraintNames class was added.

Note

Check LeafFromConstraintNames on help.3ds.com/2023.

This method creates a Leaf object from a sequence of constraint objects. Leaf objects specify the items in a display group.

Note

This function can be accessed by:

LeafFromConstraintNames

Parameters:

name (tuple) – A sequence of tuples of name objects.
type (Literal[DISTRIBUTING_COUPLING, TIE, RIGID_BODY, MPC, SHELL_TO_SOLID_COUPLING, KINEMATIC_COUPLING]) – A SymbolicConstant specifying the Leaf type. Possible values are TIE, SHELL_TO_SOLID_COUPLING, DISTRIBUTING_COUPLING, KINEMATIC_COUPLING, RIGID_BODY, and MPC.

Return type:

A LeafFromConstraintNames object.

Member Details:

leafType: SymbolicConstant[source]: A SymbolicConstant specifying the leaf type. Possible values are TIE, SHELL_TO_SOLID_COUPLING, DISTRIBUTING_COUPLING, KINEMATIC_COUPLING, RIGID_BODY, and MPC.

class LeafFromDatums(datumSeq)[source]

Bases: Leaf

The LeafFromDatums object can be used whenever a Leaf object is expected as an argument. Leaf objects are used to specify the items in a display group. Leaf objects are constructed as temporary objects, which are then used as arguments to DisplayGroup commands. The LeafFromDatums object is derived from the Leaf object.

Note

This object can be accessed by:

import displayGroupMdbToolset

Note

Check LeafFromDatums on help.3ds.com/2023.

This method creates a Leaf object from a sequence of datum objects. Leaf objects specify the items in a display group.

Note

This function can be accessed by:

LeafFromDatums

Parameters:: datumSeq (Sequence[Datum]) – A sequence of datum objects.
Returns:: A LeafFromDatums object.
Return type:: LeafFromDatums

Member Details:

leafType: SymbolicConstant[source]: A SymbolicConstant specifying the leaf type. Possible values are EMPTY_LEAF, DEFAULT_MODEL, ALL_ELEMENTS, ALL_NODES, and ALL_SURFACES.

class LeafFromDisplayGroup(displayGroup)[source]

Bases: Leaf

The LeafFromDisplayGroup object can be used whenever a Leaf object is expected as an argument. Leaf objects are used to specify the items in a display group. Leaf objects are constructed as temporary objects, which are then used as arguments to DisplayGroup commands.The LeafFromDisplayGroup object is derived from the Leaf object.

Note

This object can be accessed by:

import displayGroupMdbToolset
import displayGroupOdbToolset

Note

Check LeafFromDisplayGroup on help.3ds.com/2023.

This method creates a Leaf object from a sequence of Display Group objects.

Note

This function can be accessed by:

LeafFromDisplayGroup

Parameters:: displayGroup (List[DisplayGroup]) – A DisplayGroupArray object.
Returns:: A LeafFromDisplayGroup object.
Return type:: LeafFromDisplayGroup

Member Details:

displayGroup: List[DisplayGroup][source]: A DisplayGroupArray object.

leafType: SymbolicConstant[source]: A SymbolicConstant specifying the leaf type. Possible values are EMPTY_LEAF, DEFAULT_MODEL, ALL_ELEMENTS, ALL_NODES, and ALL_SURFACES.

class LeafFromElementLabels(partInstanceName, elementLabels)[source]

Bases: Leaf

The LeafFromElementLabels object can be used whenever a Leaf object is expected as an argument. Leaf objects are used to specify the items in a display group. Leaf objects are constructed as temporary objects, which are then used as arguments to DisplayGroup commands. The LeafFromElementLabels object is derived from the Leaf object. This page discusses:

Note

This object can be accessed by:

import displayGroupOdbToolset

Note

Check LeafFromElementLabels on help.3ds.com/2023.

This method creates a Leaf object from a sequence of element labels that belong to a single part instance.

Note

This function can be accessed by:

LeafFromElementLabels

Parameters:

partInstanceName (str) – A String specifying the name of the part instance to which elementLabels refers.
elementLabels (tuple) – A sequence of Strings specifying expressions that denote element labels. The expression can be any of the following:An Int specifying a single element label; for example, 1.A String specifying a single element label; for example, ‘7’.A String specifying a sequence of element labels; for example, ‘3:5’ and ‘3:15:3’.

Returns:

A LeafFromElementLabels object.

Return type:

LeafFromElementLabels

Member Details:

elementLabels: tuple[source]: A sequence of Strings specifying expressions that denote element labels. The expression can be any of the following:An Int specifying a single element label; for example, 1.A String specifying a single element label; for example, ‘7’.A String specifying a sequence of element labels; for example, ‘3:5’ and ‘3:15:3’.

leafType: SymbolicConstant[source]: A SymbolicConstant specifying the leaf type. Possible values are EMPTY_LEAF, DEFAULT_MODEL, ALL_ELEMENTS, ALL_NODES, and ALL_SURFACES.

partInstanceName: str[source]: A String specifying the name of the part instance to which elementLabels refers.

class LeafFromElementSets(elementSets)[source]

Bases: Leaf

The LeafFromElementSets object can be used whenever a Leaf object is expected as an argument. Leaf objects are used to specify the items in a display group. Leaf objects are constructed as temporary objects, which are then used as arguments to DisplayGroup commands. The LeafFromElementSets object is derived from the Leaf object.

Note

This object can be accessed by:

import displayGroupOdbToolset

Note

Check LeafFromElementSets on help.3ds.com/2023.

This method creates a Leaf object from a sequence of element sets.

Note

This function can be accessed by:

LeafFromElementSets

Parameters:: elementSets (tuple) – A sequence of Strings specifying element sets or a String specifying a single element set.
Returns:: A LeafFromElementSets object.
Return type:: LeafFromElementSets

Member Details:

elementSets: tuple[source]: A sequence of Strings specifying element sets or a String specifying a single element set.

leafType: SymbolicConstant[source]: A SymbolicConstant specifying the leaf type. Possible values are EMPTY_LEAF, DEFAULT_MODEL, ALL_ELEMENTS, ALL_NODES, and ALL_SURFACES.

class LeafFromElementVarRange(minimumRange=None, maximumRange=3, insideRange=1)[source]

Bases: Leaf

The LeafFromElementVarRange object can be used whenever a Leaf object is expected as an argument. Leaf objects are used to specify the items in a display group. Leaf objects are constructed as temporary objects, which are then used as arguments to DisplayGroup commands. The LeafFromElementVarRange object is derived from the Leaf object.

Note

This object can be accessed by:

import displayGroupOdbToolset

Note

Check LeafFromElementVarRange on help.3ds.com/2023.

This method creates a Leaf object from elements with values lying in a variable range.

Note

This function can be accessed by:

LeafFromElementVarRange

Parameters:

minimumRange (Optional[float], default: None) – A Float specifying the minimum value for the variable range. The default value is −3.40282346639E38.
maximumRange (float, default: 3) – A Float specifying the maximum value for the variable range. The default value is 3.40282346639e+038.
insideRange (Union[AbaqusBoolean, bool], default: 1) – A Boolean specifying the method used to evaluate the range. If insideRange = ON, the range falls inside the specified minimum and maximum values. The default value is ON.

Returns:

A LeafFromElementVarRange object.

Return type:

LeafFromElementVarRange

Member Details:

insideRange: Union[AbaqusBoolean, bool] = 1[source]: A Boolean specifying the method used to evaluate the range. If insideRange = ON, the range falls inside the specified minimum and maximum values. The default value is ON.

leafType: SymbolicConstant[source]: A SymbolicConstant specifying the leaf type. Possible values are EMPTY_LEAF, DEFAULT_MODEL, ALL_ELEMENTS, ALL_NODES, and ALL_SURFACES.

maximumRange: float = 3[source]: A Float specifying the maximum value for the variable range. The default value is 3.40282346639e+038.

minimumRange: Optional[float] = None[source]: A Float specifying the minimum value for the variable range. The default value is −3.40282346639E38.

class LeafFromGeometry(edgeSeq=(), faceSeq=(), cellSeq=())[source]

Bases: Leaf

The LeafFromGeometry object can be used whenever a Leaf object is expected as an argument. Leaf objects are used to specify the items in a display group. Leaf objects are constructed as temporary objects, which are then used as arguments to DisplayGroup commands. The LeafFromGeometry object is derived from the Leaf object.

Note

This object can be accessed by:

import displayGroupMdbToolset

Note

Check LeafFromGeometry on help.3ds.com/2023.

This method creates a Leaf object from a sequence of edge, face and cell geometry objects. Any combination of edge, face or cell arguments is allowed however the arguments must specify at least one object–it is not permissible to create an empty leaf.

Note

This function can be accessed by:

LeafFromGeometry

Parameters:

edgeSeq (tuple, default: ()) – A sequence of geometry edges.
faceSeq (tuple, default: ()) – A sequence of geometry faces.
cellSeq (tuple, default: ()) – A sequence of geometry cells.

Returns:

A LeafFromGeometry object.

Return type:

LeafFromGeometry

Raises:

Cannot define empty leaf – If at least one of the sequences is not passed to this method.

Member Details:

leafType: SymbolicConstant[source]: A SymbolicConstant specifying the leaf type. Possible values are EMPTY_LEAF, DEFAULT_MODEL, ALL_ELEMENTS, ALL_NODES, and ALL_SURFACES.

class LeafFromInstance(instances)[source]

Bases: Leaf

The LeafFromInstance object can be used whenever a Leaf object is expected as an argument. Leaf objects are used to specify the items in a display group. Leaf objects are constructed as temporary objects, which are then used as arguments to DisplayGroup commands. The LeafFromInstance object is derived from the Leaf object.

Note

This object can be accessed by:

import displayGroupMdbToolset

Note

Check LeafFromInstance on help.3ds.com/2023.

This method creates a Leaf object from a sequence of part instance objects.

Note

This function can be accessed by:

LeafFromInstance

Parameters:: instances (PartInstance) – A PartInstance object or a Sequence of PartInstance objects.
Returns:: A LeafFromInstance object.
Return type:: LeafFromInstance
Raises:: Cannot define empty leaf – If an invalid argument is passed to this method.

Member Details:

leafType: SymbolicConstant[source]: A SymbolicConstant specifying the leaf type. Possible values are EMPTY_LEAF, DEFAULT_MODEL, ALL_ELEMENTS, ALL_NODES, and ALL_SURFACES.

class LeafFromInstanceElementLabels(elementLabels)[source]

Bases: Leaf

The LeafFromInstanceElementLabels object can be used whenever a Leaf object is expected as an argument. Leaf objects are used to specify the items in a display group. Leaf objects are constructed as temporary objects, which are then used as arguments to DisplayGroup commands. The LeafFromInstanceElementLabels object is derived from the Leaf object.

Note

This object can be accessed by:

import displayGroupMdbToolset

Note

Check LeafFromInstanceElementLabels on help.3ds.com/2023.

This method creates a Leaf object from a sequence of Strings specifying the element labels. Leaf objects specify the items in a display group.

Note

This function can be accessed by:

LeafFromInstanceElementLabels

Parameters:: elementLabels (tuple) – A sequence of sequences specifying element labels. Each inner sequence consists of a PartInstance object followed by a sequence of Strings specifying element labels.
Returns:: A LeafFromInstanceElementLabels object.
Return type:: LeafFromInstanceElementLabels

Member Details:

leafType: SymbolicConstant[source]: A SymbolicConstant specifying the leaf type. Possible values are EMPTY_LEAF, DEFAULT_MODEL, ALL_ELEMENTS, ALL_NODES, and ALL_SURFACES.

class LeafFromInstanceNodeLabels(nodeLabels)[source]

Bases: Leaf

The LeafFromInstanceNodeLabels object can be used whenever a Leaf object is expected as an argument. Leaf objects are used to specify the items in a display group. Leaf objects are constructed as temporary objects, which are then used as arguments to DisplayGroup commands. The LeafFromInstanceNodeLabels object is derived from the Leaf object.

Note

This object can be accessed by:

import displayGroupMdbToolset

Note

Check LeafFromInstanceNodeLabels on help.3ds.com/2023.

This method creates a Leaf object from a sequence of Strings specifying the node labels. Leaf objects specify the items in a display group.

Note

This function can be accessed by:

LeafFromInstanceNodeLabels

Parameters:: nodeLabels (tuple) – A sequence of sequences specifying node labels. Each inner sequence consists of a PartInstance object followed by a sequence of Strings specifying node labels.
Returns:: A LeafFromInstanceNodeLabels object.
Return type:: LeafFromInstanceNodeLabels

Member Details:

leafType: SymbolicConstant[source]: A SymbolicConstant specifying the leaf type. Possible values are EMPTY_LEAF, DEFAULT_MODEL, ALL_ELEMENTS, ALL_NODES, and ALL_SURFACES.

class LeafFromMeshElementLabels(elementSeq)[source]

Bases: Leaf

The LeafFromMeshElementLabels object can be used whenever a Leaf object is expected as an argument. Leaf objects are used to specify the items in a display group. Leaf objects are constructed as temporary objects, which are then used as arguments to DisplayGroup commands. The LeafFromMeshElementLabels object is derived from the Leaf object.

Note

This object can be accessed by:

import displayGroupMdbToolset

Note

Check LeafFromMeshElementLabels on help.3ds.com/2023.

This method creates a Leaf object from a sequence of mesh element objects. Leaf objects specify the items in a display group.

Note

This function can be accessed by:

LeafFromMeshElementLabels

Parameters:: elementSeq (Sequence[MeshElement]) – A sequence of MeshElement objects specifying elements.
Returns:: A LeafFromMeshElementLabels object.
Return type:: LeafFromMeshElementLabels

Member Details:

leafType: SymbolicConstant[source]: A SymbolicConstant specifying the leaf type. Possible values are EMPTY_LEAF, DEFAULT_MODEL, ALL_ELEMENTS, ALL_NODES, and ALL_SURFACES.

class LeafFromMeshNodeLabels(nodeSeq)[source]

Bases: Leaf

The LeafFromMeshNodeLabels object can be used whenever a Leaf object is expected as an argument. Leaf objects are used to specify the items in a display group. Leaf objects are constructed as temporary objects, which are then used as arguments to DisplayGroup commands. The LeafFromMeshNodeLabels object is derived from the Leaf object.

Note

This object can be accessed by:

import displayGroupMdbToolset

Note

Check LeafFromMeshNodeLabels on help.3ds.com/2023.

This method creates a Leaf object from a sequence of mesh node objects. Leaf objects specify the items in a display group.

Note

This function can be accessed by:

LeafFromMeshNodeLabels

Parameters:: nodeSeq (Sequence[MeshNode]) – A sequence of MeshNode objects specifying nodes.
Returns:: A LeafFromMeshNodeLabels object.
Return type:: LeafFromMeshNodeLabels

Member Details:

leafType: SymbolicConstant[source]: A SymbolicConstant specifying the leaf type. Possible values are EMPTY_LEAF, DEFAULT_MODEL, ALL_ELEMENTS, ALL_NODES, and ALL_SURFACES.

class LeafFromMeshSurfaceSets(surfaceSets)[source]

Bases: Leaf

The LeafFromMeshSurfaceSets object can be used whenever a Leaf object is expected as an argument. Leaf objects are used to specify the items in a display group. Leaf objects are constructed as temporary objects, which are then used as arguments to DisplayGroup commands. The LeafFromMeshSurfaceSets object is derived from the Leaf object.

Note

This object can be accessed by:

import displayGroupMdbToolset

Note

Check LeafFromMeshSurfaceSets on help.3ds.com/2023.

This method creates a Leaf object from a sequence of surface sets.

Note

This function can be accessed by:

LeafFromMeshSurfaceSets

Parameters:: surfaceSets (Sequence[Surface]) – A sequence of Surface objects.
Returns:: A LeafFromMeshSurfaceSets object.
Return type:: LeafFromMeshSurfaceSets

Member Details:

leafType: SymbolicConstant[source]: A SymbolicConstant specifying the leaf type. Possible values are EMPTY_LEAF, DEFAULT_MODEL, ALL_ELEMENTS, ALL_NODES, and ALL_SURFACES.

class LeafFromModelElemLabels(elementLabels)[source]

Bases: Leaf

The LeafFromModelElemLabels object can be used whenever a Leaf object is expected as an argument. Leaf objects are used to specify the items in a display group. Leaf objects are constructed as temporary objects, which are then used as arguments to DisplayGroup commands. The LeafFromModelElemLabels object is derived from the Leaf object.

Note

This object can be accessed by:

import displayGroupOdbToolset

Note

Check LeafFromModelElemLabels on help.3ds.com/2023.

This method creates a Leaf object from a sequence of element labels spanning several part instances.

Note

This function can be accessed by:

LeafFromModelElemLabels

Parameters:: elementLabels (tuple) – A sequence of Strings specifying expressions that denote element labels per part instance in the model. Each part instance element expression is a sequence of a String specifying the part instance name and a sequence of element expressions; for example, ((‘partInstance1’,(1,’7’,’3:15;3’),), (‘partInstance2’,’8’),)). The element expressions can be any of the following:An Int specifying a single element label; for example, 1.A String specifying a single element label; for example, ‘7’.A String specifying a sequence of element labels; for example, ‘3:5’ and ‘3:15:3’.
Returns:: A LeafFromModelElemLabels object.
Return type:: LeafFromModelElemLabels

Member Details:

elementLabels: tuple[source]: A sequence of Strings specifying expressions that denote element labels per part instance in the model. Each part instance element expression is a sequence of a String specifying the part instance name and a sequence of element expressions; for example, ((‘partInstance1’,(1,’7’,’3:15;3’),), (‘partInstance2’,’8’),)). The element expressions can be any of the following:An Int specifying a single element label; for example, 1.A String specifying a single element label; for example, ‘7’.A String specifying a sequence of element labels; for example, ‘3:5’ and ‘3:15:3’.

leafType: SymbolicConstant[source]: A SymbolicConstant specifying the leaf type. Possible values are EMPTY_LEAF, DEFAULT_MODEL, ALL_ELEMENTS, ALL_NODES, and ALL_SURFACES.

class LeafFromModelNodeLabels(nodeLabels)[source]

Bases: Leaf

The LeafFromModelNodeLabels object can be used whenever a Leaf object is expected as an argument. Leaf objects are used to specify the items in a display group. Leaf objects are constructed as temporary objects, which are then used as arguments to DisplayGroup commands. The LeafFromModelNodeLabels object is derived from the Leaf object.

Note

This object can be accessed by:

import displayGroupOdbToolset

Note

Check LeafFromModelNodeLabels on help.3ds.com/2023.

This method creates a Leaf object from a sequence of node labels spanning several part instances.

Note

This function can be accessed by:

LeafFromModelNodeLabels

Parameters:: nodeLabels (tuple) – A sequence of Strings specifying expressions that denote node labels per part instance in the model. Each part instance node expression is a sequence of a String specifying the part instance name and a sequence of node expressions; for example, ((‘partInstance1’,(1,’7’,’3:15;3’),), (‘partInstance2’,’8’),)). The node expressions can be any of the following:An Int specifying a single node label; for example, 1.A String specifying a single node label; for example, ‘7’.A String specifying a sequence of node labels; for example, ‘3:5’ and ‘3:15:3’.
Returns:: A LeafFromModelNodeLabels object.
Return type:: LeafFromModelNodeLabels

Member Details:

leafType: SymbolicConstant[source]: A SymbolicConstant specifying the leaf type. Possible values are EMPTY_LEAF, DEFAULT_MODEL, ALL_ELEMENTS, ALL_NODES, and ALL_SURFACES.

nodeLabels: tuple[source]: A sequence of Strings specifying expressions that denote node labels per part instance in the model. Each part instance node expression is a sequence of a String specifying the part instance name and a sequence of node expressions; for example, ((‘partInstance1’,(1,’7’,’3:15;3’),), (‘partInstance2’,’8’),)). The node expressions can be any of the following:An Int specifying a single node label; for example, 1.A String specifying a single node label; for example, ‘7’.A String specifying a sequence of node labels; for example, ‘3:5’ and ‘3:15:3’.

class LeafFromNodeLabels(partInstanceName, nodeLabels)[source]

Bases: Leaf

The LeafFromNodeLabels object can be used whenever a Leaf object is expected as an argument. Leaf objects are used to specify the items in a display group. Leaf objects are constructed as temporary objects, which are then used as arguments to DisplayGroup commands. The LeafFromNodeLabels object is derived from the Leaf object.

Note

This object can be accessed by:

import displayGroupOdbToolset

Note

Check LeafFromNodeLabels on help.3ds.com/2023.

This method creates a Leaf object from a sequence of node labels that belong to a single part instance.

Note

This function can be accessed by:

LeafFromNodeLabels

Parameters:

partInstanceName (str) – A String specifying the name of the part instance to which nodeLabels refers.
nodeLabels (tuple) – A sequence of Strings specifying expressions that denote node labels. The expression can be any of the following:An Int specifying a single node label; for example, 1.A String specifying a single node label; for example, ‘7’.A String specifying a sequence of node labels; for example, ‘3:5’ and ‘3:15:3’.

Returns:

A LeafFromNodeLabels object.

Return type:

LeafFromNodeLabels

Member Details:

leafType: SymbolicConstant[source]: A SymbolicConstant specifying the leaf type. Possible values are EMPTY_LEAF, DEFAULT_MODEL, ALL_ELEMENTS, ALL_NODES, and ALL_SURFACES.

nodeLabels: tuple[source]: A sequence of Strings specifying expressions that denote node labels. The expression can be any of the following:An Int specifying a single node label; for example, 1.A String specifying a single node label; for example, ‘7’.A String specifying a sequence of node labels; for example, ‘3:5’ and ‘3:15:3’.

partInstanceName: str[source]: A String specifying the name of the part instance to which nodeLabels refers.

class LeafFromNodeSets(nodeSets)[source]

Bases: Leaf

The LeafFromNodeSets object can be used whenever a Leaf object is expected as an argument. Leaf objects are used to specify the items in a display group. Leaf objects are constructed as temporary objects, which are then used as arguments to DisplayGroup commands. The LeafFromNodeSets object is derived from the Leaf object.

Note

This object can be accessed by:

import displayGroupOdbToolset

Note

Check LeafFromNodeSets on help.3ds.com/2023.

This method creates a Leaf object from a sequence of node sets.

Note

This function can be accessed by:

LeafFromNodeSets

Parameters:: nodeSets (tuple) – A sequence of Strings specifying node sets or a String specifying a single node set.
Returns:: A LeafFromNodeSets object.
Return type:: LeafFromNodeSets

Member Details:

leafType: SymbolicConstant[source]: A SymbolicConstant specifying the leaf type. Possible values are EMPTY_LEAF, DEFAULT_MODEL, ALL_ELEMENTS, ALL_NODES, and ALL_SURFACES.

nodeSets: tuple[source]: A sequence of Strings specifying node sets or a String specifying a single node set.

class LeafFromNodeVarRange(minimumRange=None, maximumRange=3, insideRange=1)[source]

Bases: Leaf

The LeafFromNodeVarRange object can be used whenever a Leaf object is expected as an argument. Leaf objects are used to specify the items in a display group. Leaf objects are constructed as temporary objects, which are then used as arguments to DisplayGroup commands. The LeafFromNodeVarRange object is derived from the Leaf object.

Note

This object can be accessed by:

import displayGroupOdbToolset

Note

Check LeafFromNodeVarRange on help.3ds.com/2023.

This method creates a Leaf object from nodes with values lying in a variable range.

Note

This function can be accessed by:

LeafFromNodeVarRange

Parameters:

minimumRange (Optional[float], default: None) – A Float specifying the minimum value for the variable range. The default value is −3.40282346639E38.
maximumRange (float, default: 3) – A Float specifying the maximum value for the variable range. The default value is 3.40282346639e+038.
insideRange (Union[AbaqusBoolean, bool], default: 1) – A Boolean specifying the method used to evaluate the range. If insideRange = ON, the range falls inside the specified minimum and maximum values. The default value is ON.

Returns:

A LeafFromNodeVarRange object.

Return type:

LeafFromNodeVarRange

Member Details:

insideRange: Union[AbaqusBoolean, bool] = 1[source]: A Boolean specifying the method used to evaluate the range. If insideRange = ON, the range falls inside the specified minimum and maximum values. The default value is ON.

leafType: SymbolicConstant[source]: A SymbolicConstant specifying the leaf type. Possible values are EMPTY_LEAF, DEFAULT_MODEL, ALL_ELEMENTS, ALL_NODES, and ALL_SURFACES.

maximumRange: float = 3[source]: A Float specifying the maximum value for the variable range. The default value is 3.40282346639e+038.

minimumRange: Optional[float] = None[source]: A Float specifying the minimum value for the variable range. The default value is −3.40282346639E38.

class LeafFromOdbEdgePick(edgePick)[source]

Bases: Leaf

The LeafFromOdbEdgePick object can be used whenever a Leaf object is expected as an argument. Leaf objects are used to specify the items in a display group. Leaf objects are constructed as temporary objects, which are then used as arguments to DisplayGroup commands. The LeafFromOdbEdgePick object is derived from the Leaf object.

Note

This object can be accessed by:

import displayGroupOdbToolset

Note

Check LeafFromOdbEdgePick on help.3ds.com/2023.

This method creates a Leaf object from a tuple containing machine readable, compact strings defining the edges picked for each part instance. Leaf objects specify the items in a display group.

Note

This function can be accessed by:

LeafFromOdbEdgePick

Parameters:: edgePick (tuple) – A sequence of tuples of the form [part name, entity count, machine readable pick strings].
Returns:: A LeafFromOdbEdgePick object.
Return type:: LeafFromOdbEdgePick

Member Details:

leafType: SymbolicConstant[source]: A SymbolicConstant specifying the leaf type. Possible values are EMPTY_LEAF, DEFAULT_MODEL, ALL_ELEMENTS, ALL_NODES, and ALL_SURFACES.

class LeafFromOdbElementLayups(elementLayups)[source]

Bases: Leaf

The LeafFromOdbElementLayups object can be used whenever a Leaf object is expected as an argument. Leaf objects are used to specify the items in a display group. Leaf objects are constructed as temporary objects, which are then used as arguments to DisplayGroup commands. The LeafFromOdbElementLayups object is derived from the Leaf object.

Note

This object can be accessed by:

import displayGroupOdbToolset

Note

Check LeafFromOdbElementLayups on help.3ds.com/2023.

This method creates a Leaf object from a sequence of Strings specifying layup names. Leaf objects specify the items in a display group.

Note

This function can be accessed by:

LeafFromOdbElementLayups

Parameters:: elementLayups (tuple) – A sequence of Strings specifying element layups.
Returns:: A LeafFromOdbElementLayups object.
Return type:: LeafFromOdbElementLayups

Member Details:

leafType: SymbolicConstant[source]: A SymbolicConstant specifying the leaf type. Possible values are EMPTY_LEAF, DEFAULT_MODEL, ALL_ELEMENTS, ALL_NODES, and ALL_SURFACES.

class LeafFromOdbElementMaterials(elementMaterials)[source]

Bases: Leaf

The LeafFromOdbElementMaterials object can be used whenever a Leaf object is expected as an argument. Leaf objects are used to specify the items in a display group. Leaf objects are constructed as temporary objects, which are then used as arguments to DisplayGroup commands. The LeafFromOdbElementMaterials object is derived from the Leaf object.

Note

This object can be accessed by:

import displayGroupOdbToolset

Note

Check LeafFromOdbElementMaterials on help.3ds.com/2023.

This method creates a Leaf object from a sequence of Strings specifying material names. Leaf objects specify the items in a display group.

Note

This function can be accessed by:

LeafFromOdbElementMaterials

Parameters:: elementMaterials (tuple) – A sequence of Strings specifying element materials.
Returns:: A LeafFromOdbElementMaterials object.
Return type:: LeafFromOdbElementMaterials

Member Details:

leafType: SymbolicConstant[source]: A SymbolicConstant specifying the leaf type. Possible values are EMPTY_LEAF, DEFAULT_MODEL, ALL_ELEMENTS, ALL_NODES, and ALL_SURFACES.

class LeafFromOdbElementPick(elementPick)[source]

Bases: Leaf

The LeafFromOdbElementPick object can be used whenever a Leaf object is expected as an argument. Leaf objects are used to specify the items in a display group. Leaf objects are constructed as temporary objects, which are then used as arguments to DisplayGroup commands. The LeafFromOdbElementPick object is derived from the Leaf object.

Note

This object can be accessed by:

import displayGroupOdbToolset

Note

Check LeafFromOdbElementPick on help.3ds.com/2023.

This method creates a Leaf object from a tuple containing machine readable, compact strings defining the elements picked for each part instance. Leaf objects specify the items in a display group.

Note

This function can be accessed by:

LeafFromOdbElementPick

Parameters:: elementPick (tuple) – A sequence of tuples of the form [part name, entity count, machine readable pick strings].
Returns:: A LeafFromOdbElementPick object.
Return type:: LeafFromOdbElementPick

Member Details:

leafType: SymbolicConstant[source]: A SymbolicConstant specifying the leaf type. Possible values are EMPTY_LEAF, DEFAULT_MODEL, ALL_ELEMENTS, ALL_NODES, and ALL_SURFACES.

class LeafFromOdbElementPlies(elementPlies)[source]

Bases: Leaf

The LeafFromOdbElementPlies object can be used whenever a Leaf object is expected as an argument. Leaf objects are used to specify the items in a display group. Leaf objects are constructed as temporary objects, which are then used as arguments to DisplayGroup commands. The LeafFromOdbElementPlies object is derived from the Leaf object.

Note

This object can be accessed by:

import displayGroupOdbToolset

Note

Check LeafFromOdbElementPlies on help.3ds.com/2023.

This method creates a Leaf object from a sequence of Strings specifying ply names. Leaf objects specify the items in a display group.

Note

This function can be accessed by:

LeafFromOdbElementPlies

Parameters:: elementPlies (tuple) – A sequence of Strings specifying element plies.
Returns:: A LeafFromOdbElementPlies object.
Return type:: LeafFromOdbElementPlies

Member Details:

leafType: SymbolicConstant[source]: A SymbolicConstant specifying the leaf type. Possible values are EMPTY_LEAF, DEFAULT_MODEL, ALL_ELEMENTS, ALL_NODES, and ALL_SURFACES.

class LeafFromOdbElementSections(elementSections)[source]

Bases: Leaf

The LeafFromOdbElementSections object can be used whenever a Leaf object is expected as an argument. Leaf objects are used to specify the items in a display group. Leaf objects are constructed as temporary objects, which are then used as arguments to DisplayGroup commands. The LeafFromOdbElementSections object is derived from the Leaf object.

Note

This object can be accessed by:

import displayGroupOdbToolset

Note

Check LeafFromOdbElementSections on help.3ds.com/2023.

This method creates a Leaf object from a sequence of Strings specifying section names. Leaf objects specify the items in a display group.

Note

This function can be accessed by:

LeafFromOdbElementSections

Parameters:: elementSections (tuple) – A sequence of Strings specifying element Sections.
Returns:: A LeafFromOdbElementSections object.
Return type:: LeafFromOdbElementSections

Member Details:

leafType: SymbolicConstant[source]: A SymbolicConstant specifying the leaf type. Possible values are EMPTY_LEAF, DEFAULT_MODEL, ALL_ELEMENTS, ALL_NODES, and ALL_SURFACES.

class LeafFromOdbElementTypes(elementTypes)[source]

Bases: Leaf

The LeafFromOdbElementTypes object can be used whenever a Leaf object is expected as an argument. Leaf objects are used to specify the items in a display group. Leaf objects are constructed as temporary objects, which are then used as arguments to DisplayGroup commands. The LeafFromOdbElementTypes object is derived from the Leaf object.

Note

This object can be accessed by:

import displayGroupOdbToolset

Note

Check LeafFromOdbElementTypes on help.3ds.com/2023.

This method creates a Leaf object from a sequence of Strings specifying element names. Leaf objects specify the items in a display group.

Note

This function can be accessed by:

LeafFromOdbElementTypes

Parameters:: elementTypes (tuple) – A sequence of Strings specifying element Types.
Returns:: A LeafFromOdbElementTypes object.
Return type:: LeafFromOdbElementTypes

Member Details:

leafType: SymbolicConstant[source]: A SymbolicConstant specifying the leaf type. Possible values are EMPTY_LEAF, DEFAULT_MODEL, ALL_ELEMENTS, ALL_NODES, and ALL_SURFACES.

class LeafFromOdbNodePick(nodePick)[source]

Bases: Leaf

The LeafFromOdbNodePick object can be used whenever a Leaf object is expected as an argument. Leaf objects are used to specify the items in a display group. Leaf objects are constructed as temporary objects, which are then used as arguments to DisplayGroup commands. The LeafFromOdbNodePick object is derived from the Leaf object.

Note

This object can be accessed by:

import displayGroupOdbToolset

Note

Check LeafFromOdbNodePick on help.3ds.com/2023.

This method creates a Leaf object from a tuple containing machine readable, compact strings defining the nodes picked for each part instance. Leaf objects specify the items in a display group.

Note

This function can be accessed by:

LeafFromOdbNodePick

Parameters:: nodePick (tuple) – A sequence of tuples of the form [part name, entity count, machine readable pick strings].
Returns:: A LeafFromOdbNodePick object.
Return type:: LeafFromOdbNodePick

Member Details:

leafType: SymbolicConstant[source]: A SymbolicConstant specifying the leaf type. Possible values are EMPTY_LEAF, DEFAULT_MODEL, ALL_ELEMENTS, ALL_NODES, and ALL_SURFACES.

class LeafFromPartElementLabels(part, elementLabels)[source]

Bases: Leaf

The LeafFromPartElementLabels object can be used whenever a Leaf object is expected as an argument. Leaf objects are used to specify the items in a display group. Leaf objects are constructed as temporary objects, which are then used as arguments to DisplayGroup commands. The LeafFromPartElementLabels object is derived from the Leaf object.

Note

This object can be accessed by:

import displayGroupMdbToolset

Note

Check LeafFromPartElementLabels on help.3ds.com/2023.

This method creates a Leaf object from a sequence of Strings specifying element labels. Leaf objects specify the items in a display group.

Note

This function can be accessed by:

LeafFromPartElementLabels

Parameters:

part (Part) – A Part object.
elementLabels (tuple) – A sequence of Strings specifying element labels.

Returns:

A LeafFromPartElementLabels object.

Return type:

LeafFromPartElementLabels

Member Details:

leafType: SymbolicConstant[source]: A SymbolicConstant specifying the leaf type. Possible values are EMPTY_LEAF, DEFAULT_MODEL, ALL_ELEMENTS, ALL_NODES, and ALL_SURFACES.

class LeafFromPartInstance(partInstanceName)[source]

Bases: Leaf

The LeafFromPartInstance object can be used whenever a Leaf object is expected as an argument. Leaf objects are used to specify the items in a display group. Leaf objects are constructed as temporary objects, which are then used as arguments to DisplayGroup commands. The LeafFromPartInstance object is derived from the Leaf object.

Note

This object can be accessed by:

import displayGroupOdbToolset

Note

Check LeafFromPartInstance on help.3ds.com/2023.

This method creates a Leaf object from a list of part instance names.

Note

This function can be accessed by:

LeafFromPartInstance

Parameters:: partInstanceName (tuple) – A sequence of Strings specifying the names of the part instances.
Returns:: A LeafFromPartInstance object.
Return type:: LeafFromPartInstance

Member Details:

leafType: SymbolicConstant[source]: A SymbolicConstant specifying the leaf type. Possible values are EMPTY_LEAF, DEFAULT_MODEL, ALL_ELEMENTS, ALL_NODES, and ALL_SURFACES.

partInstanceName: tuple[source]: A sequence of Strings specifying the names of the part instances.

class LeafFromPartNodeLabels(part, nodeLabels)[source]

Bases: Leaf

The LeafFromPartNodeLabels object can be used whenever a Leaf object is expected as an argument. Leaf objects are used to specify the items in a display group. Leaf objects are constructed as temporary objects, which are then used as arguments to DisplayGroup commands. The LeafFromPartNodeLabels object is derived from the Leaf object.

Note

This object can be accessed by:

import displayGroupMdbToolset

Note

Check LeafFromPartNodeLabels on help.3ds.com/2023.

This method creates a Leaf object from a sequence of Strings specifying node labels. Leaf objects specify the items in a display group.

Note

This function can be accessed by:

LeafFromPartNodeLabels

Parameters:

part (Part) – A Part object.
nodeLabels (tuple) – A sequence of Strings specifying node labels.

Returns:

A LeafFromPartNodeLabels object.

Return type:

LeafFromPartNodeLabels

Member Details:

leafType: SymbolicConstant[source]: A SymbolicConstant specifying the leaf type. Possible values are EMPTY_LEAF, DEFAULT_MODEL, ALL_ELEMENTS, ALL_NODES, and ALL_SURFACES.

class LeafFromReferencePoint(refPtSeq)[source]

Bases: Leaf

The LeafFromReferencePoint object can be used whenever a Leaf object is expected as an argument. Leaf objects are used to specify the items in a display group. Leaf objects are constructed as temporary objects, which are then used as arguments to DisplayGroup commands. The LeafFromReferencePoint object is derived from the Leaf object.

Note

This object can be accessed by:

import displayGroupMdbToolset

Note

Check LeafFromReferencePoint on help.3ds.com/2023.

This method creates a Leaf object from a sequence of ReferencePoint objects.

Note

This function can be accessed by:

LeafFromReferencePoint

Parameters:: refPtSeq (tuple) – A sequence of Reference Point objects.
Returns:: A LeafFromReferencePoint object.
Return type:: LeafFromReferencePoint

Member Details:

leafType: SymbolicConstant[source]: A SymbolicConstant specifying the leaf type. Possible values are EMPTY_LEAF, DEFAULT_MODEL, ALL_ELEMENTS, ALL_NODES, and ALL_SURFACES.

class LeafFromSets(sets)[source]

Bases: Leaf

The LeafFromSets object can be used whenever a Leaf object is expected as an argument. Leaf objects are used to specify the items in a display group. Leaf objects are constructed as temporary objects, which are then used as arguments to DisplayGroup commands. The LeafFromSets object is derived from the Leaf object.

Note

This object can be accessed by:

import displayGroupMdbToolset

Note

Check LeafFromSets on help.3ds.com/2023.

This method creates a Leaf object from a sequence of Set objects.

Note

This function can be accessed by:

LeafFromSets

Parameters:: sets (Sequence[Set]) – A sequence of Set objects.
Returns:: A LeafFromSets object.
Return type:: LeafFromSets

Member Details:

leafType: SymbolicConstant[source]: A SymbolicConstant specifying the leaf type. Possible values are EMPTY_LEAF, DEFAULT_MODEL, ALL_ELEMENTS, ALL_NODES, and ALL_SURFACES.

class LeafFromSurfaceSets(surfaceSets)[source]

Bases: Leaf

The LeafFromSurfaceSets object can be used whenever a Leaf object is expected as an argument. Leaf objects are used to specify the items in a display group. Leaf objects are constructed as temporary objects, which are then used as arguments to DisplayGroup commands. The LeafFromSurfaceSets object is derived from the Leaf object.

Note

This object can be accessed by:

import displayGroupOdbToolset

Note

Check LeafFromSurfaceSets on help.3ds.com/2023.

This method creates a Leaf object from a sequence of surface sets.

Note

This function can be accessed by:

LeafFromSurfaceSets

Parameters:: surfaceSets (tuple) – A sequence of Strings specifying surface sets, or a String specifying a single surface set.
Returns:: A LeafFromSurfaceSets object.
Return type:: LeafFromSurfaceSets

Member Details:

leafType: SymbolicConstant[source]: A SymbolicConstant specifying the leaf type. Possible values are EMPTY_LEAF, DEFAULT_MODEL, ALL_ELEMENTS, ALL_NODES, and ALL_SURFACES.

surfaceSets: tuple[source]: A sequence of Strings specifying surface sets, or a String specifying a single surface set.

class LeafFromSurfaceVarRange(minimumRange=None, maximumRange=3, insideRange=1)[source]

Bases: Leaf

The LeafFromSurfaceVarRange object can be used whenever a Leaf object is expected as an argument. Leaf objects are used to specify the items in a display group. Leaf objects are constructed as temporary objects, which are then used as arguments to DisplayGroup commands. The LeafFromSurfaceVarRange object is derived from the Leaf object.

Note

This object can be accessed by:

import displayGroupOdbToolset

Note

Check LeafFromSurfaceVarRange on help.3ds.com/2023.

This method creates a Leaf object from surfaces with values lying in a variable range.

Note

This function can be accessed by:

LeafFromSurfaceVarRange

Parameters:

minimumRange (Optional[float], default: None) – A Float specifying the minimum value for the variable range. The default value is −3.40282346639E38.
maximumRange (float, default: 3) – A Float specifying the maximum value for the variable range. The default value is 3.40282346639e+038.
insideRange (Union[AbaqusBoolean, bool], default: 1) – A Boolean specifying the method used to evaluate the range. If insideRange = ON, the range falls inside the specified minimum and maximum values. The default value is ON.

Returns:

A LeafFromSurfaceVarRange object.

Return type:

LeafFromSurfaceVarRange

Member Details:

insideRange: Union[AbaqusBoolean, bool] = 1[source]: A Boolean specifying the method used to evaluate the range. If insideRange = ON, the range falls inside the specified minimum and maximum values. The default value is ON.

leafType: SymbolicConstant[source]: A SymbolicConstant specifying the leaf type. Possible values are EMPTY_LEAF, DEFAULT_MODEL, ALL_ELEMENTS, ALL_NODES, and ALL_SURFACES.

maximumRange: float = 3[source]: A Float specifying the maximum value for the variable range. The default value is 3.40282346639e+038.

minimumRange: Optional[float] = None[source]: A Float specifying the minimum value for the variable range. The default value is −3.40282346639E38.