This functionality is provided as a preview
of intended future API capabilities. You are encouraged to use it and report any problems or suggestions using the
Fusion API and Scripts forum.
Because this is a preview of future functionality, there is the possibility that it will change, which will possibly
break any existing programs that use this functionality. Because of that, you should never deliver any programs that use
any preview capabilities. For a distributed program, you should wait until it has moved from preview to released state.
Defines all of the information required to create a new User Coordinate System. This object provides equivalent functionality to the User Coordinate System command dialog in that it gathers the required information to create a User Coordinate System.
| 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(). |
| Name | Description |
| angleX | Gets and sets the value that defines the angle X for the user coordinate system. This defaults to zero if it's not specified. The value defines an angle X and if the ValueInput is defined using the createByReal method the value is assumed to be radians. |
| angleY | Gets and sets the value that defines the angle Y for the user coordinate system. This defaults to zero if it's not specified. The value defines an angle Y and if the ValueInput is defined using the createByReal method the value is assumed to be radians. |
| angleZ | Gets and sets the value that defines the angle Z for the user coordinate system. This defaults to zero if it's not specified. The value defines an angle Z and if the ValueInput is defined using the createByReal method the value is assumed to be radians. |
| creationOccurrence | Gets and sets the occurrence this User Coordinate System will be created within. This property is only needed when creating (the UserCoordinateSystem) with geometry (e.g. a sketch point) in another component AND (the UserCoordinateSystem) is not in the root component. The CreationOccurrence is analogous to the active occurrence in the UI |
| geometry | Gets and sets the User Coordinate System geometry for this User Coordinate System input. This defines the location of the User Coordinate System. |
| globalOrientParameterOne | Gets and sets the value that defines the first global orient parameter for the User Coordinate System. This defaults to zero if it's not specified. For Cylinder or cone, it represents the angle around the center axis. For Sphere and Torus, it represents the angle around the center axis. For Spline, it represents the U parameter. |
| globalOrientParameterTwo | Gets and sets the value that defines the second global orient parameter for the User Coordinate System. This defaults to zero if it's not specified. For Cylinder or cone, it is not used. For Sphere, it represents the polar angle, which is the angle between the radius line and the equator plane. For Torus, it represents the angle around the center of the section circle. For Spline, it represents the V parameter. |
| 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. |
| 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. |
| Name | Description |
| Create a User Coordinate System | Demonstrates the creation of a user coordinate system at the end of a selected sketch curve or edge. |