joints

Unless otherwise specified, data names are accessible in level 3 only.

activesuppressed
Returns non-zero if the entity is set inactive, 0 otherwise.
Type: integer
allowlimits
Allows setting limits to the joint if set to True.
Type: Boolean
attributesmax
The number of attributes owned by this entity.
Type: unsigned integer
body1
The joint that connects this body to body2 and body3 (body3 only for double slider).
Type: entity
body2
The joint that connects this body to body1 and body3 (body3 only for double slider).
Type: entity
body3
The joint that connects this body to body1 and body2 (available only for double slider).
Type: entity
color
The 1-64 color of the entity.
Type: integer
color_rgb
The RGB color of the entity.
Type: string
config
The configuration of the entity.
11 - Ball (rotation around 3 axes allowed)
12 - Cylinder (rotation around z-axis and translation along z-axis)
15 - Revolute (rotation around z-axis allowed)
16 - Slider (translation along z-axis allowed)
18 - Double slider (translation along z-axis allowed for three bodies)
Type: unsigned integer
definedentity
True if the entity is defined, false otherwise.
Type: Boolean
factor1
The factor for motion of body3 with respect to body1 (for double slider only) (double 0 ≤ factor1 ≤ 1 ).
A higher value means body3 is more inclined to move with body1, while a lower value means body3 is more inclined to move with body2.
factor2
Always (1-factor1) (double 0 ≤ factor2 ≤ 1 ).
A higher value means body3 is more inclined to move with body2, while a lower value means body3 is more inclined to move with body1. Valid for hm_getvalue query only.
id
The ID of the entity.
Type: unsigned integer
include
The ID of the include file the entity is organized in.
Type: entity
includeid
The ID of the include file the entity is organized in.
Type: unsigned integer
internalid
The ID of the entity.
Type: unsigned integer
joint_triplelist
Ordered list of coordinates defining the path for cam joint.
Type: triple double array
lockingoption
The lock option for the joint.
  • 1 - Allow unlocking the joint
  • 2 - Allow locking the joint
  • 3 - Allow locking and unlocking of individual DOFs of the joint
Type: unsigned int.
moduleid
The module ID of the entity.
Type: integer
name
The name of the entity.
Type: string
node_n1
Node defining the origin of the joint.
Type: entity
node_n2
Node defining the z-axis of the joint.
Type: entity
node_n3
Node defining the x-axis of the joint.
Type: entity
nodepath
Ordered list of nodes defining the path for cam joint.
Type: entity array
nodepathcount
Returns number of nodes in nodepath.
Type: unsigned integer
outputsuppressed
Returns non-zero if the entity is set "do not export", 0 otherwise.
Type: integer
perpdistance
The perpendicular distance between origin and path for cam joint.
Type: double
poolid
The pool number of the entity.
Type: integer
poolname
The pool name of the entity.
Type: string
position
The coordinates of the origin of the joint.
Type: triple double
primaryaxis
The local z-axis of the joint.
Type: triple double
rot1lock
The lock state of the joint rotation around the x-axis (only available if locking option is 3 for ball joint).
Type: Boolean
rot1lower
The lower limit flag for joint rotation around the x-axis.
Type: Boolean
rot1lowervalue
The lower limit for joint rotation around the x-axis.
Type: double
rot1upper
The upper limit flag for joint rotation around the x-axis.
Type: Boolean
rot1uppervalue
The upper limit for joint rotation around the x-axis.
Type: double
rot1val
The current angle of the joint for the x-axis.
Type: double
rot2lock
The lock state of the joint rotation around the y-axis (only available if locking option is 3 for ball joint).
Type: Boolean
rot2lower
The lower limit flag for joint rotation around the y-axis.
Type: Boolean
rot2lowervalue
The lower limit for joint rotation around the y-axis.
Type: double
rot2upper
The upper limit flag for joint rotation around the y-axis.
Type: Boolean
rot2uppervalue
The upper limit for joint rotation around the y-axis.
Type: double
rot2val
The current angle of the joint for the y-axis.
Type: double
rot3lock
The lock state of the joint rotation around the z-axis (only available if locking option is 3 for ball joint).
Type: Boolean
rot3lower
The lower limit flag for joint rotation around the z-axis.
Type: Boolean
rot3lowervalue
The lower limit for joint rotation around the z-axis.
Type: double
rot3upper
The upper limit flag for joint rotation around the z-axis.
Type: Boolean
rot3uppervalue
The upper limit for joint rotation around the z-axis.
Type: double
rot3val
The current angle of the joint for the z-axis.
Type: double
secondaryaxis
The local x-axis of the joint.
Type: triple double
setperpdistance
If true, recalculates the perpendicular distance between origin and path for cam joint.
Type: Boolean
solver_id
The solver ID of the entity.
Type: integer
solverkeyword
The name of the solver keyword.
Type: string
trans3lower
The lower limit flag for joint translation along the z-axis.
Type: Boolean
trans3lowervalue
The lower limit for joint translation along the z-axis.
Type: double
trans3upper
The upper limit flag for joint translation along the z-axis.
Type: Boolean
trans3uppervalue
The upper limit for joint translation along the z-axis.
Type: double
trans3val
The translated value of joint distance along the z-axis.
Type: double
xprimaryaxis
The x coordinate of the primary axis. Valid for hm_getvalue query only.
Type: double
yprimaryaxis
The y coordinate of the primary axis. Valid for hm_getvalue query only.
Type: double
zprimaryaxis
The z coordinate of the primary axis. Valid for hm_getvalue query only.
Type: double
xsecondaryaxis
The x coordinate of the secondary axis. Valid for hm_getvalue query only.
Type: double
ysecondaryaxis
The y coordinate of the secondary axis. Valid for hm_getvalue query only.
Type: double
zsecondaryaxis
The z coordinate of the secondary axis. Valid for hm_getvalue query only.
Type: double

Version History

2017.1 - Added new data names xsecondaryaxis, ysecondaryaxis and zsecondaryaxis.

2019 - Added new data names joint_triplelist, nodepath, nodepathcount, perpdistance and setperpdistance.

2020 - Added new data name color_rgb.

2020.1 - Added new data name solverkeyword.

2021.1 - Added new data names moduleid, poolid, poolname, and solver_id.