HDK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Public Types | Public Member Functions | List of all members
HUSD_EditLinkCollections Class Reference

#include <HUSD_EditLinkCollections.h>

Public Types

enum  LinkType { LightLink, ShadowLink, MaterialLink }
 

Public Member Functions

 HUSD_EditLinkCollections (HUSD_AutoWriteLock &lock, LinkType linktype)
 
 ~HUSD_EditLinkCollections ()
 
bool addLinkItems (const HUSD_FindPrims &linkSource, const HUSD_FindPrims &includeprims, const HUSD_FindPrims &excludeprims, const UT_StringHolder &pathexpr, const UT_StringRef &linkid)
 
bool addReverseLinkItems (const HUSD_FindPrims &linkSource, const HUSD_FindPrims &includeprims, const HUSD_FindPrims &excludeprims, const UT_StringHolder &pathexpr, const UT_StringRef &linkid)
 
bool createCollections (UT_String *error_message=nullptr)
 Create the collections necessary for all links previously added. More...
 

Detailed Description

Definition at line 36 of file HUSD_EditLinkCollections.h.

Member Enumeration Documentation

enum HUSD_EditLinkCollections::LinkType
Enumerator
LightLink 
ShadowLink 
MaterialLink 

Definition at line 39 of file HUSD_EditLinkCollections.h.

Constructor & Destructor Documentation

HUSD_EditLinkCollections::HUSD_EditLinkCollections ( HUSD_AutoWriteLock &  lock,
LinkType  linktype 
)
HUSD_EditLinkCollections::~HUSD_EditLinkCollections ( )

Member Function Documentation

bool HUSD_EditLinkCollections::addLinkItems ( const HUSD_FindPrims &  linkSource,
const HUSD_FindPrims &  includeprims,
const HUSD_FindPrims &  excludeprims,
const UT_StringHolder &  pathexpr,
const UT_StringRef &  linkid 
)

Add a link whose source is the prim that will contain the collection that defines the link. This does not create the collections.

bool HUSD_EditLinkCollections::addReverseLinkItems ( const HUSD_FindPrims &  linkSource,
const HUSD_FindPrims &  includeprims,
const HUSD_FindPrims &  excludeprims,
const UT_StringHolder &  pathexpr,
const UT_StringRef &  linkid 
)

Add a link whose source is NOT the prim that will contain the collection that defines the link, but rather the prims in the link's include and excludes lists will contain the collection that defines the link. This does not create the collections.

bool HUSD_EditLinkCollections::createCollections ( UT_String *  error_message = nullptr)

Create the collections necessary for all links previously added.

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