ui/gfx/point3_f.h

   1 // Copyright (c) 2011 The Chromium Authors. All rights reserved.
   2 // Use of this source code is governed by a BSD-style license that can be
   3 // found in the LICENSE file.
   4
   5 #ifndef UI_GFX_POINT3_F_H_
   6 #define UI_GFX_POINT3_F_H_
   7
   8 #include <string>
   9
  10 #include "ui/base/ui_export.h"
  11 #include "ui/gfx/point_f.h"
  12 #include "ui/gfx/vector3d_f.h"
  13
  14 namespace gfx {
  15
  16 // A point has an x, y and z coordinate.
  17 class UI_EXPORT Point3F {
  18  public:
  19   Point3F() : x_(0), y_(0), z_(0) {}
  20
  21   Point3F(float x, float y, float z) : x_(x), y_(y), z_(z) {}
  22
  23   explicit Point3F(const PointF& point) : x_(point.x()), y_(point.y()), z_(0) {}
  24
  25   ~Point3F() {}
  26
  27   float x() const { return x_; }
  28   float y() const { return y_; }
  29   float z() const { return z_; }
  30
  31   void set_x(float x) { x_ = x; }
  32   void set_y(float y) { y_ = y; }
  33   void set_z(float z) { z_ = z; }
  34
  35   void SetPoint(float x, float y, float z) {
  36     x_ = x;
  37     y_ = y;
  38     z_ = z;
  39   }
  40
  41   // Returns the squared euclidean distance between two points.
  42   float SquaredDistanceTo(const Point3F& other) const {
  43     float dx = x_ - other.x_;
  44     float dy = y_ - other.y_;
  45     float dz = z_ - other.z_;
  46     return dx * dx + dy * dy + dz * dz;
  47   }
  48
  49   PointF AsPointF() const { return PointF(x_, y_); }
  50
  51   // Returns a string representation of 3d point.
  52   std::string ToString() const;
  53
  54  private:
  55   float x_;
  56   float y_;
  57   float z_;
  58
  59   // copy/assign are allowed.
  60 };
  61
  62 inline bool operator==(const Point3F& lhs, const Point3F& rhs) {
  63   return lhs.x() == rhs.x() && lhs.y() == rhs.y() && lhs.z() == rhs.z();
  64 }
  65
  66 inline bool operator!=(const Point3F& lhs, const Point3F& rhs) {
  67   return !(lhs == rhs);
  68 }
  69
  70 // Add a vector to a point, producing a new point offset by the vector.
  71 UI_EXPORT Point3F operator+(const Point3F& lhs, const Vector3dF& rhs);
  72
  73 // Subtract a vector from a point, producing a new point offset by the vector's
  74 // inverse.
  75 UI_EXPORT Point3F operator-(const Point3F& lhs, const Vector3dF& rhs);
  76
  77 // Subtract one point from another, producing a vector that represents the
  78 // distances between the two points along each axis.
  79 UI_EXPORT Vector3dF operator-(const Point3F& lhs, const Point3F& rhs);
  80
  81 inline Point3F PointAtOffsetFromOrigin(const Vector3dF& offset) {
  82   return Point3F(offset.x(), offset.y(), offset.z());
  83 }
  84
  85 }  // namespace gfx
  86
  87 #endif  // UI_GFX_POINT3_F_H_