Advanced Joint

Class AdvJoint()

AdvJoint(parent='MODEL', name='AdvJoint_n', label='AdvJoint_n', active=True, type='PointToCurveJoint', 
b1=None, b2=None, origin=None, origin2=None, crv=None, crv1=None, crv2=None, surf=None, surf1=None, surf2=None, 
defcrv=None, defsurf=None, rm='Global_Frame', rm1='Global_Frame', rm2='Global_Frame', ic_use_icm=False, 
ic_use_icm1=True, ic_use_icm2=True, ic_use_xyz=False, ic_use_vel=False, ic_x_disp=0, ic_y_disp=0, ic_z_disp=0, 
ic_use_xyz1=False, ic_vel=0, ic_use_vel1=False, ic_x_disp1=0, ic_y_disp1=0, ic_z_disp1=0, ic_vel1=0, 
ic_use_xyz2=False, ic_use_vel2=False, ic_x_disp2=0, ic_y_disp2=0, ic_z_disp2=0, ic_vel2=0)

Create a PointToCurveJoint, CurveToCurveJoint, PointToSurfaceJoint, CurveToSurfaceJoint, SurfaceToSurfaceJoint, PointToDeformableCurveJoint, PointToDeformableSurfaceJoint.

Keyword Arguments

Argument Data Type Description Default
name String The variable name. AdvJoint_n, for next available integer n.
label String The descriptive label. AdvJoint_n, for next available integer n.
parent Object The parent. MODEL
active Boolean Used to activate or deactivate this entity. True
type Enum The type. One of: PointToCurveJoint, CurveToCurveJoint, PointToSurfaceJoint, CurveToSurfaceJoint, SurfaceToSurfaceJoint, PointToDeformableCurveJoint, PointToDeformableSurfaceJoint. PointToCurveJoint
b1 Body The first constrained body. None
b2 Body The second constrained body. None
origin Point The point on body one which is constrained to body two. None
origin2 Point The point. None
crv Curve The constrained curve when type is PointToCurveJoint. None
crv1 Curve The first constrained curve when type is CurveToCurveJoint. None
crv2 Curve The second constrained curve when type is CurveToCurveJoint. None
surf Surface The constrained surface when type is PointToSurfaceJoint. None
surf1 Surface The first constrained surface when type is SurfaceToSurfaceJoint. None
surf2 Surface The second constrained surface when type is SurfaceToSurfaceJoint. None
defcrv DeformableCurve The constrained deformable curve when type is PointToDeformableCurveJoint. None
defsurf DeformableSurface The constrained deformable surface when type is PointToDeformableSurfaceJoint. Defaults to None. * rm (Marker) - The reference marker for the curve and surface for type PointToCurveJoint or PointToSurfaceJoint respectively. Global_Frame
rm1 Marker The reference marker for first entity for type CurveToCurveJoint, CurveToSurfaceJoint or SurfaceToSurfaceJoint. Global_Frame
rm2 Marker The reference marker for second entity for type CurveToCurveJoint, CurveToSurfaceJoint or SurfaceToSurfaceJoint. Global_Frame
ic_use_icm Bool Use initial condition marker for curve and surface for type PointToCurveJoint or PointToSurfaceJoint respectively when True. If False, initial condition information is defined with respect to the reference marker. False
ic_use_icm1 Bool Use initial condition marker for first entity for type CurveToCurveJoint, CurveToSurfaceJoint or SurfaceToSurfaceJoint. when True. If False, initial condition information is defined with respect to the reference marker. True
ic_use_icm2 Bool Use initial condition marker for second entity for type CurveToCurveJoint, CurveToSurfaceJoint or SurfaceToSurfaceJoint when True. If False, initial condition information is defined with respect to the reference marker. True
ic_use_xyz Bool Denotes if the displacement initial conditions are to be used for the entity for type PointToCurveJoint or PointToSurfaceJoint. False
ic_use_vel Bool Denotes if the velocity initial conditions are to be used for the point for type PointToCurveJoint or PointToSurfaceJoint. False
ic_x_disp Double The value of the initial displacement of the contact point in the icm_1 x direction. 0
ic_y_disp Double The value of the initial displacement of the contact point in the icm_1 y direction. 0
ic_z_disp Double The value of the initial displacement of the contact point in the icm_1 z direction. 0
ic_vel Double The value of the initial velocity of point for type PointToCurveJoint or PointToSurfaceJoint. 0
ic_use_xyz1 Bool Denotes if the displacement initial conditions are to be used for the entity 1 for type CurveToCurveJoint, CurveToSurfaceJoint or SurfaceToSurfaceJoint. False
ic_use_vel1 Bool Denotes if the velocity initial conditions are to be used for the contact point o body1 for type CurveToCurveJoint. False
ic_x_disp1 Double The value of the initial displacement of the point of contact in the icm x direction on the curve for type CurveToCurveJoint, CurveToSurfaceJoint or SurfaceToSurfaceJoint. 0
ic_y_disp1 Double The value of the initial displacement of the point of contact in the icm y direction on the curve for type CurveToCurveJoint, CurveToSurfaceJoint or SurfaceToSurfaceJoint. 0
ic_z_disp1 Double The value of the initial displacement of the point of contact in the icm z direction on the curve for type CurveToCurveJoint, CurveToSurfaceJoint or SurfaceToSurfaceJoint. 0
ic_vel1 Double The value of the initial velocity of the point of contact on body 1. Applicable for type CurveToCurveJoint. 0
ic_use_xyz2 Bool Denotes if the displacement initial conditions are to be used for the contact point on body_2. False
ic_use_vel2 Bool Denotes if the velocity initial conditions are to be used for the contact point on body_2. False
ic_x_disp2 Double The value of the initial displacement of the point of contact in the icm x direction on the curve/surface for type CurveToCurveJoint, CurveToSurfaceJoint or SurfaceToSurfaceJoint. 0
ic_y_disp2 Double The value of the initial displacement of the point of contact in the icm y direction on the curve/surface for type CurveToCurveJoint, CurveToSurfaceJoint or SurfaceToSurfaceJoint. 0
ic_z_disp2 Double The value of the initial displacement of the point of contact in the icm z direction on the curve/surface for type CurveToCurveJoint, CurveToSurfaceJoint or SurfaceToSurfaceJoint. 0
ic_vel2 Double The value of the initial velocity of the point of contact on body 2. Applicable for type CurveToCurveJoint. 0

Instances

Instance Type Description
icm Marker Initial condition information is defined with respect to this marker when ic_use_icm is True. Applicable for type PointToCurveJoint or PointToSurfaceJoint.
icm1 Marker Initial condition information is defined with respect to this marker for first entity in the joint when ic_use_icm1 is True. Applicable for type CurveToCurveJoint, CurveToSurfaceJoint or SurfaceToSurfaceJoint.
icm2 Marker Initial condition information is defined with respect to this marker for second entity in the joint when ic_use_icm2 is True. Applicable for type CurveToCurveJoint, CurveToSurfaceJoint or SurfaceToSurfaceJoint.
i Marker The 'i' marker in the case of a compliant joint.
j Marker The 'j' marker in the case of a compliant joint.

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

getAssociatedGraphics()

Get all the graphics that are associated with this object.

Returns:

List of all graphic associated with this joint.

Return type:

(list)