Basic type: 1-dimensional floating point range. More...

#include <range1f.h>

Public Types
typedef float	MinMaxType
	Helper typedef.

typedef MinMaxType	ScalarType

Public Member Functions
void	SetEmpty ()
	Sets the range to an empty interval.

	GfRange1f ()
	The default constructor creates an empty range.

	GfRange1f (float min, float max)
	This constructor initializes the minimum and maximum points.

GF_API	GfRange1f (class GfRange1d const &other)
	Construct from GfRange1d.

float	GetMin () const
	Returns the minimum value of the range.

float	GetMax () const
	Returns the maximum value of the range.

float	GetSize () const
	Returns the size of the range.

float	GetMidpoint () const
	Returns the midpoint of the range, that is, 0.5*(min+max).

void	SetMin (float min)
	Sets the minimum value of the range.

void	SetMax (float max)
	Sets the maximum value of the range.

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

void	ExtendBy (float point)
	Modifies the range if necessary to surround the given value.

void	ExtendBy (const GfRange1f &range)
	Modifies the range if necessary to surround the given range.

bool	Contains (float point) const
	Returns true if the `point` is located inside the range.

bool	Contains (const GfRange1f &range) const
	Returns true if the `range` is located entirely inside the range.

bool	IsInside (float point) const
	Returns true if the `point` is located inside the range.

bool	IsInside (const GfRange1f &range) const
	Returns true if the `range` is located entirely inside the range.

bool	IsOutside (const GfRange1f &range) const
	Returns true if the `range` is located entirely outside the range.

const GfRange1f &	UnionWith (const GfRange1f &b)
	Extend `this` to include `b`.

const GfRange1f &	UnionWith (float b)
	Extend `this` to include `b`.

const GfRange1f &	Union (const GfRange1f &b)
	Extend `this` to include `b`.

const GfRange1f &	Union (float b)
	Extend `this` to include `b`.

const GfRange1f &	IntersectWith (const GfRange1f &b)
	Modifies this range to hold its intersection with `b` and returns the result.

const GfRange1f &	Intersection (const GfRange1f &b)
	Modifies this range to hold its intersection with `b` and returns the result.

GfRange1f &	operator+= (const GfRange1f &b)
	unary sum.

GfRange1f &	operator-= (const GfRange1f &b)
	unary difference.

GfRange1f &	operator*= (double m)
	unary multiply.

GfRange1f &	operator/= (double m)
	unary division.

GfRange1f	operator+ (const GfRange1f &b) const
	binary sum.

GfRange1f	operator- (const GfRange1f &b) const
	binary difference.

bool	operator== (const GfRange1f &b) const
	The min and max points must match exactly for equality.

bool	operator!= (const GfRange1f &b) const

GF_API bool	operator== (const GfRange1d &other) const
	Compare this range to a GfRange1d.

GF_API bool	operator!= (const GfRange1d &other) const

GF_API double	GetDistanceSquared (float p) const
	Compute the squared distance from a point to the range.

Static Public Member Functions
static GfRange1f	GetUnion (const GfRange1f &a, const GfRange1f &b)
	Returns the smallest `GfRange1f` which contains both `a` and `b`.

static GfRange1f	Union (const GfRange1f &a, const GfRange1f &b)
	Returns the smallest `GfRange1f` which contains both `a` and `b`.

static GfRange1f	GetIntersection (const GfRange1f &a, const GfRange1f &b)
	Returns a `GfRange1f` that describes the intersection of `a` and `b`.

static GfRange1f	Intersection (const GfRange1f &a, const GfRange1f &b)
	Returns a `GfRange1f` that describes the intersection of `a` and `b`.

Static Public Attributes
static const size_t	dimension = 1

Friends
GfRange1f	operator* (double m, const GfRange1f &r)
	scalar multiply.

GfRange1f	operator* (const GfRange1f &r, double m)
	scalar multiply.

GfRange1f	operator/ (const GfRange1f &r, double m)
	scalar divide.

size_t	hash_value (const GfRange1f &r)
	hash.

Detailed Description

Basic type: 1-dimensional floating point range.

This class represents a 1-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 61 of file range1f.h.

Member Typedef Documentation

◆ MinMaxType

typedef float MinMaxType

Helper typedef.

Definition at line 66 of file range1f.h.

◆ ScalarType

typedef MinMaxType ScalarType

Definition at line 69 of file range1f.h.

Constructor & Destructor Documentation

◆ GfRange1f() [1/3]

GfRange1f ( )

inline

The default constructor creates an empty range.

Definition at line 79 of file range1f.h.

◆ GfRange1f() [2/3]

GfRange1f	(	float	min,
		float	max
	)

inline

This constructor initializes the minimum and maximum points.

Definition at line 84 of file range1f.h.

◆ GfRange1f() [3/3]

GF_API GfRange1f ( class GfRange1d const & other )

explicit

Construct from GfRange1d.

Member Function Documentation

◆ Contains() [1/2]

bool Contains ( const GfRange1f & 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 139 of file range1f.h.

◆ Contains() [2/2]

bool Contains ( float 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 132 of file range1f.h.

◆ ExtendBy() [1/2]

void ExtendBy ( const GfRange1f & range )

inline

Modifies the range if necessary to surround the given range.

Deprecated:: Use UnionWith() instead.

Definition at line 128 of file range1f.h.

◆ ExtendBy() [2/2]

void ExtendBy ( float point )

inline

Modifies the range if necessary to surround the given value.

Deprecated:: Use UnionWith() instead.

Definition at line 124 of file range1f.h.

◆ GetDistanceSquared()

GF_API double GetDistanceSquared ( float p ) const

Compute the squared distance from a point to the range.

◆ GetIntersection()

static GfRange1f GetIntersection	(	const GfRange1f &	a,
		const GfRange1f &	b
	)

inlinestatic

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

Definition at line 206 of file range1f.h.

◆ GetMax()

float GetMax ( ) const

inline

Returns the maximum value of the range.

Definition at line 98 of file range1f.h.

◆ GetMidpoint()

float 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 106 of file range1f.h.

◆ GetMin()

float GetMin ( ) const

inline

Returns the minimum value of the range.

Definition at line 95 of file range1f.h.

◆ GetSize()

float GetSize ( ) const

inline

Returns the size of the range.

Definition at line 101 of file range1f.h.

◆ GetUnion()

static GfRange1f GetUnion	(	const GfRange1f &	a,
		const GfRange1f &	b
	)

inlinestatic

Returns the smallest GfRange1f which contains both a and b.

Definition at line 166 of file range1f.h.

◆ Intersection() [1/2]

static GfRange1f Intersection	(	const GfRange1f &	a,
		const GfRange1f &	b
	)

inlinestatic

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

Deprecated:: Use GetIntersection() instead.

Definition at line 215 of file range1f.h.

◆ Intersection() [2/2]

const GfRange1f & Intersection ( const GfRange1f & 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 range1f.h.

◆ IntersectWith()

const GfRange1f & IntersectWith ( const GfRange1f & b )

inline

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

Definition at line 221 of file range1f.h.

◆ IsEmpty()

bool IsEmpty ( ) const

inline

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

Definition at line 118 of file range1f.h.

◆ IsInside() [1/2]

bool IsInside ( const GfRange1f & 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 154 of file range1f.h.

◆ IsInside() [2/2]

bool IsInside ( float 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 146 of file range1f.h.

◆ IsOutside()

bool IsOutside ( const GfRange1f & 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 161 of file range1f.h.

◆ operator!=() [1/2]

bool operator!= ( const GfRange1d & other ) const

inline

Definition at line 352 of file range1f.h.

◆ operator!=() [2/2]

bool operator!= ( const GfRange1f & b ) const

inline

Definition at line 306 of file range1f.h.

◆ operator*=()

GfRange1f & operator*= ( double m )

inline

unary multiply.

Definition at line 249 of file range1f.h.

◆ operator+()

GfRange1f operator+ ( const GfRange1f & b ) const

inline

binary sum.

Definition at line 267 of file range1f.h.

◆ operator+=()

GfRange1f & operator+= ( const GfRange1f & b )

inline

unary sum.

Definition at line 235 of file range1f.h.

◆ operator-()

GfRange1f operator- ( const GfRange1f & b ) const

inline

binary difference.

Definition at line 273 of file range1f.h.

◆ operator-=()

GfRange1f & operator-= ( const GfRange1f & b )

inline

unary difference.

Definition at line 242 of file range1f.h.

◆ operator/=()

GfRange1f & operator/= ( double m )

inline

unary division.

Definition at line 262 of file range1f.h.

◆ operator==() [1/2]

bool operator== ( const GfRange1d & other ) const

inline

Compare this range to a GfRange1d.

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

Definition at line 346 of file range1f.h.

◆ operator==() [2/2]

bool operator== ( const GfRange1f & b ) const

inline

The min and max points must match exactly for equality.

Definition at line 302 of file range1f.h.

◆ SetEmpty()

void SetEmpty ( )

inline

Sets the range to an empty interval.

Definition at line 73 of file range1f.h.

◆ SetMax()

void SetMax ( float max )

inline

Sets the maximum value of the range.

Definition at line 115 of file range1f.h.

◆ SetMin()

void SetMin ( float min )

inline

Sets the minimum value of the range.

Definition at line 112 of file range1f.h.

◆ Union() [1/3]

static GfRange1f Union	(	const GfRange1f &	a,
		const GfRange1f &	b
	)

inlinestatic

Returns the smallest GfRange1f which contains both a and b.

Deprecated:: Use GetUnion() instead.

Definition at line 189 of file range1f.h.

◆ Union() [2/3]

const GfRange1f & Union ( const GfRange1f & b )

inline

Extend this to include b.

Deprecated:: Use UnionWith() instead.

Definition at line 195 of file range1f.h.

◆ Union() [3/3]

const GfRange1f & Union ( float b )

inline

Extend this to include b.

Deprecated:: Use UnionWith() instead.

Definition at line 201 of file range1f.h.

◆ UnionWith() [1/2]

const GfRange1f & UnionWith ( const GfRange1f & b )

inline

Extend this to include b.

Definition at line 174 of file range1f.h.

◆ UnionWith() [2/2]

const GfRange1f & UnionWith ( float b )

inline

Extend this to include b.

Definition at line 181 of file range1f.h.

Friends And Related Function Documentation

◆ hash_value

size_t hash_value ( const GfRange1f & r )

friend

hash.

Definition at line 297 of file range1f.h.

◆ operator* [1/2]

GfRange1f operator*	(	const GfRange1f &	r,
		double	m
	)

friend

scalar multiply.

Definition at line 285 of file range1f.h.

◆ operator* [2/2]

GfRange1f operator*	(	double	m,
		const GfRange1f &	r
	)

friend

scalar multiply.

Definition at line 278 of file range1f.h.

◆ operator/

GfRange1f operator/	(	const GfRange1f &	r,
		double	m
	)

friend

scalar divide.

Definition at line 292 of file range1f.h.

Member Data Documentation

◆ dimension

const size_t dimension = 1

static

Definition at line 68 of file range1f.h.

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

pxr/base/gf/range1f.h

Public Types

Public Member Functions

Static Public Member Functions

Static Public Attributes

Friends

Detailed Description

Member Typedef Documentation

◆ MinMaxType

◆ ScalarType

Constructor & Destructor Documentation

◆ GfRange1f() [1/3]

◆ GfRange1f() [2/3]

◆ GfRange1f() [3/3]

Member Function Documentation

◆ Contains() [1/2]

◆ Contains() [2/2]

◆ ExtendBy() [1/2]

◆ ExtendBy() [2/2]

◆ GetDistanceSquared()

◆ GetIntersection()

◆ GetMax()

◆ GetMidpoint()

◆ GetMin()

◆ GetSize()

◆ GetUnion()

◆ Intersection() [1/2]

◆ Intersection() [2/2]

◆ IntersectWith()

◆ IsEmpty()

◆ IsInside() [1/2]

◆ IsInside() [2/2]

◆ IsOutside()

◆ operator!=() [1/2]

◆ operator!=() [2/2]

◆ operator*=()

◆ operator+()

◆ operator+=()

◆ operator-()

◆ operator-=()

◆ operator/=()

◆ operator==() [1/2]

◆ operator==() [2/2]

◆ SetEmpty()

◆ SetMax()

◆ SetMin()

◆ Union() [1/3]

◆ Union() [2/3]

◆ Union() [3/3]

◆ UnionWith() [1/2]

◆ UnionWith() [2/2]

Friends And Related Function Documentation

◆ hash_value

◆ operator* [1/2]

◆ operator* [2/2]

◆ operator/

Member Data Documentation

◆ dimension