JointOriginInput Object

Derived from: Base Object
Defined in namespace "adsk::fusion" and the header file is <Fusion/Components/JointOriginInput.h>

Description

Defines all of the information required to create a new joint origin. This object provides equivalent functionality to the Joint Origin command dialog in that it gathers the required information to create a joint origin.

Methods

Name Description
classType Static function that all classes support that returns the type of the class as a string. The returned string matches the string returned by the objectType property. For example if you have a reference to an object and you want to check if it's a SketchLine you can use myObject.objectType == fusion.SketchLine.classType().

Properties

Name Description
angle Gets and sets the value that defines the angle for the joint origin. This defaults to zero if it's not specified. The value defines an angle and if the ValueInput is defined using the createByReal method the value is assumed to be radians.
geometry Gets and sets the joint geometry for this joint origin input. This defines the location of the joint origin.
isFlipped Gets and sets if the joint origin direction is flipped or not.
isValid Indicates if this object is still valid, i.e. hasn't been deleted or some other action done to invalidate the reference.
objectType This property is supported by all objects in the API and returns a string that contains the full name (namespace::objecttype) describing the type of the object.

It's often useful to use this in combination with the classType method to see if an object is a certain type. For example: if obj.objectType == adsk.core.Point3D.classType():
offsetX Gets and sets the value that defines the X offset direction. This defaults to zero if it's not specified. The value defines a distance and if the ValueInput is defined using the createByReal method the value is assumed to be centimeters.
offsetY Gets and sets the value that defines the Y offset direction. This defaults to zero if it's not specified. The value defines a distance and if the ValueInput is defined using the createByReal method the value is assumed to be centimeters.
offsetZ Gets and sets the value that defines the Z offset direction. This defaults to zero if it's not specified. The value defines a distance and if the ValueInput is defined using the createByReal method the value is assumed to be centimeters.
primaryAxisVector Returns the direction of the primary axis that's been calculated for this joint origin. This is conceptually the Z axis as shown by the triad representing the joint origin.
secondaryAxisVector Returns the direction of the secondary axis that's been calculated for this joint origin. This is conceptually the X axis as shown by the triad representing the joint origin.
thirdAxisVector Returns the direction of the third axis that's been calculated for this joint origin. This is conceptually the Y axis as shown by the triad representing the joint origin.
xAxisEntity Gets and sets the entity that defines the X axis direction. This defaults to null meaning the X axis is inferred from the input geometry.
zAxisEntity Gets and sets the entity that defines the Z axis direction. This defaults to null meaning the Z axis is inferred from the input geometry.

Accessed From

JointOrigins.createInput

Samples

Name Description
Joint Origin Between Two Faces Sample Demonstrates creating a new Joint Origin between two planes.
Joint Origin Sample Demonstrates creating a new Joint Origin.

Version

Introduced in version September 2015