Share

UserCoordinateSystem Object


Description

The UserCoordinateSystem object represents a user coordinate system.

Methods

Name Description
Delete Method that deletes the UserCoordinateSystem.
GetReferenceKey Method that generates and returns the reference key for this entity.
SetEndOfPart Method that repositions the end of part marker relative to the object.

Properties

Name Description
Application Returns the top-level parent application object. When used the context of Inventor, an Application object is returned. When used in the context of Apprentice, an ApprenticeServer object is returned.
AttributeSets Property that returns the AttributeSets collection object associated with this object.
Definition Property that returns the UserCoordinateSystemDefinition object that can be used to get and set the inputs for the coordinate system and redefine the coordinate system.
HealthStatus Property that returns an enum indicating the current state of the object.
IsOwnedByFeature Property that returns whether this object is owned by a feature (such as a ClientFeature). If True, the OwnedBy property returns the feature.
Name Gets and sets the name of the UserCoordinateSystem.
Origin Property that returns the work point that represents the origin of the coordinate system.
OwnedBy Property that returns the PartFeature object that owns this object. This property returns Nothing if the IsOwnedByFeature property returns False.
Parent Property that returns the parent ComponentDefinition object.
Transformation Gets and sets the transformation matrix for the coordinate system.
Type Returns an ObjectTypeEnum indicating this object's type.
Visible Gets and sets the visibility of the coordinate system.
XAngle Property that returns the parameter associated with the rotation angle about the x-axis.
XAxis Property that returns the work axis that represents the x-axis of the coordinate system.
XOffset Property that returns the parameter associated with the X offset value.
XYPlane Property that returns the work plane that represents the X-Y plane of the coordinate system.
XZPlane Property that returns the work plane that represents the X-Z plane of the coordinate system.
YAngle Property that returns the parameter associated with the rotation angle about the y-axis.
YAxis Property that returns the work axis that represents the y-axis of the coordinate system.
YOffset Property that returns the parameter associated with the Y offset value.
YZPlane Property that returns the work plane that represents the Y-Z plane of the coordinate system.
ZAngle Property that returns the parameter associated with the rotation angle about the z-axis.
ZAxis Property that returns the work axis that represents the z-axis of the coordinate system.
ZOffset Property that returns the parameter associated with the Z offset value.

Accessed From

BIMComponentDescription.UserCoordinateSystemOrientation, UserCoordinateSystemDefinition.Parent, UserCoordinateSystemProxy.NativeObject, UserCoordinateSystems.Add, UserCoordinateSystems.Item

Derived Classes

UserCoordinateSystemProxy

Samples

Name Description
UCS by three points This sample demonstrates the creation of a User Coordinate System (UCS) based on 3 points that define the origin, x-direction and y-direction for the UCS.
UCS by transformation matrix This sample demonstrates the creation of a user coordinate system (UCS) by specifying a transformation matrix.

Version

Introduced in version 2010

Was this information helpful?