Vector2D Object

Derived from: Base Object
Defined in namespace "adsk::core" and the header file is <Core/Geometry/Vector2D.h>

Description

Transient 2D vector. This object is a wrapper for 2D vector data and is used to pass vector data in and out of the API. They are created statically using the create method of the Vector2D class.

Methods

Name Description
add Add a vector to this vector.
angleTo Gets the angle between this vector and another vector.
asArray Returns the vector values as an array [x, y].
asPoint Return a point with the same x and y values as this vector.
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().
copy Creates and returns an independent copy of this Vector2D object.
create Creates a 2D vector object.
dotProduct Calculates the Dot Product of this vector and an input vector.
isEqualTo Compare this vector with another to check for equality.
isParallelTo Compare this vector with another to check for parallelism.
isPerpendicularTo Compare this vector with another to check for perpendicularity.
normalize Normalizes the vector. Normalization makes the vector length equal to one. The vector should not be zero length.
scaleBy Scales the vector by specifying a scaling factor.
setWithArray Sets the definition of the vector by specifying an array containing the x and y coordinates.
subtract Subtract a vector from this vector.
transformBy Transforms the vector by specifying a 2D transformation matrix.

Properties

Name Description
isValid Indicates if this object is still valid, i.e. hasn't been deleted or some other action done to invalidate the reference.
length Gets the length of the vector.
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():
x Gets and sets the X coordinate of the vector.
y Gets and sets the Y coordinate of the vector.

Accessed From

CurveEvaluator2D.getCurvature, CurveEvaluator2D.getFirstDerivative, CurveEvaluator2D.getSecondDerivative, CurveEvaluator2D.getTangent, CurveEvaluator2D.getThirdDerivative, Ellipse2D.getData, Ellipse2D.majorAxis, EllipticalArc2D.getData, EllipticalArc2D.majorAxis, Matrix2D.getAsCoordinateSystem, Point2D.asVector, Point2D.vectorTo, Vector2D.copy, Vector2D.create

Version

Introduced in version August 2014