RiverSoftAVG Products Help

Create

Overloaded. Constructs a vector at the origin

Create(ILocation)

Overloaded. Constructs a vector at the same location as the input location

Create(Single,Single,Single)

Overloaded. Constructs a vector at the specified location

Create(TRSVector)

Overloaded. Constructs a vector at the same location as the input vector

AngleInRad[T2DAxis]

The AngleInRad property allows the vector interface to be used as a 2D angle (in radians). The Axis Index controls which 2 axis of the vector are used. Use the AngleInRad property to get the angle represented by the Axis pair values in the RSVector.TRSVector.X, RSVector.TRSVector.Y , and/or RSVector.TRSVector.Z properties. When the AngleInRad property is set, it modifies the axis pair so that it equals the angle given. However, it should attempt to preserve the RSVector.TRSVector.Magnitude of the vector.

The AngleInRad property gets and sets the angle of the vector in radians. Use the     Angle property to get and set the angle of the vector in degrees.
 
 

Angle[T2DAxis]

The Angle property allows the vector to be used as a 2D angle. The Axis Index controls which 2 axis of the vector are used. Use the Angle property to get the angle represented by the Axis pair values in the RSVector.TRSVector.X, RSVector.TRSVector.Y, and/or RSVector.TRSVector.Z properties. When the Angle property is set, it modifies the axis pair so that it equals the angle given. However, it should attempt to preserve the RSVector.TRSVector.Magnitude of the vector.

The Angle property gets and sets the angle of the vector in degrees. Use the     AngleInRad property to get and set the angle of the vector in radians.
 
 

Magnitude

Distance between origin and XYZ, i.e., RSVector.TRSVector.Length . If you set the Magnitude, the XYZ point will change in the direction of the vector so that the length will equal the value.

OnChange

OnChange event occurs when the vector is changed.

Write an OnChange event handler to respond to changes in the vector.

Tag

Provides a property to store information associated with the vector.

X

Specifies the RSVector.TRSVector.X, or horizontal, component of the vector

Y

Specifies the RSVector.TRSVector.Y, or vertical, component of the vector

Z

Specifies the RSVector.TRSVector.Z, or depth, component of the vector

Add(ILocation)

Overloaded. Adds the input vector to the current vector.

Add(Single)

Overloaded. Adds the value to the XYZ components of the vector

Add(TRSVector)

Overloaded. Adds the input vector to the current vector.

Apply(TVectorOperation,ILocation)

Overloaded. Applies the vector operation to the current vector using the input vector

Apply(TVectorOperation,TRSVector)

Overloaded. Applies the vector operation to the current vector using the input vector

Assign(IInterface)

Overloaded. Attempts to copy the fields or data from AValue into the underlying object. If the AValue parameter is not of an interface type that is understood by the object, it will raise an exception.

Assign(TPersistent)

Overloaded. Attempts to copy the fields or data from source object into the underlying object.

Change

Represents method Change.

Clear

Resets the vector to the origin

Clone

Returns a copy of the vector.

Note that this method returns an IInterface and needs to be cast to IVector interface type
 

CrossProduct(ILocation)

Overloaded.  Performs the cross product of the input vector with the current vector.

Given two linearly independent vectors a and b, the cross product, a × b, is a vector that is perpendicular to both a and b and therefore normal to the plane containing them.

CrossProduct(Single,Single,Single)

Overloaded.  Performs the cross product of the vector defined by the input XYZ parameters with the current vector.

Given two linearly independent vectors a and b, the cross product, a × b, is a vector that is perpendicular to both a and b and therefore normal to the plane containing them.

CrossProduct(TRSVector)

Overloaded.  Performs the cross product of the input vector with the current vector.

Given two linearly independent vectors a and b, the cross product, a × b, is a vector that is perpendicular to both a and b and therefore normal to the plane containing them.

DistanceSqrTo(ILocation)

Overloaded. Returns the distance squared between the XYZ component of the input vector and the XYZ component of the current vector.

DistanceSqrTo(Single,Single,Single)

Overloaded. Returns the distance squared between the XYZ point and the XYZ component of the current vector.

DistanceSqrTo(TRSVector)

Overloaded. Returns the distance squared between the XYZ component of the input vector and the XYZ component of the current vector.

DistanceTo(ILocation)

Overloaded. Returns the distance between the XYZ component of the input vector and the XYZ component of the current vector.

DistanceTo(Single,Single,Single)

Overloaded. Returns the distance between the XYZ point and the XYZ component of the current vector.

DistanceTo(TRSVector)

Overloaded. Returns the distance between the XYZ component of the input vector and the XYZ component of the current vector.

Divide(ILocation)

Overloaded. Divides the current vector by the input vector.

Divide(Single)

Overloaded. Divides the XYZ components of the current vector by the input value.

Divide(TRSVector)

Overloaded. Divides the current vector by the input vector.

DotProduct(ILocation)

Overloaded.  Performs the dot product of the vector defined by the input XYZ parameters with the current vector.

Dot Product is directional multiplication. It applies the directional growth of one vector to another. The result is how much stronger we've made the original (positive, negative, or zero).

DotProduct(Single,Single,Single)

Overloaded.  Performs the dot product of the vector defined by the input XYZ parameters with the current vector.

Dot Product is directional multiplication. It applies the directional growth of one vector to another. The result is how much stronger we've made the original (positive, negative, or zero).

DotProduct(TRSVector)

Overloaded.  Performs the dot product of the vector defined by the input XYZ parameters with the current vector.

Dot Product is directional multiplication. It applies the directional growth of one vector to another. The result is how much stronger we've made the original (positive, negative, or zero).

Equals(IInterface)

Overloaded. Returns true if the input AValue supports a ILocation interface and the location equals the current vector.

Equals(ILocation)

Overloaded. Returns true if the current vector equals the input vector

Equals(Single,Single,Single)

Overloaded. Returns true if the XYZ components of current vector equals the input XYZ

Equals(TRSVector)

Overloaded. Returns true if the current vector equals the input vector

EqualsStar(ILocation)

Overloaded. Returns true if the current vector points in the same direction as the input vector

EqualsStar(Single,Single,Single)

Overloaded. Returns true if the current vector points in the same direction as the vector defined by the XYZ components.

EqualsStar(TRSVector)

Overloaded. Returns true if the current vector points in the same direction as the input vector

GetAngle(T2DAxis)

Accessor method for the RSVector.TRSVector.Angle[T2DAxis] property.

GetAngleDeg(Single,Single)

Represents method GetAngleDeg(Single,Single).

GetAngleInRad(T2DAxis)

Accessor method for the RSVector.TRSVector.AngleInRad[T2DAxis] property.

GetMagnitude

Returns the distance between origin and XYZ, i.e.,  Length.

Accessor method for the  Magnitude property.

GetTag

Accessor method for the RSVector.TRSVector.Tag property.

GetX

Accessor method for the RSVector.TRSVector.X property.

GetY

Accessor method for the RSVector.TRSVector.Y property.

GetZ

Accessor method for the RSVector.TRSVector.Z property.

Length

Distance between origin and XYZ

Multiply(ILocation)

Overloaded. Multiplies the current vector by the input vector.

Multiply(Single)

Overloaded. Multiplies the XYZ components of the current vector by the value

Multiply(TRSVector)

Overloaded. Multiplies the current vector by the input vector.

Normalize

Returns the normalized instance (XYZ between 0 and 1) of the vector

QueryInterface(TGUID,Void)

Represents method QueryInterface(TGUID,Void).

SetAngle(T2DAxis,Single)

Accessor method for the RSVector.TRSVector.Angle[T2DAxis] property.

SetAngleInRad(T2DAxis,Single)

Accessor method for the RSVector.TRSVector.AngleInRad[T2DAxis] property.

SetMagnitude(Single)

Accessor method for the RSVector.TRSVector.Magnitude property.

SetTag(TRSTag)

Accessor method for the RSVector.TRSVector.Tag property.

SetX(Single)

Accessor method for the RSVector.TRSVector.X property.

SetXYZ(Single,Single,Single)

The SetXYZ method sets the coordinates for the location all at once.
 

SetY(Single)

Accessor method for the RSVector.TRSVector.Y property.

SetZ(Single)

Accessor method for the RSVector.TRSVector.Z property.

Subtract(ILocation)

Overloaded. Subtracts the input vector from the current vector.

Subtract(Single)

Overloaded. Subtracts the input value from the current XYZ components of the current vector.

Subtract(TRSVector)

Overloaded. Subtracts the input vector from the current vector.

ToCommaString

Returns the vector as an comma separated string, e.g., 'X, Y, Z'

_AddRef

Represents method _AddRef.

_Release

Represents method _Release.