SdfPredicateFunctionResult Class Reference

#include <predicateLibrary.h>

Public Types
enum	Constancy { IsConstant, MayVary }

Public Member Functions
constexpr	SdfPredicateFunctionResult ()
	Default construction produces a 'false' result that 'MayVary'. More...
	SdfPredicateFunctionResult (bool value, Constancy constancy=MayVary)
	Construct with value and constancy. More...
bool	GetValue () const
	Return the result value. More...
Constancy	GetConstancy () const
	Return the result constancy. More...
	operator bool () const
	Return GetValue(). More...

Detailed Description

Represents the result of a predicate function: a pair of the boolean result and a Constancy token indicating whether the function result is constant over "descendant" objects, or that it might vary over "descendant" objects.

Definition at line 101 of file predicateLibrary.h.

Member Enumeration Documentation

enum SdfPredicateFunctionResult::Constancy

Enumerator
IsConstant
MayVary

Definition at line 104 of file predicateLibrary.h.

Constructor & Destructor Documentation

constexpr SdfPredicateFunctionResult::SdfPredicateFunctionResult ( )

inline

Default construction produces a 'false' result that 'MayVary'.

Definition at line 107 of file predicateLibrary.h.

SdfPredicateFunctionResult::SdfPredicateFunctionResult ( bool  value, Constancy  constancy = MayVary  )

inlineexplicit

Construct with value and constancy.

Definition at line 111 of file predicateLibrary.h.

Member Function Documentation

Constancy SdfPredicateFunctionResult::GetConstancy ( ) const

inline

Return the result constancy.

Definition at line 121 of file predicateLibrary.h.

bool SdfPredicateFunctionResult::GetValue ( ) const

inline

Return the result value.

Definition at line 116 of file predicateLibrary.h.

SdfPredicateFunctionResult::operator bool ( ) const

inlineexplicit

Return GetValue().

Definition at line 126 of file predicateLibrary.h.

---

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

• pxr/usd/sdf/predicateLibrary.h