Loading...
Searching...
No Matches
PcpErrorTargetPathBase Class Reference

Base class for composition errors related to target or connection paths. More...

#include <errors.h>

+ Inheritance diagram for PcpErrorTargetPathBase:

Public Member Functions

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

Public Attributes

SdfPath targetPath
 The invalid target or connection path that was authored.
 
SdfPath owningPath
 The path to the property where the target was authored.
 
SdfSpecType ownerSpecType
 The spec type of the property where the target was authored.
 
SdfLayerHandle layer
 The layer containing the property where the target was authored.
 
SdfPath composedTargetPath
 The target or connection path in the composed scene.
 
- 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.
 

Protected Member Functions

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

Detailed Description

Base class for composition errors related to target or connection paths.

Definition at line 442 of file errors.h.

Constructor & Destructor Documentation

◆ ~PcpErrorTargetPathBase()

PCP_API ~PcpErrorTargetPathBase ( )
override

Destructor.

Member Data Documentation

◆ composedTargetPath

SdfPath composedTargetPath

The target or connection path in the composed scene.

If this path could not be translated to the composed scene (e.g., in the case of an invalid external target path), this path will be empty.

Definition at line 460 of file errors.h.

◆ layer

SdfLayerHandle layer

The layer containing the property where the target was authored.

Definition at line 454 of file errors.h.

◆ ownerSpecType

SdfSpecType ownerSpecType

The spec type of the property where the target was authored.

Definition at line 452 of file errors.h.

◆ owningPath

SdfPath owningPath

The path to the property where the target was authored.

Definition at line 450 of file errors.h.

◆ targetPath

SdfPath targetPath

The invalid target or connection path that was authored.

Definition at line 448 of file errors.h.


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