Graphic

Class FileGraphic()

FileGraphic(parent='MODEL', name='FileGraphic_n', 
label='FileGraphic_n', active=True, wire_mode='OFF', shade_mode='USE_MATERIAL', is_material_inside=True, 
refinement_level=3, body=None, filename='', reader='', avail_comp_list=[], sel_comp_list=[], 
mesh_coarsening_level='NONE', align_meth1='MARKER', align_b1=None, 
align_mrk1='Global_Frame', align_p1=None, align_p2=None, align_p3=None, origin_x=0, 
origin_y=0, origin_z=0, psi=0, theta=0, phi=0, scale_x=1, scale_y=1, scale_z=1)

Graphic defined in a file.

Keyword Arguments

Instances

Notes

Instance is a reference to an entity. You cannot modify an instance, but can modify its properties.

Methods

setValue(name, value, updatePanel=True)

Sets value of an attribute.

Parameters:

name	str	Name of the attribute.
value	**	Value of the attribute to be set.

Returns:

Returns True if the value was successfully set, else False.

Return type:

Bool

Examples

========
Create and modify attributes of a File graphic.
>>> from hw import mview
>>> f1 = mview.FileGraphic(name = 'f1')
>>> #Select the file and components from it
>>> f1.filename = r"C:\Users\user\Desktop\graphic.h3d"
>>> f1.sel_comp_list = ["Part2","Part9"]
>>> f1.body = mview.getModel().B_Ground
>>> #GEt values of attributes
>>> f1.mesh_coarsening_level
'NONE'
>>> #Set multiple values at once (location properties here)
>>> c1.setValues(origin_x = 10,theta = 3.14,scale_z = 1.5)
>>> f1.mesh_coarsening_level = 'Conservative'
>>> e1.color_mat = "mat_green"
>>> #Change alignment method
>>> f1.align_meth1 = 'PART'

Class CADGraphic()

CADGraphic(parent='MODEL', name='CADGraphic_n', label='CADGraphic_n', active=True, 
wire_mode='OFF', shade_mode='USE_MATERIAL', is_material_inside=True, body=None, filename='', 
avail_comp_list=[], sel_comp_list=[], align_meth1='MARKER', align_b1=None, 
align_mrk1='Global_Frame', origin_x=0, origin_y=0, origin_z=0, psi=0, theta=0, phi=0, 
scale_x=1, scale_y=1, scale_z=1)

The CAD graphic.

Keyword Arguments

Instances

Readonly Properties:

Notes

1. The parent parameter can only be initialized by the constructor and should not be modified directly.

2. Only parent can be used as a positional argument in the constructor.

3. Instance is a reference to an entity. You cannot modify an instance, but can modify its properties.

4. Readonly Properties cannot be modified.

Methods

setValue(name, value)

Sets value of an attribute.

Parameters:

name	str	Name of the attribute.
value	**	Value of the attribute to be set.

Returns:

Returns True if the value was successfully set else False.

Return type:

Bool

Examples

========
Create and modify attributes of a CAD graphic.
>>> from hw import mview
>>> c1 = mview.CADGraphic(name = 'cad1')
>>> c1.filename = r"C:\Users\user\Desktop\cadfile.step"
>>> c1.sel_comp_list = ["Part1","Part3"]
>>> #Set material property of graphic
>>> c1.materialprop = "propmat_aluminum"
>>> c1.color_mat = "mat_purple"
>>> #Set multiple values at once (location properties here)
>>> c1.setValues(origin_x = 10,theta = 3.14,scale_z = 1.5)
>>> #Set graphic alignment
>>> m1 = mview.Marker(name = 'align')
>>> c1.align_mrk1 = m1
>>> #Set mesh coarseness
>>> c1.fidelity = 7
>>> #Change alignment method
>>> c1.align_meth1 = 'PART'
>>> c1.align_b1 = 'B_Ground'

Class Box()

Box(parent='MODEL', name='Box_n', label='Box_n', active=True, itype='FACE', 
lenghtx=10, lengthy=10, body=None, origin=None, origin2=None, ornt_meth='TWOAXES', ornt_dir1='Z', 
align_meth1='Point', align_pt1=None, align_vec1=None, ornt_dir2='X', align_meth2='Vector', 
align_pt2=None, align_vec2=None)

Create a Box graphic.

Keyword Arguments

Instances

Readonly Properties

Notes

1. The parent parameter can only be initialized by the constructor and should not be modified directly.

2. Only parent can be used as a positional argument in the constructor.

3. Instance is a reference to an entity. You cannot modify an instance, but can modify its properties.

4. Readonly Properties cannot be modified.

Examples

========
Create and modify attributes of a Box graphic.
>>> from hw import mview
>>> bx1 = mview.Box(name = 'Box1')
>>> #Set references for Box graphic
>>> b1 = mview.Body(label = 'BodyForGraphic')
>>> bx1.body = b1
>>> bx1.origin = mview.getModel().P_Global_Origin
>>>#Change the input type of Box
>>> bx1.itype = 'CORNER'
>>> #Get attribute values
>>> bx1.ornt_dir1
'Z'
>>> #Set multiple values at once
>>> bx1.setValues(ornt_dir1 = 'X',align_meth1 = 'VECTOR',lengthz = 5)
>>> bx1.align_vec1 = 'V_Global_X'
>>> bx1.ornt_dir2 = 'Z'
>>> #Get and set material property of BoxPair Graphic
>>> bx1.materialprop.name
'propmat_steel'
>>> bx1.materialprop = "propmat_bronze"
>>> e1.color_mat = "mat_green"
>>> bx1.refinement_level = 5
>>> #Create a BoxPair inside a System and set dimensions
>>> sys = mview.System(name = 'System1')
>>> bx2 = mview.BoxPair(parent = sys,itype = 'CENTER')
>>> bx2.itype = 'CENTER'
>>> bx2.body = b1
>>> p1 = mview.PointPair(y = 100)
>>> bx2.origin = p1
>>> bx2.align_meth1='VECTOR'
>>> bx2.align_vec1 = 'V_Global_X'
>>> bx2.l.lengthx = 30
>>> #Set parametric value
>>> bx2.l.lengthz = "Box1.r1+10"
>>> #Change input type of BoxPair
>>> bx2.itype = 'FACE'
>>> bx2.l.origin2 = 'P_Global_Origin'

Class BoxPair()

BoxPair(parent='MODEL', name='BoxPair_n', label='BoxPair_n', active=True, sym='NONE')

Box pair containing left and right instances of singles.

Keyword Arguments:

Instances

Notes

Instance is a reference to an entity. You cannot modify an instance, but can modify its properties.

Class Sphere()

Sphere(parent='MODEL', name='Sphere_n', label='Sphere_n', active=True, 
body=None, origin=None, radius=10)

The sphere graphic.

Keyword Arguments:

Instances

Readonly Properties:

Notes

1. The parent parameter can only be initialized by the constructor and should not be modified directly.

2. Only parent can be used as a positional argument in the constructor.

3. Instance is a reference to an entity. You cannot modify an instance, but can modify its properties.

4. Read only Properties cannot be modified.

Examples

========
Create and modify attributes of a Sphere graphic.
>>> from hw import mview
>>> s1 = mview.Sphere(name='s1')
>>> b1 = mview.Body(name='b1',mass=10)
>>> #Set multiple values at once
>>> s1.setValues(body=b1,origin='P_Global_Origin')
>>> #Get and set values of attributes
>>> s1.radius
10.0
>>> s1.radius = 25
>>> e1.color_mat = "mat_red"
>>> e2.materialprop = "propmat_titanium"
>>> #Create a SpherePair in System and set properties
>>> sys = mview.System(name='sys')
>>> s2 = mview.SpherePair(parent=sys,name='s2')
>>> p2 = mview.PointPair(parent=sys,y=25)
>>> s2.body = 'B_Ground'
>>> s2.origin = p2
>>> #Set parametric value
>>> s2.radius = "MODEL.s1.radius/2"

Class SpherePair()

SpherePair(parent='MODEL', name='SpherePair_n', label='SpherePair_n', active=True, sym='NONE')

Sphere pair containing left and right instances of singles.

Keyword Arguments:

Instances

Notes

Instance is a reference to an entity. You cannot modify an instance, but can modify its properties.

Class Cylinder()

Cylinder(parent='MODEL', name='Cylinder_n', label='Cylinder_n', active=True, body=None, 
origin=None, align_meth1='Point', align_pt1=None, align_vec1=None, r1=10, r2=10, length=0, 
offset=0, useautolen=True, cap_flag='CAPBOTH')

Cylinder graphic.

Keyword Arguments

Instances

Readonly Properties:

Notes

1. The parent parameter can only be initialized by the constructor and should not be modified directly.

2. Only parent can be used as a positional argument in the constructor.

3. Instance is a reference to an entity. You cannot modify an instance, but can modify its properties.

4. Readonly Properties cannot be modified.

Examples

========
Create and modify attributes of a Cylinder graphic.
>>> from hw import mview
>>> c1 = mview.Cylinder(name='c1')
>>> #Set cylinder graphic references
>>> b1 = mview.Body(name='BodyForGraphic')
>>> c1.body = b1
>>> c1.origin = 'P_Global_Origin'
>>> c1.color_mat = "mat_red"
>>> #Get values of attributes
>>> c1.align_meth1
'Point'
>>> #Set alignment properties of graphic
>>> c1.align_meth1 = 'VECTOR'
>>> c1.align_vec1 = mview.getModel().V_Global_X
>>> #Create a CylinderPair inside a System and set properties
>>> sys = mview.System(name = 'System1')
>>> c2 = mview.CylinderPair(parent=sys,name='c2')
>>> #Set multiple values at once
>>> c2.setValues(body=b1,origin='P_Global_Origin')
>>> sys2 = mview.System(name = 'System2')
>>> p1 = mview.Point(parent='System2',name='p_1',label='PointForAlignment')
>>> c2.align_pt1 = getModel().System2.p_1
>>> p1 = mview.PointPair(label='PointForAlignment',y=100)
>>> c2.origin = p1
>>> c2.align_pt1 = 'P_Global_Origin'
>>> c2.materialprop = "propmat_copper"
>>> e1.color_mat = "mat_yellow"
>>> c2.refinement_level = 5
>>> #Set cylinder dimensions
>>> c2.l.autolen = False
>>> c2.l.length = 70
>>> c2.l.r1 = 25
>>> #Set parametric values
>>> c2.l.r2 = "c1.r1*1.5"

Class CylinderPair()

CylinderPair(parent='MODEL', name='CylinderPair_n', label='CylinderPair_n', 
active=True, sym='NONE')

Cylinder pair containing left and right instances of singles.

Keyword Arguments

Instances

Notes

Instance is a reference to an entity. You cannot modify an instance, but can modify its properties.

Class Ellipsoid()

Ellipsoid(parent='MODEL', name='Ellipsoid_n', label='Ellipsoid_n', active=True, body=None, 
origin=None, ornt_meth='TWOAXES', ornt_dir1='Z', align_meth1='POINT', align_pt1=None, 
align_vec1=None, ornt_dir2='X', align_meth2='VECTOR', align_pt2=None, align_vec2=None, 
rX=10, rY=5, rZ=2.5)

Ellipsoid graphic.

Keyword Arguments

Instances

Readonly Properties

Notes

1. The parent parameter can only be initialized by the constructor and should not be modified directly.

2. Only parent can be used as a positional argument in the constructor.

3. Instance is a reference to an entity. You cannot modify an instance, but can modify its properties.

4. Readonly Properties cannot be modified.

Examples

========
Create and modify attributes of an Ellipsoid graphic.
>>> from hw import mview
>>> e1 = mview.Ellipsoid(name = 'e1')
>>> p1 = mview.Point(name = "p_1")
>>> #Set multiple values at once
>>> e1.setValues(body = 'B_Ground',origin = p1)
>>> e1.align_pt1 = 'P_Global_Origin'
>>> e1.color_mat = "mat_green"
>>> e1.rX = 20
>>> e1.rY = 12
>>> #Create and modify an EllipsoidPair in an Analysis
>>> a1 = mview.Analysis(active = True)
>>> e2 = mview.EllipsoidPair(parent = a1,name = 'e2')
>>> e2.setValues(body = 'B_Ground',align_pt1 = 'P_Global_Origin')
>>> p2 = mview.PointPair(parent = a1,name = "p_2",y = 50)
>>> e2.origin = p2
>>> e2.ornt_dir1 = 'X'
>>> e2.ornt_dir2 = 'Y'
>>> e2.materialprop = "propmat_bronze"
>>> e2.refinement_level = 5
>>> #Set parametric values
>>> e2.rZ = "p_2.l.y-25"

Class EllipsoidPair()

EllipsoidPair(parent='MODEL', name='EllipsoidPair_n', label='EllipsoidPair_n', 
active=True, sym='NONE')

Ellipsoid pair containing left and right instances of singles.

Keyword Arguments

Instances

Notes

Instance is a reference to an entity. You cannot modify an instance, but can modify its properties.

Class Outline()

class Outline(parent='MODEL', name='Outline_n', label='Outline_n', active=True, wire_mode='OFF', 
shade_mode='USE_MATERIAL', is_material_inside=True, refinement_level=3, itype='MARKER', 
markers=None, bodies=None, points=None, pbeam=None, advjoint=None, marker='Global_Frame', body=None)

Outline graphic.

Keyword Arguments

Instances

Notes

1. The parent parameter can only be initialized by the constructor and should not be modified directly.

2. Only parent can be used as a positional argument in the constructor.

3. Instance is a reference to an entity. You cannot modify an instance, but can modify its properties.

4. Readonly Properties cannot be modified.

Methods

getBody()

Get the body that this graphic is for: MARKER - first

marker body BODYPT - first body POLYBEAM - first

beam body (body0) ADV_JOINT_CRV - b1

Examples

========
Create and modify attributes of an Outline graphic.
>>> from hw import mview
>>> o1 = mview.Outline(name='o1',itype = 'MARKER')
>>> #Creating a number of markers and points with different coordinates
>>> for i in range(5):
... m = mview.Marker()
>>> for i in range(5):
... p = mview.Point(x = i, y = 2*i)
>>> allmarkers = mview.getModel().getChildren(type = 'Marker')
>>> allpoints = mview.getModel().getChildren(type = 'Point')
>>> #Setting all points as origins to all markers
>>> for i in range(len(allmarkers)):
... allmarkers[i].origin = allpoints[i]
>>> #Using the newly created markers as reference for Outline graphic
>>> o1.markers = allmarkers
>>> #Chaning the input type for the Outline graphic
>>> o1.itype = 'BODYPT'
>>> for i in range(5):
... b = mview.Body()
>>> allbodies = mview.getModel().getChildren(type='Body')
>>> #Set multiple values as once
>>> o1.setValues(bodies = allbodies,points = allpoints)
>>> #Changing input type for the Outline graphic
>>> o1.itype = 'POLYBEAM'
>>> poly = mview.PolyBeam()
>>> o1.pbeam = poly
>>> #Changing input type for the Outline graphic
>>> o1.itype = 'ADV_JOINT_CRV'
>>> adv = mview.AdvJoint()
>>> o1.advjoint = adv

Class CurveGraphic()

CurveGraphic(parent='MODEL', name='CurveGraphic_n', label='CurveGraphic_n', active=True, 
wire_mode='OFF', shade_mode='USE_MATERIAL', is_material_inside=True, refinement_level=3, 
ptype='BODYPT', ref_marker='Global_Frame', body='B_Ground', origin='P_Global_Origin', crv=None)

Curve graphic.

Keyword Arguments

Instances

Notes

1. The parent parameter can only be initialized by the constructor and should not be modified directly.

2. Only parent can be used as a positional argument in the constructor.

3. Instance is a reference to an entity. You cannot modify an instance, but can modify its properties.

4. Readonly Properties cannot be modified.

Methods

getBody()

If the graphic is using markers, get the body from the first marker otherwise, get return the body.

setValue(name, value)

Sets value of an attribute.

Parameters:

name	str	Name of the attribute.
value	**	Value of the attribute to be set.

Returns:

Returns True if the value was successfully set else False.

Return type:

Bool

Class Tube()

Tube(parent='MODEL', name='Tube_n', label='Tube_n', active=True, wire_mode='OFF', 
shade_mode='USE_MATERIAL', is_material_inside=True, refinement_level=3, pbeam=None)

Tube graphic.

Keyword Arguments

Instances

Readonly Properties:

Notes

1. The parent parameter can only be initialized by the constructor and should not be modified directly.

2. Only parent can be used as a positional argument in the constructor.

3. Instance is a reference to an entity. You cannot modify an instance, but can modify its properties.

4. Readonly Properties cannot be modified.

Methods

getBody()

Get the body that this graphic is for.

Returns:

Returns the body associated with this graphic.

Return type:

Body

Class SpringGraphic()

SpringGraphic(parent='MODEL', name='SpringGraphic_n', label='SpringGraphic_n', active=True, 
wire_mode='OFF', shade_mode='USE_MATERIAL', is_material_inside=True, refinement_level=3, 
spdp=None, p1=None, p2=None, radiys=5, num_coils=10)

Spring graphic.

Keyword Arguments

Instances

Notes

1. The parent parameter can only be initialized by the constructor and should not be modified directly.

2. Only parent can be used as a positional argument in the constructor.

3. Instance is a reference to an entity. You cannot modify an instance, but can modify its properties.

Methods

getAssociatedObjects()

Get the body and the spring damper associated with this spring graphic.

Returns:

A list of body and spring damper associated with this spring graphic.

Return type:

list

getBody()

Get the b1 used by the spring damper associated with this spring graphic.

Returns:

Body(b1) associated with the spring damper of this spring graphic.

Return type:

body (Body)

Examples

========
Create and modify attributes of a Spring graphic.
>>> from hw import mview
>>> sg = mview.SpringGraphic(name = 'sg1')
>>> p1 = mview.Point(name = 'startpoint', x = 60)
>>> #Create a SpringDamper for the graphic
>>> spdp = mview.SpringDamper(name = 'spdp')
>>> #Set the attributes for the SpringGraphic
>>> sg.spdp = spdp
>>> sg.p1 = p1
>>> sg.p2 = 'P_Global_Origin'
>>> #Set multiple values at once
>>> sg.setValues(radius = 4,num_coils = 20)
>>> sg.color_mat = "mat_goldenrod5"
>>> #Creating SpringGraphic paired object
>>> sg2 = mview.SpringGraphicPair(name='sg2')
>>> spdp2 = mview.SpringDamperPair(name='spdp2')
>>> sg2.spdp = spdp2
>>> p_start = mview.PointPair(y = 50)
>>> p_end = mview.PointPair(x = 100, y = 50)
>>> sg2.setValues(p1=p_start,p2=p_end)

Class SpringGraphicPair()

SpringGraphicPair(parent='MODEL', name='SpringGraphicPair_n', label='SpringGraphicPair_n', 
active=True, sym='NONE')

SpringGraphic pair containing left and right instances of singles.

Keyword Arguments

Instances

Notes

Instance is a reference to an entity. You cannot modify an instance, but can modify its properties.

Class Tire()

Tire(parent='MODEL', name='Tire_n', label='Tire_n', active=True, wire_mode='OFF', 
shade_mode='USE_MATERIAL', is_material_inside=True, refinement_level=3, tirespec='P215/70*15', 
body=None, origin=None, align_meth1='Point', align_p1=None, align_vec1=None)

Tire graphic.

Keyword Arguments

Instances

Notes

1. The parent parameter can only be initialized by the constructor and should not be modified directly.

2. Only parent can be used as a positional argument in the constructor.

3. Instance is a reference to an entity. You cannot modify an instance, but can modify its properties.

4. Readonly Properties cannot be modified.

Class TirePair()

TirePair(parent='MODEL', name='TirePair_n', label='TirePair_n', active=True, sym='NONE')

Tire pair containing left and right instances of singles.

Keyword Arguments

Instances

Notes

Instance is a reference to an entity. You cannot modify an instance, but can modify its properties.

Class DeformableCurveGraphic()

DeformableCurveGraphic(parent='MODEL', name='DeformableCurveGraphic_n', label='DeformableCurveGraphic_n', 
active=True, wire_mode='OFF', shade_mode='USE_MATERIAL', is_material_inside=True, refinement_level=3, 
defcurve=None, num_segs=100)

Deformable curve graphic.

Keyword Arguments

Instances

Notes

1. The parent parameter can only be initialized by the constructor and should not be modified directly.

2. Only parent can be used as a positional argument in the constructor.

3. Instance is a reference to an entity. You cannot modify an instance, but can modify its properties.

Methods

getAssociatedObjects()

Return the body and the deformable curve.

getBody()

If the selected DeformableCurve is using markers, return the body used by the first marker. If it is using bodies and points, return the first body.

Class DeformableSurfaceGraphic()

DeformableSurfaceGraphic(parent='MODEL', name='DeformableSurfaceGraphic_n', label='DeformableSurfaceGraphic_n', 
active=True, wire_mode='OFF', shade_mode='USE_MATERIAL', is_material_inside=True, refinement_level=3, 
defsurf=None, num_u_segs=100, num_v_segs=100)

Deformable surface graphic.

Keyword Arguments

Instances

Notes

1. The parent parameter can only be initialized by the constructor and should not be modified directly.

2. Only parent can be used as a positional argument in the constructor.

3. Instance is a reference to an entity. You cannot modify an instance, but can modify its properties.

Methods

getAssociatedObjects()

Return the body and the deformable surface.

getBody()

If the selected DeformableSurface is using markers, return the body used by the first marker. If it is using bodies and points, return the first body.

Class SurfaceGraphic()

SurfaceGraphic(parent='MODEL', name='SurfaceGraphic_n', label='SurfaceGraphic_n', active=True, 
wire_mode='OFF', shade_mode='USE_MATERIAL', is_material_inside=True, refinement_level=3, advjoint=None, 
surf_sel=None, num_u_segs=100, num_v_segs=100)

Surface graphic.

Keyword Arguments

Instances

Notes

1. The parent parameter can only be initialized by the constructor and should not be modified directly.

2. Only parent can be used as a positional argument in the constructor.

3. Instance is a reference to an entity. You cannot modify an instance, but can modify its properties.

Methods

getAssociatedObjects()

Return the body and the advanced joint.

getBody()

Get the body that this graphic is for from the selected advanced joints b1.

Examples

========
Create and modify attributes of a Surface graphic.
>>> from hw import mview
>>> s1 = mview.Surface()
>>> #For SolverMode = ADAMS
>>> h3dpath = r"C:\Users\user\Desktop\surfacefile.h3d"
>>> parasolid = r"C:\Users\user\Desktop\surfacefile.x_t"
>>> #If file is an H3D graphic file
>>> s1.graphic_file = h3dpath
>>> #Set multiple values at once (if file is a parasolid file)
>>> s1.setValues(parasolid_file = parasolid, use_parasolid_comp = True)
>>> s1.parasolid_comp = 'surf1'
>>> #Get values of attributes
>>> s1.vopen_closed
'VOPEN'
>>> s1.vopen_closed = 'VCLOSED'
>>> s1.uopen_closed = 'UOPEN'

Class GraphicSystem()

class GraphicSystem(**kwds)

A GraphicSystem is a type of System which can only contain graphic entities or other graphic systems.

Parameters

Variables

Methods

getAssociatedGraphics()

Get any graphics that are associated with this object.

Examples

========
Create and modify attributes of a Graphic system.
>>> from hw import mview
>>> gs = mview.GraphicSystem(name='gsys')
>>> #Create a body for the graphics
>>> b1 = mview.Body(name = 'b1',inertia_props_from_graphic = True)
>>> #Add attachment to the graphic system
>>> gs.addAttachment(name = 'att_body',type = 'Body',value = b1)
>>> #Create a child graphic entity for the graphic system
>>> bx1 = mview.Box(parent = gs,name = 'bx1',itype = 'CENTER')
>>> bx1.align_meth1 = 'VECTOR'
>>> bx1.align_vec1 = mview.getModel().V_Global_Z
>>> #Set multiple values at once (setting attachment as the reference here)
>>> bx1.setValues(body = "att_body",origin = "P_Global_Origin")
>>> #Get child object handles of GraphicSystem in a lists
>>> gs.getChildren()
[<hw.mview.mbd.System.Attachment object at 0x000002341F8EE5F8>, <hw.mview.mbd.Graphic.Box object at 0x000002341F8C2668>]