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

#include <SOP_ObjectAppearance.h>

+ Inheritance diagram for SOP_ObjectAppearance:

Public Types

typedef UT_Set< std::string > PrimList
 

Public Member Functions

 SOP_ObjectAppearance ()
 
virtual ~SOP_ObjectAppearance ()
 
virtual bool isGeometricObject () const =0
 
virtual bool applyEdits ()=0
 Edits are not guaranteed to be applied until this method is called. More...
 
virtual bool getLeafPaths (UT_StringArray &paths) const
 Get list of all possible paths for the leaf nodes in the tree. More...
 
virtual GA_Offset getPrimitiveOffset (const char *path) const
 Return the list of primitives which match the given path. More...
 
virtual bool getLightSelection (UT_TagManager &tags, const std::string &path_head, UT_Set< std::string > &selected_paths, const char *tag) const
 
virtual bool editLightSelection (UT_TagManager &tags, const std::string &path_head, const UT_Set< std::string > &selected_paths, const char *tag)
 
virtual bool visibility (GA_Offset prim, bool &visible) const
 
virtual bool setVisibility (const char *path, bool visible)
 
virtual bool setVisibility (const PrimList &prims, bool visible)
 
virtual bool viewportLOD (GA_Offset prim, GEO_ViewportLOD &lod) const
 
virtual bool setViewportLOD (const char *path, GEO_ViewportLOD l)
 
virtual bool setViewportLOD (const PrimList &prims, GEO_ViewportLOD l)
 
virtual bool material (GA_Offset prim, std::string &material) const
 
virtual bool setMaterial (const char *path, const char *material)
 
virtual bool setMaterial (const PrimList &prims, const char *material)
 
virtual bool lightSelection (GA_Offset prim, std::string &light_selection) const
 
virtual bool lightSelection (const char *path, std::string &light_selection) const
 
virtual bool setLightSelection (const char *path, const char *light_selection)
 
virtual bool setLightSelection (const PrimList &prims, const char *light_selection)
 
- Public Member Functions inherited from UT_IntrusiveRefCounter< SOP_ObjectAppearance >
SYS_FORCE_INLINE UT_IntrusiveRefCounter () noexcept
 Default constructor: Sets counter to 0. More...
 
SYS_FORCE_INLINE UT_IntrusiveRefCounter (const UT_IntrusiveRefCounter &) noexcept
 Copy constructor: Sets counter to 0. More...
 
UT_IntrusiveRefCounter & operator= (const UT_IntrusiveRefCounter &) noexcept
 Assignment operator: Does not modify counter. More...
 
SYS_FORCE_INLINE uint32 use_count () const noexcept
 Return current counter. More...
 
SYS_FORCE_INLINE bool conditionalAddRef () noexcept
 

Additional Inherited Members

- Protected Member Functions inherited from UT_IntrusiveRefCounter< SOP_ObjectAppearance >
SYS_FORCE_INLINE ~UT_IntrusiveRefCounter ()
 Destructor: Only derived classes can destruct this. More...
 

Detailed Description

Definition at line 24 of file SOP_ObjectAppearance.h.

Member Typedef Documentation

typedef UT_Set<std::string> SOP_ObjectAppearance::PrimList

Definition at line 28 of file SOP_ObjectAppearance.h.

Constructor & Destructor Documentation

SOP_ObjectAppearance::SOP_ObjectAppearance ( )
virtual SOP_ObjectAppearance::~SOP_ObjectAppearance ( )
virtual

Member Function Documentation

virtual bool SOP_ObjectAppearance::applyEdits ( )
pure virtual

Edits are not guaranteed to be applied until this method is called.

virtual bool SOP_ObjectAppearance::editLightSelection ( UT_TagManager &  tags,
const std::string &  path_head,
const UT_Set< std::string > &  selected_paths,
const char *  tag 
)
virtual

Set light selection for a given tag. This should remove the tag from all paths not referenced in the selection list. The path_head should be ignored from each path in the selection.

virtual bool SOP_ObjectAppearance::getLeafPaths ( UT_StringArray &  paths) const
virtual

Get list of all possible paths for the leaf nodes in the tree.

virtual bool SOP_ObjectAppearance::getLightSelection ( UT_TagManager &  tags,
const std::string &  path_head,
UT_Set< std::string > &  selected_paths,
const char *  tag 
) const
virtual

Add all paths to the selected_paths. Each path in the appearance which matches the given tag should be prefixed by the path_head before it's added to the set.

virtual GA_Offset SOP_ObjectAppearance::getPrimitiveOffset ( const char *  path) const
virtual

Return the list of primitives which match the given path.

virtual bool SOP_ObjectAppearance::isGeometricObject ( ) const
pure virtual

Return true if the object is a geometric object, which supports per-primitive settings. If false, then the first argument to the setters and getters is ignored (const char *, and GA_Offset), and the PrimList setters will fail.

virtual bool SOP_ObjectAppearance::lightSelection ( GA_Offset  prim,
std::string &  light_selection 
) const
virtual

Get/Set the light selection expression for the given primitive.

virtual bool SOP_ObjectAppearance::lightSelection ( const char *  path,
std::string &  light_selection 
) const
virtual

Get/Set the light selection expression for the given primitive.

virtual bool SOP_ObjectAppearance::material ( GA_Offset  prim,
std::string &  material 
) const
virtual

Get/Set the material for the given primitive.

virtual bool SOP_ObjectAppearance::setLightSelection ( const char *  path,
const char *  light_selection 
)
virtual

Get/Set the light selection expression for the given primitive.

virtual bool SOP_ObjectAppearance::setLightSelection ( const PrimList &  prims,
const char *  light_selection 
)
virtual

Get/Set the light selection expression for the given primitive.

virtual bool SOP_ObjectAppearance::setMaterial ( const char *  path,
const char *  material 
)
virtual

Get/Set the material for the given primitive.

virtual bool SOP_ObjectAppearance::setMaterial ( const PrimList &  prims,
const char *  material 
)
virtual

Get/Set the material for the given primitive.

virtual bool SOP_ObjectAppearance::setViewportLOD ( const char *  path,
GEO_ViewportLOD  l 
)
virtual

Get/Set the viewport LOD for the given primitive.

virtual bool SOP_ObjectAppearance::setViewportLOD ( const PrimList &  prims,
GEO_ViewportLOD  l 
)
virtual

Get/Set the viewport LOD for the given primitive.

virtual bool SOP_ObjectAppearance::setVisibility ( const char *  path,
bool  visible 
)
virtual

Get/Set the viewport visibility for the given primitive.

virtual bool SOP_ObjectAppearance::setVisibility ( const PrimList &  prims,
bool  visible 
)
virtual

Get/Set the viewport visibility for the given primitive.

virtual bool SOP_ObjectAppearance::viewportLOD ( GA_Offset  prim,
GEO_ViewportLOD &  lod 
) const
virtual

Get/Set the viewport LOD for the given primitive.

virtual bool SOP_ObjectAppearance::visibility ( GA_Offset  prim,
bool &  visible 
) const
virtual

Get/Set the viewport visibility for the given primitive.

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