SkPoint3 Struct Reference

#include <SkPoint3.h>

Public Member Functions
SkScalar	x () const
SkScalar	y () const
SkScalar	z () const
void	set (SkScalar x, SkScalar y, SkScalar z)
SkScalar	length () const
bool	normalize ()
SkPoint3	makeScale (SkScalar scale) const
void	scale (SkScalar value)
SkPoint3	operator- () const
void	operator+= (const SkPoint3 &v)
void	operator-= (const SkPoint3 &v)
bool	isFinite () const
SkScalar	dot (const SkPoint3 &vec) const
SkPoint3	cross (const SkPoint3 &vec) const

Static Public Member Functions
static SkPoint3	Make (SkScalar x, SkScalar y, SkScalar z)
static SkScalar	Length (SkScalar x, SkScalar y, SkScalar z)
static SkScalar	DotProduct (const SkPoint3 &a, const SkPoint3 &b)
static SkPoint3	CrossProduct (const SkPoint3 &a, const SkPoint3 &b)

Public Attributes
SkScalar	fX
SkScalar	fY
SkScalar	fZ

Friends
bool	operator== (const SkPoint3 &a, const SkPoint3 &b)
bool	operator!= (const SkPoint3 &a, const SkPoint3 &b)
SkPoint3	operator- (const SkPoint3 &a, const SkPoint3 &b)
SkPoint3	operator+ (const SkPoint3 &a, const SkPoint3 &b)
SkPoint3	operator* (SkScalar t, SkPoint3 p)

Detailed Description

Definition at line 15 of file SkPoint3.h.

Member Function Documentation

cross()

SkPoint3 SkPoint3::cross ( const SkPoint3 &  vec ) const

inline

Definition at line 141 of file SkPoint3.h.

                                              {
        return CrossProduct(*this, vec);
    }

CrossProduct()

static SkPoint3 SkPoint3::CrossProduct ( const SkPoint3 &  a, const SkPoint3 &  b  )

inlinestatic

Returns the cross product of a and b, treating them as 3D vectors

Definition at line 132 of file SkPoint3.h.

                                                                       {
        SkPoint3 result;
        result.fX = a.fY*b.fZ - a.fZ*b.fY;
        result.fY = a.fZ*b.fX - a.fX*b.fZ;
        result.fZ = a.fX*b.fY - a.fY*b.fX;
 
        return result;
    }

dot()

SkScalar SkPoint3::dot ( const SkPoint3 &  vec ) const

inline

Definition at line 126 of file SkPoint3.h.

                                            {
        return DotProduct(*this, vec);
    }

DotProduct()

static SkScalar SkPoint3::DotProduct ( const SkPoint3 &  a, const SkPoint3 &  b  )

inlinestatic

Returns the dot product of a and b, treating them as 3D vectors

Definition at line 122 of file SkPoint3.h.

                                                                     {
        return a.fX * b.fX + a.fY * b.fY + a.fZ * b.fZ;
    }

isFinite()

bool SkPoint3::isFinite ( ) const

inline

Returns true if fX, fY, and fZ are measurable values.

Returns

true for values other than infinities and NaN

Definition at line 116 of file SkPoint3.h.

                          {
        return SkIsFinite(fX, fY, fZ);
    }

length()

SkScalar SkPoint3::length ( ) const

inline

Return the Euclidian distance from (0,0,0) to the point

Definition at line 44 of file SkPoint3.h.

{ return SkPoint3::Length(fX, fY, fZ); }

Length()

SkScalar SkPoint3::Length ( SkScalar  x, SkScalar  y, SkScalar  z  )

static

Returns the Euclidian distance from (0,0,0) to (x,y,z)

Definition at line 29 of file SkPoint3.cpp.

                                                            {
    float magSq = get_length_squared(x, y, z);
    if (SkIsFinite(magSq)) {
        return std::sqrt(magSq);
    } else {
        double xx = x;
        double yy = y;
        double zz = z;
        return (float)sqrt(xx * xx + yy * yy + zz * zz);
    }
}

Make()

static SkPoint3 SkPoint3::Make ( SkScalar  x, SkScalar  y, SkScalar  z  )

inlinestatic

Definition at line 18 of file SkPoint3.h.

                                                             {
        SkPoint3 pt;
        pt.set(x, y, z);
        return pt;
    }

makeScale()

SkPoint3 SkPoint3::makeScale ( SkScalar  scale ) const

inline

Return a new point whose X, Y and Z coordinates are scaled.

Definition at line 54 of file SkPoint3.h.

                                             {
        SkPoint3 p;
        p.set(scale * fX, scale * fY, scale * fZ);
        return p;
    }

normalize()

bool SkPoint3::normalize

(

)

Set the point (vector) to be unit-length in the same direction as it already points. If the point has a degenerate length (i.e., nearly 0) then set it to (0,0,0) and return false; otherwise return true.

Definition at line 49 of file SkPoint3.cpp.

                         {
    float magSq;
    if (is_length_nearly_zero(fX, fY, fZ, &magSq)) {
        this->set(0, 0, 0);
        return false;
    }
    // sqrtf does not provide enough precision; since sqrt takes a double,
    // there's no additional penalty to storing invScale in a double
    double invScale;
    if (SkIsFinite(magSq)) {
        invScale = magSq;
    } else {
        // our magSq step overflowed to infinity, so use doubles instead.
        // much slower, but needed when x, y or z is very large, otherwise we
        // divide by inf. and return (0,0,0) vector.
        double xx = fX;
        double yy = fY;
        double zz = fZ;
        invScale = xx * xx + yy * yy + zz * zz;
    }
    // using a float instead of a double for scale loses too much precision
    double scale = 1 / sqrt(invScale);
    fX *= scale;
    fY *= scale;
    fZ *= scale;
    if (!SkIsFinite(fX, fY, fZ)) {
        this->set(0, 0, 0);
        return false;
    }
    return true;
}

operator+=()

void SkPoint3::operator+= ( const SkPoint3 &  v )

inline

Add v's coordinates to the point's

Definition at line 94 of file SkPoint3.h.

                                       {
        fX += v.fX;
        fY += v.fY;
        fZ += v.fZ;
    }

operator-()

SkPoint3 SkPoint3::operator- ( ) const

inline

Return a new point whose X, Y and Z coordinates are the negative of the original point's

Definition at line 71 of file SkPoint3.h.

                               {
        SkPoint3 neg;
        neg.fX = -fX;
        neg.fY = -fY;
        neg.fZ = -fZ;
        return neg;
    }

operator-=()

void SkPoint3::operator-= ( const SkPoint3 &  v )

inline

Subtract v's coordinates from the point's

Definition at line 102 of file SkPoint3.h.

                                       {
        fX -= v.fX;
        fY -= v.fY;
        fZ -= v.fZ;
    }

scale()

void SkPoint3::scale ( SkScalar  value )

inline

Scale the point's coordinates by scale.

Definition at line 62 of file SkPoint3.h.

                               {
        fX *= value;
        fY *= value;
        fZ *= value;
    }

set()

void SkPoint3::set ( SkScalar  x, SkScalar  y, SkScalar  z  )

inline

Definition at line 28 of file SkPoint3.h.

{ fX = x; fY = y; fZ = z; }

x()

SkScalar SkPoint3::x ( ) const

inline

Definition at line 24 of file SkPoint3.h.

{ return fX; }

y()

SkScalar SkPoint3::y ( ) const

inline

Definition at line 25 of file SkPoint3.h.

{ return fY; }

z()

SkScalar SkPoint3::z ( ) const

inline

Definition at line 26 of file SkPoint3.h.

{ return fZ; }

Friends And Related Symbol Documentation

operator!=

bool operator!= ( const SkPoint3 &  a, const SkPoint3 &  b  )

friend

Definition at line 34 of file SkPoint3.h.

                                                                 {
        return !(a == b);
    }

operator*

SkPoint3 operator* ( SkScalar  t, SkPoint3  p  )

friend

Definition at line 108 of file SkPoint3.h.

                                                      {
        return { t * p.fX, t * p.fY, t * p.fZ };
    }

operator+

SkPoint3 operator+ ( const SkPoint3 &  a, const SkPoint3 &  b  )

friend

Returns a new point whose coordinates are the sum of a and b (a + b)

Definition at line 88 of file SkPoint3.h.

                                                                    {
        return { a.fX + b.fX, a.fY + b.fY, a.fZ + b.fZ };
    }

operator-

SkPoint3 operator- ( const SkPoint3 &  a, const SkPoint3 &  b  )

friend

Returns a new point whose coordinates are the difference between a and b (i.e., a - b)

Definition at line 82 of file SkPoint3.h.

                                                                    {
        return { a.fX - b.fX, a.fY - b.fY, a.fZ - b.fZ };
    }

operator==

bool operator== ( const SkPoint3 &  a, const SkPoint3 &  b  )

friend

Definition at line 30 of file SkPoint3.h.

                                                                 {
        return a.fX == b.fX && a.fY == b.fY && a.fZ == b.fZ;
    }

Member Data Documentation

fX

SkScalar SkPoint3::fX

Definition at line 16 of file SkPoint3.h.

fY

SkScalar SkPoint3::fY

Definition at line 16 of file SkPoint3.h.

fZ

SkScalar SkPoint3::fZ

Definition at line 16 of file SkPoint3.h.

---

The documentation for this struct was generated from the following files:

• third_party/skia/include/core/SkPoint3.h
• third_party/skia/src/core/SkPoint3.cpp