Share

UserCoordinateSystemDefinition Object


Description

The UserCoordinateSystemDefinition object represents the information that defines a coordinate system. You can use this object as input to the UserCoordinateSystems.Add method to create the actual coordinate system.

Methods

Name Description
GetByThreePoints Method that gets the inputs that fully define the coordinate system. The objects returned will be Nothing if the coordinate system was not parametrically defined (i.e. if the DefinitionType property returns kTransformationDefinitionType). This method returns a failure in assembly documents.
SetByThreePoints Method that sets the inputs that fully define the coordinate system. This method returns a failure in assembly documents.

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.
DefinitionType Property that returns how the inputs for the coordinate system are defined. This can return either kTransformationDefinitionType or kThreePointsDefinitionType.
Parent Property that returns the parent UserCoordinateSystem of this definition. In the case where this is a newly created UserCoordinateSystemDefinition object, this property will return Nothing because there is not a logical parent for the object.
Transformation Gets and puts the transformation matrix.
Type Returns an ObjectTypeEnum indicating this object's type.

Accessed From

UserCoordinateSystem.Definition, UserCoordinateSystemProxy.Definition, UserCoordinateSystems.CreateDefinition

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 2011

Was this information helpful?