HDK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
BM_InputSelector Class Reference

#include <BM_InputSelector.h>

+ Inheritance diagram for BM_InputSelector:

Public Member Functions

 BM_InputSelector (BM_View &viewer, PI_SelectorTemplate &templ)
 
 ~BM_InputSelector () override
 
const char * className () const override
 
virtual int handleMouseEvent (UI_Event *event)
 
virtual int handleMouseWheelEvent (UI_Event *event)
 
virtual bool handleDoubleClickEvent (UI_Event *event)
 
virtual void handleNodeDeleted (OP_Node &node)
 
PI_SelectorTemplategetTemplate ()
 
const PI_SelectorTemplategetTemplate () const
 
virtual void setViewer (BM_View *viewer)
 
virtual void doRender (RE_Render *r, int x, int y, int ghost)
 
virtual void overlayRender (RE_Render *r, int x, int y)
 
void initializeUI ()
 
virtual int hasLocates () const
 
virtual void startSelecting ()
 
virtual void stopSelecting ()
 
virtual const char * cursor () const
 
virtual bool getStateParmNames (UT_StringArray &ret, const char *prefix=nullptr)
 
virtual bool evalStateParm (const char *name, UT_StringHolder &ret)
 
virtual bool setStateParm (const char *name, const UT_StringHolder &val)
 
virtual bool pressStateButton (const char *name)
 
- Public Member Functions inherited from AP_Interface
 AP_Interface ()
 
 AP_Interface (const char *myname, const char *const *names, UI_EventMethod const *methods)
 
 ~AP_Interface () override
 
const char * className () const override
 
const UT_StringgetName () const
 Return the name passed in the constructor. More...
 
void wireInterface (UI_Manager *uims)
 
void unwireInterface (UI_Manager *uims)
 
bool readUIFile (const char *ui_filename, bool quiet=false)
 
bool readPreferenceFile (const char *pref_filename, bool quiet=false)
 
void setValueSymbol (const char *symbol, UI_Value *value, bool warn=true)
 
UI_ValuefindValueSymbol (const char *symbol) const
 Find the UI_Value for the given named value symbol. More...
 
UI_ValuegetValueSymbol (const char *symbol, int create=1)
 
int getValueSymbols (UT_StringArray &symbols, UT_Array< UI_Value * > &values) const
 
void setObjectSymbol (const char *symbol, UI_Object *who, int warn=1)
 
UI_ObjectgetObjectSymbol (const char *symbol) const
 
UI_Feel * getFeelSymbol (const char *symbol) const
 
UI_Feel * findValueFeel (UI_Value *value) const
 
int getFeelSymbols (UT_StringArray &symbols, UT_Array< UI_Feel * > &feels) const
 
void setKeyDelegateSymbol (const char *symbol, UI_KeyDelegateSPtr delegate, bool warn=true)
 
bool hasKeyDelegateSymbol (const char *symbol) const
 Returns whether the current key delegate symbol is defined. More...
 
UI_KeyDelegateSPtr findKeyDelegateSymbol (const char *symbol) const
 Find the UI_KeyDelegate for the given named key delegate symbol. More...
 
UI_KeyDelegateSPtr getKeyDelegateSymbol (const char *symbol, int create=1)
 
void removeObjectSymbol (const char *symbol)
 Delete the entry for the given object symbol name. More...
 
void removeValueSymbol (const char *symbol)
 Delete the entry for the given value symbol name. More...
 
template<typename T >
TfindObject (const char *name) const
 
template<typename T >
TfindValue (const char *name) const
 
virtual void outputUsage (int argc, const char **argv) const
 
void resetApplication ()
 
void handleEvent (UI_Event *event) override
 
virtual int saveAppData (const char *filename)
 
virtual int loadAppState ()
 
virtual int saveAppState ()
 
virtual void saveOnCoreDump ()
 
virtual bool getCoreDumpFileName (UT_WorkBuffer &name)
 
bool loadUIInitPrefs ()
 
void saveUIInitPrefs (const char *layout_level, fpreal uiscale, int playbarui)
 
bool restoreUIInitPrefs ()
 
bool getFunctionKeyScript (int key, UI_Event *event, UT_String &script)
 
void setKeyBindingProxySrc (const char *symbol, UI_Feel *src, bool warn=true)
 
void addKeyBindingProxyRef (const char *symbol, UI_Feel *ref, bool warn=true)
 
- Public Member Functions inherited from UI_Object
 UI_Object ()
 
virtual ~UI_Object ()
 
 UI_Object (const UI_Object &)=delete
 
UI_Objectoperator= (const UI_Object &)=delete
 
virtual int interestingEvent (UI_EventType t, UI_DeviceEvent *event) const
 
virtual void deleteReferences (UI_Object *to_whom)
 
UI_ObjectgetParent () const
 
void setParent (UI_Object *p)
 
bool isAncestor (const UI_Object *who) const
 
void addDependent (UI_Object *who)
 
bool removeDependent (UI_Object *who)
 
bool replaceDependent (UI_Object *who, UI_Object *with)
 
bool isDependent (UI_Object *who) const
 
bool hasDependents () const
 
const UI_ObjectListdependents () const
 
void sendEvent (const UI_Event &e) const
 
void distributeEvent (UI_Event *event, int upwards)
 
void relayEvent (UI_Event *event, UI_Object *target)
 
void generateEvent (UI_EventType t, UI_Object *target)
 
void purgeEvents (UI_EventType t, UI_Object *target, UI_EventMethod method=0)
 
void triggerImmediateEvent (UI_Event *event, int upwards)
 
int getProxyId ()
 
void bumpQueueCount (int dir)
 
void setName (const char *symbolName)
 
const char * getName () const
 
void buildFullPath (UT_WorkBuffer &string) const
 
void debugQueueEventsFor (const UI_Value *value, const char *name, UI_EventType t=UI_EVENT_NO_EVENT) const
 
const UI_ValueListvalueInterests () const
 
void interestedInValue (UI_Value *)
 
void removeValueInterest (UI_Value *)
 
void addKeyDelegateClientship (UI_KeyDelegate *)
 
void removeKeyDelegateClientship (UI_KeyDelegate *)
 

Protected Member Functions

BM_View & baseViewer ()
 
const BM_View & baseViewer () const
 
void initApplication (UI_Manager *, int, const char **) override
 
- Protected Member Functions inherited from AP_Interface
UI_NamedValueMapgetValueTable () const
 
UI_NamedObjectMapgetObjectTable () const
 
void processKeyBindingProxyRequests ()
 
- Protected Member Functions inherited from UI_Object
UI_ObjectListdependents ()
 
virtual void preTerminateCallback ()
 

Additional Inherited Members

- Static Public Member Functions inherited from AP_Interface
static FILE * createPreferenceFile (const char *filename)
 
static int mapStrToInt (const char *label, const std::pair< const char *, int > *map)
 
static const char * mapIntToStr (int index, const std::pair< const char *, int > *map)
 
static void setAppExitCode (int exit_code)
 
static int getAppExitCode ()
 
static bool isAppExiting ()
 Returns true if the application is exiting. More...
 
static const char * getStartupDesktop ()
 
- Static Public Member Functions inherited from UI_Object
static UI_ManagergetManager ()
 
static UI_Queue * getInputQueue ()
 
static int keycmp (const char *, int key)
 
static int keycmp (const char *, int key, const UI_HotkeyEcho &)
 
static void keyEcho (const char *, const UI_HotkeyEcho &)
 
static void actionKeyEcho (const char *, const char *custom_suffix=0)
 
static void toggleKeyEcho (const char *, bool new_value)
 
- Static Public Attributes inherited from AP_Interface
static const std::pair< const
char *, int
theFileChooserStyleMap []
 Menu items and their mapping for file chooser style preference. More...
 
- Static Protected Member Functions inherited from AP_Interface
static void setTheMainApplication (AP_Interface *app)
 
static AP_InterfacegetMainApplication ()
 
static void clearTheMainApplication ()
 
static void loadWindowGeometry (UI_Window *window, bool default_maximized, bool use_pref)
 
static bool getWindowGeometry (int &width, int &height, int &left, int &bottom, bool &maximized, bool use_pref)
 
static bool getSaveWindowGeoPref ()
 
static void saveWindowGeoPref ()
 
static bool loadWindowGeoPref (int &w, int &h, int &left, int &bottom, bool &maximized)
 
- Protected Attributes inherited from AP_Interface
UT_String myName
 
const char *constmyValueNames
 
UI_EventMethod constmyMethods
 

Detailed Description

Constructor & Destructor Documentation

BM_InputSelector::BM_InputSelector ( BM_View &  viewer,
PI_SelectorTemplate templ 
)
BM_InputSelector::~BM_InputSelector ( )
override

Member Function Documentation

BM_View& BM_InputSelector::baseViewer ( )
inlineprotected

Definition at line 81 of file BM_InputSelector.h.

const BM_View& BM_InputSelector::baseViewer ( ) const
inlineprotected

Definition at line 82 of file BM_InputSelector.h.

const char* BM_InputSelector::className ( ) const
overridevirtual
virtual const char* BM_InputSelector::cursor ( ) const
virtual

Reimplemented in OP3D_InputSelectorBase.

virtual void BM_InputSelector::doRender ( RE_Render r,
int  x,
int  y,
int  ghost 
)
virtual
virtual bool BM_InputSelector::evalStateParm ( const char *  name,
UT_StringHolder ret 
)
inlinevirtual

Reimplemented in OP3D_InputSelector, and OP3D_InputSelectorBase.

Definition at line 77 of file BM_InputSelector.h.

virtual bool BM_InputSelector::getStateParmNames ( UT_StringArray ret,
const char *  prefix = nullptr 
)
inlinevirtual

Reimplemented in OP3D_InputSelector, and OP3D_InputSelectorBase.

Definition at line 76 of file BM_InputSelector.h.

PI_SelectorTemplate& BM_InputSelector::getTemplate ( )
inline

Definition at line 44 of file BM_InputSelector.h.

const PI_SelectorTemplate& BM_InputSelector::getTemplate ( ) const
inline

Definition at line 45 of file BM_InputSelector.h.

virtual bool BM_InputSelector::handleDoubleClickEvent ( UI_Event event)
virtual

Reimplemented in OP3D_InputSelector.

virtual int BM_InputSelector::handleMouseEvent ( UI_Event event)
virtual

Reimplemented in OP3D_InputSelector.

virtual int BM_InputSelector::handleMouseWheelEvent ( UI_Event event)
virtual

Reimplemented in OP3D_InputSelectorBase.

virtual void BM_InputSelector::handleNodeDeleted ( OP_Node node)
virtual
virtual int BM_InputSelector::hasLocates ( ) const
inlinevirtual

Reimplemented in OP3D_InputSelector.

Definition at line 66 of file BM_InputSelector.h.

void BM_InputSelector::initApplication ( UI_Manager uims,
int  argc,
const char **  argv 
)
overrideprotectedvirtual

Initialize this object. This method is intended to be overriden by subclasses since the base class implementation is empty. The subclass typically calls readUIFile() here to create the interface which populates the object and value symbols.

Reimplemented from AP_Interface.

void BM_InputSelector::initializeUI ( )
virtual void BM_InputSelector::overlayRender ( RE_Render r,
int  x,
int  y 
)
virtual
virtual bool BM_InputSelector::pressStateButton ( const char *  name)
inlinevirtual

Reimplemented in OP3D_InputSelector, and OP3D_InputSelectorBase.

Definition at line 79 of file BM_InputSelector.h.

virtual bool BM_InputSelector::setStateParm ( const char *  name,
const UT_StringHolder val 
)
inlinevirtual

Reimplemented in OP3D_InputSelector, and OP3D_InputSelectorBase.

Definition at line 78 of file BM_InputSelector.h.

virtual void BM_InputSelector::setViewer ( BM_View *  viewer)
virtual
virtual void BM_InputSelector::startSelecting ( )
virtual
virtual void BM_InputSelector::stopSelecting ( )
virtual

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