DT_Plugin.h File Reference

#include "DTUI_API.h"
#include "DT_ViewportProvider.h"
#include <OP/OP_Output.h>
#include <OP/OP_Value.h>
#include <GA/GA_Types.h>
#include <UT/UT_Array.h>
#include <UT/UT_Assert.h>
#include <UT/UT_Error.h>
#include <UT/UT_NonCopyable.h>
#include <UT/UT_SharedPtr.h>
#include <UT/UT_Set.h>
#include <UT/UT_StringArray.h>
#include <UT/UT_StringHolder.h>
#include <UT/UT_WorkBuffer.h>
#include <SYS/SYS_Math.h>
#include <SYS/SYS_Types.h>
#include <SYS/SYS_Visibility.h>
#include <float.h>
#include <hboost/any.hpp>
#include <iosfwd>

Include dependency graph for DT_Plugin.h:

Go to the source code of this file.

Classes
class	DT_MenuItem
class	DT_NodeMenuItem
class	DT_Value
	Opaque data type to pass values of any type across boundaries. More...
class	DT_ParmDef
class	DT_ParmDefToggle
class	DT_ParmDefInteger
class	DT_ParmDefFloat
class	DT_ParmDefColor
class	DT_ParmDefString
class	DT_ParmDefMenu
class	DT_ParmDefPath
class	DT_ParmDefButton
class	DT_ParmDefGrouped
class	DT_Node
class	DT_Host
class	DT_Plugin
class	DT_PluginFactory

Macros
#define	DT_LODCHOOSER_PLUGIN_NAME   "Object Appearance"
#define	DT_LIGHTBANK_PLUGIN_NAME   "Light Bank"
#define	DT_STYLER_PLUGIN_NAME   "Material Style Sheets"

Typedefs
typedef UT_Array< DT_MenuItem >	DT_MenuItemList
typedef UT_Array< DT_NodeMenuItem >	DT_NodeMenuItemList
typedef UT_SharedPtr< DT_ParmDef >	DT_ParmDefPtr
typedef UT_SharedPtr< const DT_ParmDef >	DT_ParmDefHandle
typedef UT_Array < DT_ParmDefHandle >	DT_ParmDefList
typedef exint	DT_NodeId
	A unique node identifier. More...
typedef UT_Array< DT_NodeId >	DT_NodeIdList
	A flat list of node identifiers. More...
typedef UT_Set< DT_NodeId >	DT_NodeIdSet
	An unordered set of unique node identifiers. More...
typedef UT_SharedPtr< const DT_Node >	DT_NodeHandle
typedef UT_Array< DT_NodeHandle >	DT_NodeList
typedef UT_SharedPtr< DT_Plugin >	DT_PluginHandle

Functions
SYS_VISIBILITY_EXPORT void	newDataTreePluginFactory ()

Macro Definition Documentation

#define DT_LIGHTBANK_PLUGIN_NAME   "Light Bank"

Definition at line 37 of file DT_Plugin.h.

#define DT_LODCHOOSER_PLUGIN_NAME   "Object Appearance"

Definition at line 36 of file DT_Plugin.h.

#define DT_STYLER_PLUGIN_NAME   "Material Style Sheets"

Definition at line 38 of file DT_Plugin.h.

Typedef Documentation

typedef UT_Array<DT_MenuItem> DT_MenuItemList

Definition at line 74 of file DT_Plugin.h.

typedef UT_SharedPtr<const DT_Node> DT_NodeHandle

Definition at line 790 of file DT_Plugin.h.

typedef exint DT_NodeId

A unique node identifier.

Definition at line 727 of file DT_Plugin.h.

typedef UT_Array<DT_NodeId> DT_NodeIdList

A flat list of node identifiers.

Definition at line 730 of file DT_Plugin.h.

typedef UT_Set<DT_NodeId> DT_NodeIdSet

An unordered set of unique node identifiers.

Definition at line 733 of file DT_Plugin.h.

typedef UT_Array<DT_NodeHandle> DT_NodeList

Definition at line 792 of file DT_Plugin.h.

typedef UT_Array<DT_NodeMenuItem> DT_NodeMenuItemList

Definition at line 109 of file DT_Plugin.h.

typedef UT_SharedPtr<const DT_ParmDef> DT_ParmDefHandle

Definition at line 284 of file DT_Plugin.h.

typedef UT_Array<DT_ParmDefHandle> DT_ParmDefList

Definition at line 285 of file DT_Plugin.h.

typedef UT_SharedPtr<DT_ParmDef> DT_ParmDefPtr

Definition at line 283 of file DT_Plugin.h.

typedef UT_SharedPtr<DT_Plugin> DT_PluginHandle

Definition at line 1192 of file DT_Plugin.h.

Function Documentation

SYS_VISIBILITY_EXPORT void newDataTreePluginFactory

(

)

All DSOs that provide a Data Tree plugin factory should implement this function. All it needs to do is to create the appropriate DT_PluginFactory for the plugin(s) it implements. Example:

class MyDataTreePlugin : public DT_Plugin { ... };
   
class MyDataTreePluginFactory : public DT_PluginFactory
{
public:
  MyDataTreePluginFactory()
  {
    registerFactory(*this);
  }

  virtual const char *name() const { return "My Data Tree Plugin"; }
 
  virtual DT_PluginHandle create(DT_Host &host)
  { 
    return DT_PluginHandle(new MyDataTreePlugin(host));
  }
};

UT_UniquePtr<MyDataTreePluginFactory> theFactory;

SYS_VISIBILITY_EXPORT void newDataTreePluginFactory()
{
  theFactory.reset(new MyDataTreePluginFactory);
}