EsfEditReason Class Reference

Set of scene changes that should trigger edits to the exec network. More...

#include <editReason.h>

Public Member Functions
bool	operator< (const EsfEditReason &other) const
	Enables consistent sorting of EsfEditReasons.
constexpr	EsfEditReason ()=default
	Equivalent to EsfEditReason::None.
ESF_API std::string	GetDescription () const
	Get a string describing the contents of this edit reason.
Bitwise operations
constexpr	operator bool () const
	Return true if this object contains any edit reasons.
constexpr bool	operator== (EsfEditReason other) const
constexpr bool	operator!= (EsfEditReason other) const
constexpr EsfEditReason &	operator&= (EsfEditReason other)
constexpr EsfEditReason &	operator|= (EsfEditReason other)
constexpr EsfEditReason	operator& (EsfEditReason other) const
constexpr EsfEditReason	operator| (EsfEditReason other) const
constexpr bool	Contains (EsfEditReason other) const
	Return true if other's reasons are entirely contained by this set of reasons.

Static Public Attributes
Supported edit reasons
static const EsfEditReason	None
static const EsfEditReason	ResyncedObject
	Something about an object has changed.
static const EsfEditReason	ChangedPropertyList
	The list of properties on a prim has changed.
static const EsfEditReason	ChangedConnectionPaths
	The list of connection paths on an attribute has changed.
static const EsfEditReason	ChangedTargetPaths
	The list of target paths on a relationship has changed.

Detailed Description

Set of scene changes that should trigger edits to the exec network.

The set of change types contained in an EsfEdtReason is stored as a bitmask, where each bit represents a different type of scene change. EsfEditReasons can be manipulated with standard bitwise operators.

Users can only construct bitmasks from the provided set of supported edit reasons.

Definition at line 30 of file editReason.h.

Constructor & Destructor Documentation

EsfEditReason()

constexpr EsfEditReason ( )

constexprdefault

Equivalent to EsfEditReason::None.

Member Function Documentation

Contains()

constexpr bool Contains ( EsfEditReason  other ) const

inlineconstexpr

Return true if other's reasons are entirely contained by this set of reasons.

Definition at line 98 of file editReason.h.

GetDescription()

ESF_API std::string GetDescription

(

)

const

Get a string describing the contents of this edit reason.

The string is a comma-separated list of pre-defined edit reasons that make up this value.

operator bool()

constexpr operator bool ( ) const

inlineexplicitconstexpr

Return true if this object contains any edit reasons.

Definition at line 65 of file editReason.h.

operator!=()

constexpr bool operator!= ( EsfEditReason  other ) const

inlineconstexpr

Definition at line 73 of file editReason.h.

operator&()

constexpr EsfEditReason operator& ( EsfEditReason  other ) const

inlineconstexpr

Definition at line 87 of file editReason.h.

operator&=()

constexpr EsfEditReason & operator&= ( EsfEditReason  other )

inlineconstexpr

Definition at line 77 of file editReason.h.

operator<()

bool operator< ( const EsfEditReason &  other ) const

inline

Enables consistent sorting of EsfEditReasons.

Definition at line 105 of file editReason.h.

operator==()

constexpr bool operator== ( EsfEditReason  other ) const

inlineconstexpr

Definition at line 69 of file editReason.h.

operator|()

constexpr EsfEditReason operator| ( EsfEditReason  other ) const

inlineconstexpr

Definition at line 91 of file editReason.h.

operator|=()

constexpr EsfEditReason & operator|= ( EsfEditReason  other )

inlineconstexpr

Definition at line 82 of file editReason.h.

Member Data Documentation

ChangedConnectionPaths

constexpr EsfEditReason ChangedConnectionPaths

inlinestaticconstexpr

The list of connection paths on an attribute has changed.

Definition at line 53 of file editReason.h.

ChangedPropertyList

constexpr EsfEditReason ChangedPropertyList

inlinestaticconstexpr

The list of properties on a prim has changed.

This includes renames to the prim's properties.

Definition at line 49 of file editReason.h.

ChangedTargetPaths

constexpr EsfEditReason ChangedTargetPaths

inlinestaticconstexpr

The list of target paths on a relationship has changed.

Definition at line 57 of file editReason.h.

None

constexpr EsfEditReason None

inlinestaticconstexpr

Definition at line 37 of file editReason.h.

ResyncedObject

constexpr EsfEditReason ResyncedObject

inlinestaticconstexpr

Something about an object has changed.

This includes recursive resyncs on namespace ancestors.

Definition at line 43 of file editReason.h.

---

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

• pxr/exec/esf/editReason.h