from abaqusConstants import *
from .Vertex import Vertex
[docs]class VertexArray:
"""The VertexArray is a sequence of ConstrainedSketchVertex objects. If the part is modified, then
VertexArray must be updated for that part.
Notes
-----
This object can be accessed by:
.. code-block:: python
import part
mdb.models[name].parts[name].allInternalSets[name].vertices
mdb.models[name].parts[name].allSets[name].vertices
mdb.models[name].parts[name].sets[name].vertices
mdb.models[name].parts[name].vertices
import assembly
mdb.models[name].rootAssembly.allInstances[name].sets[name].vertices
mdb.models[name].rootAssembly.allInstances[name].vertices
mdb.models[name].rootAssembly.allInternalSets[name].vertices
mdb.models[name].rootAssembly.allSets[name].vertices
mdb.models[name].rootAssembly.instances[name].sets[name].vertices
mdb.models[name].rootAssembly.instances[name].vertices
mdb.models[name].rootAssembly.modelInstances[i].sets[name].vertices
mdb.models[name].rootAssembly.modelInstances[i].vertices
mdb.models[name].rootAssembly.sets[name].vertices
mdb.models[name].rootAssembly.vertices
"""
def __init__(self, vertices: list[Vertex]):
"""This method creates a VertexArray object.
Notes
-----
This function can be accessed by:
.. code-block:: python
part.VertexArray
Parameters
----------
vertices
A list of ConstrainedSketchVertex objects.
Returns
-------
A VertexArray object.
"""
pass
[docs] def findAt(self, coordinates: tuple, printWarning: Boolean = True):
"""This method returns the object or objects in the VertexArray located at the given
coordinates.
findAt initially uses the ACIS tolerance of 1E-6. As a result, findAt returns any ConstrainedSketchVertex
object that is at the arbitrary point specified or at a distance of less than 1E-6 from
the arbitrary point. If nothing is found, findAt uses the tolerance for imprecise
geometry (applicable only for imprecise geometric entities).
findAt will always try to find objects among all the vertices in the part or assembly
instance and will not restrict itself to a subset even if the VertexArray represents
such subset.
Parameters
----------
coordinates
A sequence of Floats specifying the *X*-, *Y*-, and *Z*-coordinates of the object to
find.findAt returns either a ConstrainedSketchVertex object or a sequence of ConstrainedSketchVertex objects based on the
type of input.If *coordinates* is a sequence of Floats, findAt returns the ConstrainedSketchVertex object
at that point.If you omit the *coordinates* keyword argument, findAt accepts as
arguments a sequence of sequence of floats in the following format:`verts =
v.findAt(((20.19686, -169.513997, 27.798593), ), ((19.657627,
-167.295749, 27.056402), ), ((18.274129, -157.144741, 25.15218), ))`
printWarning
A Boolean specifying whether a message is to be printed to the CLI if no entity is found
at the specified location. The default value is True.
Returns
-------
A ConstrainedSketchVertex object or a sequence of ConstrainedSketchVertex objects..
"""
pass
[docs] def getSequenceFromMask(self, mask: str):
"""This method returns the object or objects in the VertexArray identified using the
specified *mask*. This command is generated when the JournalOptions are set to
COMPRESSEDINDEX. When a large number of objects are involved, this method is highly
efficient.
Parameters
----------
mask
A String specifying the object or objects.
Returns
-------
A ConstrainedSketchVertex object or a sequence of ConstrainedSketchVertex objects..
"""
pass
[docs] def getMask(self):
"""This method returns a string specifying the object or objects.
Returns
-------
A String specifying the object or objects.
"""
pass
[docs] def getByBoundingBox(self, xMin: str = '', yMin: str = '', zMin: str = '', xMax: str = '', yMax: str = '',
zMax: str = ''):
"""This method returns an array of vertex objects that lie within the specified bounding
box.
Parameters
----------
xMin
A float specifying the minimum *X*-boundary of the bounding box.
yMin
A float specifying the minimum *Y*-boundary of the bounding box.
zMin
A float specifying the minimum *Z*-boundary of the bounding box.
xMax
A float specifying the maximum *X*-boundary of the bounding box.
yMax
A float specifying the maximum *Y*-boundary of the bounding box.
zMax
A float specifying the maximum *Z*-boundary of the bounding box.
Returns
-------
A VertexArray object, which is a sequence of ConstrainedSketchVertex objects..
"""
pass
[docs] def getByBoundingCylinder(self, center1: tuple, center2: tuple, radius: str):
"""This method returns an array of vertex objects that lie within the specified bounding
cylinder.
Parameters
----------
center1
A tuple of the *X*-, *Y*-, and *Z*-coordinates of the center of the first end of the
cylinder.
center2
A tuple of the *X*-, *Y*-, and *Z*-coordinates of the center of the second end of the
cylinder.
radius
A float specifying the radius of the cylinder.
Returns
-------
A VertexArray object, which is a sequence of ConstrainedSketchVertex objects..
"""
pass
[docs] def getByBoundingSphere(self, center: tuple, radius: str):
"""This method returns an array of vertex objects that lie within the specified bounding
sphere.
Parameters
----------
center
A tuple of the *X*-, *Y*-, and *Z*-coordinates of the center of the sphere.
radius
A float specifying the radius of the sphere.
Returns
-------
A VertexArray object, which is a sequence of ConstrainedSketchVertex objects..
"""
pass
[docs] def getBoundingBox(self):
"""This method returns a dictionary of two tuples representing minimum and maximum boundary
values of the bounding box of the minimum size containing the vertex sequence.
Returns
-------
A Dictionary object with the following items:
*low*: a tuple of three floats representing the minimum *X*-, *Y*-, and *Z*-boundary
values of the bounding box.
*high*: a tuple of three floats representing the maximum *X*-, *Y*-, and *Z*-boundary
values of the bounding box.
"""
pass
[docs] def getClosest(self, coordinates: tuple, searchTolerance: str = ''):
"""This method returns a object or objects in the VertexArray closest to the given set of
points, where the given points need not lie on ConstrainedSketchVertex objects in the VertexArray.
Parameters
----------
coordinates
A sequence of a sequence of floats, where each sequence of floats describes the *X*-,
*Y*-, and *Z*-coordinates of a
point.`r=v.getClosest(coordinates=((20.0,20.0,10.0),(-1.0, -15.0, 15),))``r.keys()``[0,
1]``r[0]``(mdb.models['Model-1'].parts['Part-1'].vertices[0], (15.7090625762939,
29.1666641235352, 20.0))`
searchTolerance
A double specifying the distance within which the closest object must lie. The default
value is half of the parent part/instance size.
Returns
-------
This method returns a dictionary object. The key to the dictionary object is the
position of the input point in the tuple specified in the *coordinates* starting at
index 0. If a closest vertex could be found then the value is a sequence consisting of
two objects. The first object in the sequence is a ConstrainedSketchVertex that is close to the input
point referred to by the key. The second object in the sequence is a sequence of floats
that specifies the *X*-, *Y*-, and *Z*-location of the ConstrainedSketchVertex. See program listing
above.
Raises
------
- An exception occurs if the resulting sequence is empty.
Error: The mask results in an empty sequence
"""
pass