HDK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
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, int nodeid, const HUSD_TimeCode &tc, UT_StringArray *errors=nullptr)
 
bool addReverseLinkItems (const HUSD_FindPrims &linkSource, const HUSD_FindPrims &includeprims, const HUSD_FindPrims &excludeprims, int nodeid, const HUSD_TimeCode &tc, UT_StringArray *errors=nullptr)
 
bool createCollections (UT_StringArray *errors=nullptr)
 Create the collections necessary for all links previously added. More...
 
void clear ()
 Clear all added links. More...
 

Detailed Description

Definition at line 35 of file HUSD_EditLinkCollections.h.

Member Enumeration Documentation

Enumerator
LightLink 
ShadowLink 
MaterialLink 

Definition at line 38 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,
int  nodeid,
const HUSD_TimeCode tc,
UT_StringArray errors = nullptr 
)

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,
int  nodeid,
const HUSD_TimeCode tc,
UT_StringArray errors = nullptr 
)

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.

void HUSD_EditLinkCollections::clear ( )

Clear all added links.

bool HUSD_EditLinkCollections::createCollections ( UT_StringArray errors = nullptr)

Create the collections necessary for all links previously added.


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