Loading...
Searching...
No Matches
PcpErrorInvalidAuthoredRelocation Class Reference

Invalid authored relocation found in a relocates field. More...

#include <errors.h>

+ Inheritance diagram for PcpErrorInvalidAuthoredRelocation:

Public Member Functions

PCP_API ~PcpErrorInvalidAuthoredRelocation () override
 Destructor.
 
PCP_API std::string ToString () const override
 Converts error to string message.
 
- Public Member Functions inherited from PcpErrorRelocationBase
PCP_API ~PcpErrorRelocationBase () override
 Destructor.
 
- Public Member Functions inherited from PcpErrorBase
virtual PCP_API ~PcpErrorBase ()
 Destructor.
 
virtual std::string ToString () const =0
 Converts error to string message.
 

Static Public Member Functions

static PcpErrorInvalidAuthoredRelocationPtr New ()
 Returns a new error object.
 

Public Attributes

SdfPath sourcePath
 The source path of the invalid relocation.
 
SdfPath targetPath
 The target path of the invalid relocation.
 
SdfLayerHandle layer
 The layer containing the authored relocates.
 
SdfPath owningPath
 The path to the prim where the relocates is authored.
 
std::string messages
 Additional messages about the error.
 
- Public Attributes inherited from PcpErrorBase
const PcpErrorType errorType
 The error code.
 
PcpSite rootSite
 The site of the composed prim or property being computed when the error was encountered.
 

Additional Inherited Members

- Protected Member Functions inherited from PcpErrorRelocationBase
 PcpErrorRelocationBase (PcpErrorType errorType)
 
- Protected Member Functions inherited from PcpErrorBase
 PcpErrorBase (PcpErrorType errorType)
 Constructor.
 

Detailed Description

Invalid authored relocation found in a relocates field.

Definition at line 706 of file errors.h.

Constructor & Destructor Documentation

◆ ~PcpErrorInvalidAuthoredRelocation()

PCP_API ~PcpErrorInvalidAuthoredRelocation ( )
override

Destructor.

Member Function Documentation

◆ New()

static PcpErrorInvalidAuthoredRelocationPtr New ( )
static

Returns a new error object.

◆ ToString()

PCP_API std::string ToString ( ) const
overridevirtual

Converts error to string message.

Implements PcpErrorBase.

Member Data Documentation

◆ layer

SdfLayerHandle layer

The layer containing the authored relocates.

Definition at line 720 of file errors.h.

◆ messages

std::string messages

Additional messages about the error.

Definition at line 725 of file errors.h.

◆ owningPath

SdfPath owningPath

The path to the prim where the relocates is authored.

Definition at line 722 of file errors.h.

◆ sourcePath

SdfPath sourcePath

The source path of the invalid relocation.

Definition at line 716 of file errors.h.

◆ targetPath

SdfPath targetPath

The target path of the invalid relocation.

Definition at line 718 of file errors.h.


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