RiverSoftAVG Products Help

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 X, Y , and/or 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     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 interface 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 X, Y, and/or 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     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.,   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.

Tag

The tag property is intended for the interface user to assign whatever value they like to the tag. The tag should be cloned and assigned. A common use for the tag would be to assign the object that the object represents so that the object is available later.

The Tag property calls the     GetTag and     SetTag methods.

X

Defines the X, or horizontal, location. The property calls the GetX and SetX methods (Inherited from CommonInterfaces.ILocation.)

Y

Defines the Y, or vertical, location. The property calls the GetY and SetY methods (Inherited from CommonInterfaces.ILocation.)

Z

Defines the Z, or depth, location. The property calls the GetZ and SetZ methods (Inherited from CommonInterfaces.ILocation.)

Add(ILocation)

Overloaded. Adds the input vector to the current vector.

Add(Single)

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

Apply(TVectorOperation,ILocation)

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 should raise an exception. (Inherited from CommonInterfaces.ICloneable.)

Assign(TPersistent)

Overloaded. Attempts to copy the fields or data from source object into the underlying object. (Inherited from CommonInterfaces.ICloneable.)

AssignTo(TPersistent)

Attempts to copy the fields or data from the underlying object into the Destination object. (Inherited from CommonInterfaces.ICloneable.)

Clear

Resets the vector to the origin

Clone

The Clone method is intended to return a copy of the interface object. It is up to the interface implementer whether the clone is a shallow or deep copy. Please refer to the other interface documentation. A common implementation of this method creates the underlying object and then calls the Assign method.

Note that this method returns an IInterface and may need to be cast in order to assign it to another variable of a descendant 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.

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.

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.

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.

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).

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

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.

GetAngle(T2DAxis)

Returns the angle in degrees represented by the Axis pair values in the X, Y, and/or Z properties.

Accessor method for the     Angle property.

GetAngleInRad(T2DAxis)

Returns the angle in radians represented by the Axis pair values in the X, Y, and/or Z properties.

Accessor method for the     AngleInRad property.

GetMagnitude

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

Accessor method for the     Magnitude property.

GetTag

This method is called by the CommonInterfaces.ICloneable.Tag property. It should return the same value that the tag property is set to using the   SetTag method. (Inherited from CommonInterfaces.ICloneable.)

GetX

The GetX method returns the X, or horizontal, location of the underlying object. This method is called by the X property and should return the same value stored there by the SetX method.
 (Inherited from CommonInterfaces.ILocation.)

GetY

The GetX method returns the Y, or vertical, location of the underlying object. This method is called by the Y property and should return the same value stored there by the SetY method.
 (Inherited from CommonInterfaces.ILocation.)

GetZ

The GetZ method returns the Z, or depth, location of the underlying object. This method is called by the Z property and should return the same value stored there by the SetZ method.
 (Inherited from CommonInterfaces.ILocation.)

get_Angle(T2DAxis)

Returns the angle in degrees represented by the Axis pair values in the X, Y, and/or Z properties.

Accessor method for the     Angle property.

get_AngleInRad(T2DAxis)

Returns the angle in radians represented by the Axis pair values in the X, Y, and/or Z properties.

Accessor method for the     AngleInRad property.

get_Magnitude

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

Accessor method for the     Magnitude property.

get_Tag

This method is called by the CommonInterfaces.ICloneable.Tag property. It should return the same value that the tag property is set to using the   SetTag method.

get_X

The GetX method returns the X, or horizontal, location of the underlying object. This method is called by the X property and should return the same value stored there by the SetX method.
 (Inherited from CommonInterfaces.ILocation.)

get_Y

The GetX method returns the Y, or vertical, location of the underlying object. This method is called by the Y property and should return the same value stored there by the SetY method.

get_Z

The GetZ method returns the Z, or depth, location of the underlying object. This method is called by the Z property and should return the same value stored there by the SetZ method.

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

Normalize

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

SetAngle(T2DAxis,Single)

Sets the angle in degrees represented by the Axis pair values in the X, Y, and/or 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     Magnitude of the vector.

Accessor method for the     Angle property.

SetAngleInRad(T2DAxis,Single)

Sets the angle in radians represented by the Axis pair values in the X, Y, and/or 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     Magnitude of the vector.

Accessor method for the     AngleInRad property.

SetMagnitude(Single)

Sets the distance between origin and XYZ, i.e.,     Length. The XYZ point will change in the direction of the vector so that the length will equal the value.

Accessor method for the     Magnitude property.

SetTag(TRSTag)

This method is intended to store an arbitrary integer value. It is called by the Tag property. GetTag method should return the same value later.
 (Inherited from CommonInterfaces.ICloneable.)

SetX(Single)

Stores the Value in the X, or horizontal, location for the underlying object. This method is called by the X property and should store the value in the same place that the GetX method retrieves from.
 (Inherited from CommonInterfaces.ILocation.)

SetXYZ(Single,Single,Single)

The SetXYZ method sets the coordinates for the location all at once.
 (Inherited from CommonInterfaces.ILocation.)

SetY(Single)

Stores the Value in the Y, or vertical, location for the underlying object. This method is called by the Y property and should store the value in the same place that the GetY method retrieves from.
 (Inherited from CommonInterfaces.ILocation.)

SetZ(Single)

Stores the Value in the Z, or depth, location for the underlying object. This method is called by the Z property and should store the value in the same place that the GetZ method retrieves from.
 (Inherited from CommonInterfaces.ILocation.)

set_Angle(T2DAxis,Single)

Sets the angle in degrees represented by the Axis pair values in the X, Y, and/or 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     Magnitude of the vector.

Accessor method for the     Angle property.

set_AngleInRad(T2DAxis,Single)

Sets the angle in radians represented by the Axis pair values in the X, Y, and/or 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     Magnitude of the vector.

Accessor method for the     AngleInRad property.

set_Magnitude(Single)

Sets the distance between origin and XYZ, i.e.,     Length. The XYZ point will change in the direction of the vector so that the length will equal the value.

Accessor method for the     Magnitude property.

set_Tag(TRSTag)

This method is intended to store an arbitrary integer value. It is called by the Tag property. GetTag method should return the same value later.

set_X(Single)

Stores the Value in the X, or horizontal, location for the underlying object. This method is called by the X property and should store the value in the same place that the GetX method retrieves from.

set_Y(Single)

Stores the Value in the Y, or vertical, location for the underlying object. This method is called by the Y property and should store the value in the same place that the GetY method retrieves from.

set_Z(Single)

Stores the Value in the Z, or depth, location for the underlying object. This method is called by the Z property and should store the value in the same place that the GetZ method retrieves from.

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.

ToCommaString

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