HDK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
GfRange2d Class Reference

#include <range2d.h>

Public Types

typedef GfVec2d MinMaxType
 Helper typedef. More...
 
typedef GfVec2d::ScalarType ScalarType
 

Public Member Functions

void SetEmpty ()
 Sets the range to an empty interval. More...
 
 GfRange2d ()
 The default constructor creates an empty range. More...
 
 GfRange2d (const GfVec2d &min, const GfVec2d &max)
 This constructor initializes the minimum and maximum points. More...
 
const GfVec2dGetMin () const
 Returns the minimum value of the range. More...
 
const GfVec2dGetMax () const
 Returns the maximum value of the range. More...
 
GfVec2d GetSize () const
 Returns the size of the range. More...
 
GfVec2d GetMidpoint () const
 
void SetMin (const GfVec2d &min)
 Sets the minimum value of the range. More...
 
void SetMax (const GfVec2d &max)
 Sets the maximum value of the range. More...
 
bool IsEmpty () const
 Returns whether the range is empty (max < min). More...
 
void ExtendBy (const GfVec2d &point)
 
void ExtendBy (const GfRange2d &range)
 
bool Contains (const GfVec2d &point) const
 
bool Contains (const GfRange2d &range) const
 
bool IsInside (const GfVec2d &point) const
 
bool IsInside (const GfRange2d &range) const
 
bool IsOutside (const GfRange2d &range) const
 
const GfRange2dUnionWith (const GfRange2d &b)
 Extend this to include b. More...
 
const GfRange2dUnionWith (const GfVec2d &b)
 Extend this to include b. More...
 
const GfRange2dUnion (const GfRange2d &b)
 
const GfRange2dUnion (const GfVec2d &b)
 
const GfRange2dIntersectWith (const GfRange2d &b)
 
const GfRange2dIntersection (const GfRange2d &b)
 
GfRange2d operator+= (const GfRange2d &b)
 unary sum. More...
 
GfRange2d operator-= (const GfRange2d &b)
 unary difference. More...
 
GfRange2d operator*= (double m)
 unary multiply. More...
 
GfRange2d operator/= (double m)
 unary division. More...
 
GfRange2d operator+ (const GfRange2d &b) const
 binary sum. More...
 
GfRange2d operator- (const GfRange2d &b) const
 binary difference. More...
 
bool operator== (const GfRange2d &b) const
 The min and max points must match exactly for equality. More...
 
bool operator!= (const GfRange2d &b) const
 
GF_API bool operator== (const GfRange2f &other) const
 
GF_API bool operator!= (const GfRange2f &other) const
 
GF_API double GetDistanceSquared (const GfVec2d &p) const
 Compute the squared distance from a point to the range. More...
 
GF_API GfVec2d GetCorner (size_t i) const
 
GF_API GfRange2d GetQuadrant (size_t i) const
 

Static Public Member Functions

static GfRange2d GetUnion (const GfRange2d &a, const GfRange2d &b)
 Returns the smallest GfRange2d which contains both a and b. More...
 
static GfRange2d Union (const GfRange2d &a, const GfRange2d &b)
 
static GfRange2d GetIntersection (const GfRange2d &a, const GfRange2d &b)
 Returns a GfRange2d that describes the intersection of a and b. More...
 
static GfRange2d Intersection (const GfRange2d &a, const GfRange2d &b)
 

Static Public Attributes

static const size_t dimension = GfVec2d::dimension
 
static GF_API const GfRange2d UnitSquare
 The unit square. More...
 

Friends

GfRange2d operator* (double m, const GfRange2d &r)
 scalar multiply. More...
 
GfRange2d operator* (const GfRange2d &r, double m)
 scalar multiply. More...
 
GfRange2d operator/ (const GfRange2d &r, double m)
 scalar divide. More...
 
size_t hash_value (const GfRange2d &r)
 hash. More...
 

Detailed Description

Basic type: 2-dimensional floating point range.

This class represents a 2-dimensional range (or interval) All operations are component-wise and conform to interval mathematics. An empty range is one where max < min. The default empty is [FLT_MAX,-FLT_MAX]

Definition at line 64 of file range2d.h.

Member Typedef Documentation

Helper typedef.

Definition at line 69 of file range2d.h.

Definition at line 72 of file range2d.h.

Constructor & Destructor Documentation

GfRange2d::GfRange2d ( )
inline

The default constructor creates an empty range.

Definition at line 82 of file range2d.h.

GfRange2d::GfRange2d ( const GfVec2d min,
const GfVec2d max 
)
inline

This constructor initializes the minimum and maximum points.

Definition at line 87 of file range2d.h.

Member Function Documentation

bool GfRange2d::Contains ( const GfVec2d point) const
inline

Returns true if the point is located inside the range. As with all operations of this type, the range is assumed to include its extrema.

Definition at line 130 of file range2d.h.

bool GfRange2d::Contains ( const GfRange2d range) const
inline

Returns true if the range is located entirely inside the range. As with all operations of this type, the ranges are assumed to include their extrema.

Definition at line 138 of file range2d.h.

void GfRange2d::ExtendBy ( const GfVec2d point)
inline

Modifies the range if necessary to surround the given value.

Deprecated:
Use UnionWith() instead.

Definition at line 122 of file range2d.h.

void GfRange2d::ExtendBy ( const GfRange2d range)
inline

Modifies the range if necessary to surround the given range.

Deprecated:
Use UnionWith() instead.

Definition at line 126 of file range2d.h.

GF_API GfVec2d GfRange2d::GetCorner ( size_t  i) const

Returns the ith corner of the range, in the following order: SW, SE, NW, NE.

GF_API double GfRange2d::GetDistanceSquared ( const GfVec2d p) const

Compute the squared distance from a point to the range.

static GfRange2d GfRange2d::GetIntersection ( const GfRange2d a,
const GfRange2d b 
)
inlinestatic

Returns a GfRange2d that describes the intersection of a and b.

Definition at line 206 of file range2d.h.

const GfVec2d& GfRange2d::GetMax ( ) const
inline

Returns the maximum value of the range.

Definition at line 96 of file range2d.h.

GfVec2d GfRange2d::GetMidpoint ( ) const
inline

Returns the midpoint of the range, that is, 0.5*(min+max). Note: this returns zero in the case of default-constructed ranges, or ranges set via SetEmpty().

Definition at line 104 of file range2d.h.

const GfVec2d& GfRange2d::GetMin ( ) const
inline

Returns the minimum value of the range.

Definition at line 93 of file range2d.h.

GF_API GfRange2d GfRange2d::GetQuadrant ( size_t  i) const

Returns the ith quadrant of the range, in the following order: SW, SE, NW, NE.

GfVec2d GfRange2d::GetSize ( ) const
inline

Returns the size of the range.

Definition at line 99 of file range2d.h.

static GfRange2d GfRange2d::GetUnion ( const GfRange2d a,
const GfRange2d b 
)
inlinestatic

Returns the smallest GfRange2d which contains both a and b.

Definition at line 166 of file range2d.h.

static GfRange2d GfRange2d::Intersection ( const GfRange2d a,
const GfRange2d b 
)
inlinestatic

Returns a GfRange2d that describes the intersection of a and b.

Deprecated:
Use GetIntersection() instead.

Definition at line 215 of file range2d.h.

const GfRange2d& GfRange2d::Intersection ( const GfRange2d b)
inline

Modifies this range to hold its intersection with b and returns the result.

Deprecated:
Use IntersectWith() instead.

Definition at line 230 of file range2d.h.

const GfRange2d& GfRange2d::IntersectWith ( const GfRange2d b)
inline

Modifies this range to hold its intersection with b and returns the result

Definition at line 221 of file range2d.h.

bool GfRange2d::IsEmpty ( ) const
inline

Returns whether the range is empty (max < min).

Definition at line 116 of file range2d.h.

bool GfRange2d::IsInside ( const GfVec2d point) const
inline

Returns true if the point is located inside the range. As with all operations of this type, the range is assumed to include its extrema.

Deprecated:
Use Contains() instead.

Definition at line 145 of file range2d.h.

bool GfRange2d::IsInside ( const GfRange2d range) const
inline

Returns true if the range is located entirely inside the range. As with all operations of this type, the ranges are assumed to include their extrema.

Deprecated:
Use Contains() instead.

Definition at line 153 of file range2d.h.

bool GfRange2d::IsOutside ( const GfRange2d range) const
inline

Returns true if the range is located entirely outside the range. As with all operations of this type, the ranges are assumed to include their extrema.

Definition at line 160 of file range2d.h.

bool GfRange2d::operator!= ( const GfRange2d b) const
inline

Definition at line 309 of file range2d.h.

bool GfRange2d::operator!= ( const GfRange2f other) const
inline

Definition at line 370 of file range2d.h.

GfRange2d GfRange2d::operator*= ( double  m)
inline

unary multiply.

Definition at line 249 of file range2d.h.

GfRange2d GfRange2d::operator+ ( const GfRange2d b) const
inline

binary sum.

Definition at line 267 of file range2d.h.

GfRange2d GfRange2d::operator+= ( const GfRange2d b)
inline

unary sum.

Definition at line 235 of file range2d.h.

GfRange2d GfRange2d::operator- ( const GfRange2d b) const
inline

binary difference.

Definition at line 273 of file range2d.h.

GfRange2d GfRange2d::operator-= ( const GfRange2d b)
inline

unary difference.

Definition at line 242 of file range2d.h.

GfRange2d GfRange2d::operator/= ( double  m)
inline

unary division.

Definition at line 262 of file range2d.h.

bool GfRange2d::operator== ( const GfRange2d b) const
inline

The min and max points must match exactly for equality.

Definition at line 305 of file range2d.h.

PXR_NAMESPACE_CLOSE_SCOPE PXR_NAMESPACE_OPEN_SCOPE bool GfRange2d::operator== ( const GfRange2f other) const
inline

Compare this range to a GfRange2f.

The values must match exactly and it does exactly what you might expect when comparing float and double values.

Definition at line 364 of file range2d.h.

void GfRange2d::SetEmpty ( )
inline

Sets the range to an empty interval.

Definition at line 76 of file range2d.h.

void GfRange2d::SetMax ( const GfVec2d max)
inline

Sets the maximum value of the range.

Definition at line 113 of file range2d.h.

void GfRange2d::SetMin ( const GfVec2d min)
inline

Sets the minimum value of the range.

Definition at line 110 of file range2d.h.

static GfRange2d GfRange2d::Union ( const GfRange2d a,
const GfRange2d b 
)
inlinestatic

Returns the smallest GfRange2d which contains both a and b

Deprecated:
Use GetUnion() instead.

Definition at line 189 of file range2d.h.

const GfRange2d& GfRange2d::Union ( const GfRange2d b)
inline

Extend this to include b.

Deprecated:
Use UnionWith() instead.

Definition at line 195 of file range2d.h.

const GfRange2d& GfRange2d::Union ( const GfVec2d b)
inline

Extend this to include b.

Deprecated:
Use UnionWith() instead.

Definition at line 201 of file range2d.h.

const GfRange2d& GfRange2d::UnionWith ( const GfRange2d b)
inline

Extend this to include b.

Definition at line 174 of file range2d.h.

const GfRange2d& GfRange2d::UnionWith ( const GfVec2d b)
inline

Extend this to include b.

Definition at line 181 of file range2d.h.

Friends And Related Function Documentation

size_t hash_value ( const GfRange2d r)
friend

hash.

Definition at line 297 of file range2d.h.

GfRange2d operator* ( double  m,
const GfRange2d r 
)
friend

scalar multiply.

Definition at line 278 of file range2d.h.

GfRange2d operator* ( const GfRange2d r,
double  m 
)
friend

scalar multiply.

Definition at line 285 of file range2d.h.

GfRange2d operator/ ( const GfRange2d r,
double  m 
)
friend

scalar divide.

Definition at line 292 of file range2d.h.

Member Data Documentation

const size_t GfRange2d::dimension = GfVec2d::dimension
static

Definition at line 71 of file range2d.h.

GF_API const GfRange2d GfRange2d::UnitSquare
static

The unit square.

Definition at line 336 of file range2d.h.


The documentation for this class was generated from the following file: