Package com.inductiveautomation.rm.graphics

Class RMVector3D

  • public class RMVector3D
extends java.lang.Object
    This class represents a 3D vector.

    • Constructor Summary

      Constructors 
      Constructor Description
      RMVector3D​(double x, double y, double z)
      Creates a new vector from the given coords.
      RMVector3D​(RMVector3D aVector)
      Creates a new vector from the given vector.

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      void add​(RMVector3D aVector)
      Add the given vector to this.
      double getAngleBetween​(RMVector3D aVector)
      Returns the angle between the receiver and the given vector.
      RMVector3D getCrossProduct​(RMVector3D v2)
      Returns the vector perpendicular to the receiver and the given vector.
      double getDotProduct​(RMVector3D v2)
      Returns the dot product of the receiver and the given vector.
      double getMagnitude()
      Returns the magnitude of the vector.
      boolean isAligned​(RMVector3D aVector, boolean includePerpendiculars)
      Returns whether given vector is in same general direction of this (with option to include perpendiculars).
      boolean isAway​(RMVector3D aVector, boolean includePerpendiculars)
      Returns whether given vector is pointing away from the direction of this (with option to include perpendiculars).
      void negate()
      Makes this receiver point in the opposite direction.
      RMVector3D normalize()
      Makes the vector unit length.
      java.lang.String toString()
      Returns a string representation of the vector.
      RMVector3D transform​(RMTransform3D aTransform)
      Transforms the vector by the given transform3d.

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

    • Constructor Detail

      • RMVector3D

        public RMVector3D​(double x,
                  double y,
                  double z)
        Creates a new vector from the given coords.

      • RMVector3D

        public RMVector3D​(RMVector3D aVector)
        Creates a new vector from the given vector.

    • Method Detail

      • getMagnitude

        public double getMagnitude()
        Returns the magnitude of the vector.

      • normalize

        public RMVector3D normalize()
        Makes the vector unit length.

      • add

        public void add​(RMVector3D aVector)
        Add the given vector to this.

      • getCrossProduct

        public RMVector3D getCrossProduct​(RMVector3D v2)
        Returns the vector perpendicular to the receiver and the given vector.

      • getDotProduct

        public double getDotProduct​(RMVector3D v2)
        Returns the dot product of the receiver and the given vector.

      • isAligned

        public boolean isAligned​(RMVector3D aVector,
                         boolean includePerpendiculars)
        Returns whether given vector is in same general direction of this (with option to include perpendiculars).

      • isAway

        public boolean isAway​(RMVector3D aVector,
                      boolean includePerpendiculars)
        Returns whether given vector is pointing away from the direction of this (with option to include perpendiculars).

      • getAngleBetween

        public double getAngleBetween​(RMVector3D aVector)
        Returns the angle between the receiver and the given vector.

      • negate

        public void negate()
        Makes this receiver point in the opposite direction.

      • transform

        public RMVector3D transform​(RMTransform3D aTransform)
        Transforms the vector by the given transform3d.

      • toString

        public java.lang.String toString()
        Returns a string representation of the vector.
        Overrides:
        toString in class java.lang.Object