HDK
|
#include <OP3D_InputSelectorBase.h>
Public Types | |
typedef UT_IntrusivePtr< Proxy > | ProxyHandle |
typedef UT_IntrusivePtr< const Proxy > | ConstProxyHandle |
Public Member Functions | |
OP3D_InputSelectorBase (OP3D_View &viewer, PI_SelectorTemplate &templ) | |
~OP3D_InputSelectorBase () override | |
void | setViewer (BM_View *viewer) override |
void | startSelecting () override |
void | stopSelecting () override |
void | doRender (RE_Render *r, int x, int y, int ghost) override |
UI_Value & | finishedValue () |
const UI_Value & | finishedValue () const |
UI_Feel * | getCustomToolbox () const override |
void | setPreferredSelectMode (DM_SelectMode selmode) |
DM_SelectMode | getPreferredSelectMode () const |
bool | allowDragging () const |
void | setAllowDragging (bool on) |
bool | allowFinishing () const |
void | setAllowFinishing (bool allow_finishing) |
bool | allowFinishWithExistingSelection () const |
void | setAllowFinishWithExistingSelection (bool allow) |
bool | allowQuickSelect () const |
void | setAllowQuickSelect (bool on) |
bool | allowEmptyQuickSelect () const |
void | setAllowEmptyQuickSelect (bool on) |
void | setPriorSelections (const UT_StringArray &paths, const UT_StringArray &ids, const OP3D_SelectionHandles &selections) |
bool | justDisplayedOp () const |
void | setJustDisplayedOp (bool on) |
int | handleMouseWheelEvent (UI_Event *event) override |
bool | handleTransitoryKey (const UI_Event &event, int hotkey_id) override |
const char * | cursor () const override |
void | handleSelectionStyleChange (UI_Event *event) |
bool | getStateParmNames (UT_StringArray &ret, const char *prefix=nullptr) override |
bool | evalStateParm (const char *name, UT_StringHolder &ret) override |
bool | setStateParm (const char *name, const UT_StringHolder &val) override |
bool | pressStateButton (const char *name) override |
bool | canSelectDrawables () const override |
void | enableDrawableSelection (bool select_drawables) |
void | setDrawableMask (UT_StringArray const &drawable_mask) |
bool | isValid () const |
Returns true if the proxy is still pointing to a valid selector. More... | |
void | intrusive_ptr_release () const |
Public Member Functions inherited from DM_InputSelector | |
DM_InputSelector (BM_View &viewer, PI_SelectorTemplate &templ) | |
~DM_InputSelector () override | |
const char * | className () const override |
virtual void | generateAllSelectionStrings (UT_String &sel_string, bool only_one_gdp, bool force_numeric, bool consume_selections) |
virtual void | commitViewportPreSelection (UI_Event *event, GU_SelectionRule sel_rule) |
virtual void | getSelectableLooks (GUI_DetailList &look_list) |
virtual void | getKeyResolveInfo (UI_KeyResolveInfo &info)=0 |
virtual int | handleKeyEvent (int key, UI_Event *event, DM_Viewport &viewport)=0 |
virtual UI_Menu * | getSelectorMenu () const =0 |
virtual UI_Menu * | getSelectorHotkeyMenu () const |
virtual GEO_PrimTypeCompat::TypeMask | primMask () const |
Public Member Functions inherited from BM_InputSelector | |
BM_InputSelector (BM_View &viewer, PI_SelectorTemplate &templ) | |
~BM_InputSelector () override | |
virtual int | handleMouseEvent (UI_Event *event) |
virtual bool | handleDoubleClickEvent (UI_Event *event) |
virtual void | handleNodeDeleted (OP_Node &node) |
PI_SelectorTemplate & | getTemplate () |
const PI_SelectorTemplate & | getTemplate () const |
virtual void | overlayRender (RE_Render *r, int x, int y) |
void | initializeUI () |
virtual int | hasLocates () const |
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_String & | getName () 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_Value * | findValueSymbol (const char *symbol) const |
Find the UI_Value for the given named value symbol. More... | |
UI_Value * | getValueSymbol (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_Object * | getObjectSymbol (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 > | |
T * | findObject (const char *name) const |
template<typename T > | |
T * | findValue (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_Object & | operator= (const UI_Object &)=delete |
virtual int | interestingEvent (UI_EventType t, UI_DeviceEvent *event) const |
virtual void | deleteReferences (UI_Object *to_whom) |
UI_Object * | getParent () 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_ObjectList & | dependents () 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_ValueList & | valueInterests () const |
void | interestedInValue (UI_Value *) |
void | removeValueInterest (UI_Value *) |
void | addKeyDelegateClientship (UI_KeyDelegate *) |
void | removeKeyDelegateClientship (UI_KeyDelegate *) |
Static Public Member Functions | |
static bool | getPickingMenuOn () |
static void | setPickingMenuOn (bool val) |
static bool | getAllowUseExistingSelection () |
static void | setAllowUseExistingSelection (bool val) |
static bool | getSelectFullLoops () |
static void | setSelectFullLoops (bool val) |
static GU_ConstDetailHandle | getGeometryFromPath (const char *path) |
static OP_Node * | getNodeFromPath (const char *path) |
static const SIM_Object * | getSimObjectFromPath (const char *path) |
static const SIM_Data * | getSimModifierFromPath (const char *path) |
static const char * | getFloodFillSelectionHotkeyStringRef (UT_WorkBuffer &buffer) |
static const char * | getLoopSelectionHotkeyStringRef (UT_WorkBuffer &buffer) |
static bool | isTransitoryLoopSelectionHotkey (const UI_DeviceEvent &state, int hotkey_id=0) |
static bool | isTransitoryLoopSelectionHotkeyPressed (DM_Viewport *viewport, UT_UniquePtr< DM_HeldHotkeyCache > &cache) |
static void | showLoopSelectionMessage (DM_Workbench &workbench) |
static void | showSelectionHintsMessage (DM_Workbench &workbench) |
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_Manager * | getManager () |
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 Protected Member Functions | |
static fpreal | getTime () |
Static Protected Member Functions inherited from AP_Interface | |
static void | setTheMainApplication (AP_Interface *app) |
static AP_Interface * | getMainApplication () |
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) |
Friends | |
class | OP3D_InputSelectorBase |
Additional Inherited Members | |
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... | |
Protected Attributes inherited from AP_Interface | |
UT_String | myName |
const char *const * | myValueNames |
UI_EventMethod const * | myMethods |
This reference counted proxy class allows code to check whether a particular selector has been destroyed.
See OP3D_InputSelectorBase::getProxy() for usage details.
Definition at line 73 of file OP3D_InputSelectorBase.h.
typedef UT_IntrusivePtr<const Proxy> OP3D_InputSelectorBase::ConstProxyHandle |
Definition at line 238 of file OP3D_InputSelectorBase.h.
typedef UT_IntrusivePtr<Proxy> OP3D_InputSelectorBase::ProxyHandle |
Definition at line 236 of file OP3D_InputSelectorBase.h.
OP3D_InputSelectorBase::OP3D_InputSelectorBase | ( | OP3D_View & | viewer, |
PI_SelectorTemplate & | templ | ||
) |
|
override |
|
inline |
Definition at line 117 of file OP3D_InputSelectorBase.h.
|
inline |
Definition at line 140 of file OP3D_InputSelectorBase.h.
|
inline |
Definition at line 124 of file OP3D_InputSelectorBase.h.
bool OP3D_InputSelectorBase::allowFinishWithExistingSelection | ( | ) | const |
|
inline |
Definition at line 135 of file OP3D_InputSelectorBase.h.
|
overridevirtual |
Reimplemented from DM_InputSelector.
|
protected |
|
overridevirtual |
Reimplemented from BM_InputSelector.
|
inlineprotected |
Definition at line 364 of file OP3D_InputSelectorBase.h.
|
protected |
Reimplemented from BM_InputSelector.
|
overrideprotectedvirtual |
Reimplemented from DM_InputSelector.
|
protected |
void OP3D_InputSelectorBase::enableDrawableSelection | ( | bool | select_drawables | ) |
|
overridevirtual |
Reimplemented from BM_InputSelector.
|
protected |
|
inline |
Definition at line 102 of file OP3D_InputSelectorBase.h.
|
inline |
Definition at line 104 of file OP3D_InputSelectorBase.h.
|
inlinestatic |
Definition at line 178 of file OP3D_InputSelectorBase.h.
|
inlineprotected |
Definition at line 290 of file OP3D_InputSelectorBase.h.
|
inlineprotected |
Definition at line 288 of file OP3D_InputSelectorBase.h.
|
overridevirtual |
Reimplemented from DM_InputSelector.
|
inlineprotected |
Definition at line 255 of file OP3D_InputSelectorBase.h.
|
static |
|
static |
|
protected |
|
inlineprotected |
Definition at line 260 of file OP3D_InputSelectorBase.h.
|
static |
|
static |
|
inlineprotected |
Definition at line 315 of file OP3D_InputSelectorBase.h.
|
inlinestatic |
Definition at line 176 of file OP3D_InputSelectorBase.h.
|
inlineprotected |
Definition at line 316 of file OP3D_InputSelectorBase.h.
|
inlineprotected |
Definition at line 317 of file OP3D_InputSelectorBase.h.
|
protectedpure virtual |
Implemented in OP3D_InputSelector.
|
inline |
Definition at line 111 of file OP3D_InputSelectorBase.h.
|
inlineprotected |
Obtains the proxy representative used as a reference holder to this selector. This proxy gets invalidated when the selector gets deleted. Invalidation clears the proxy's pointer to NULL, but the proxy's memory stays valid, unlike the memory of this selector object.
Sample usage: void Subclass::method() { ProxyHandle this_proxy(getProxy()); methodThatMayDeleteThis(); if( !this_proxy->isValid() ) return; // abort }
Definition at line 397 of file OP3D_InputSelectorBase.h.
|
inlineprotected |
Obtains the proxy representative used as a reference holder to this selector. This proxy gets invalidated when the selector gets deleted. Invalidation clears the proxy's pointer to NULL, but the proxy's memory stays valid, unlike the memory of this selector object.
Sample usage: void Subclass::method() { ProxyHandle this_proxy(getProxy()); methodThatMayDeleteThis(); if( !this_proxy->isValid() ) return; // abort }
Definition at line 398 of file OP3D_InputSelectorBase.h.
|
inlinestatic |
Definition at line 182 of file OP3D_InputSelectorBase.h.
|
inlineprotected |
Definition at line 299 of file OP3D_InputSelectorBase.h.
|
inlineprotected |
Definition at line 265 of file OP3D_InputSelectorBase.h.
|
static |
|
static |
|
overridevirtual |
Reimplemented from BM_InputSelector.
|
staticprotected |
|
inlineprotected |
Definition at line 279 of file OP3D_InputSelectorBase.h.
|
inlineprotected |
Definition at line 277 of file OP3D_InputSelectorBase.h.
Reimplemented from BM_InputSelector.
|
overridevirtual |
Reimplemented from DM_InputSelector.
|
inline |
Definition at line 459 of file OP3D_InputSelectorBase.h.
|
inlineprotected |
Definition at line 365 of file OP3D_InputSelectorBase.h.
|
protected |
|
static |
|
static |
|
inline |
Returns true if the proxy is still pointing to a valid selector.
Definition at line 453 of file OP3D_InputSelectorBase.h.
|
inline |
Definition at line 158 of file OP3D_InputSelectorBase.h.
|
protectedvirtual |
Reimplemented in OP3D_InputSelector.
|
overrideprotectedvirtual |
Reimplemented from DM_InputSelector.
|
protected |
|
overridevirtual |
Reimplemented from BM_InputSelector.
|
protectedvirtual |
Reimplemented in OP3D_InputSelector.
|
inlineprotected |
Definition at line 301 of file OP3D_InputSelectorBase.h.
|
inlineprotected |
Definition at line 309 of file OP3D_InputSelectorBase.h.
|
inlineprotected |
Definition at line 267 of file OP3D_InputSelectorBase.h.
|
protected |
|
inline |
Definition at line 119 of file OP3D_InputSelectorBase.h.
|
inline |
Definition at line 142 of file OP3D_InputSelectorBase.h.
|
inline |
Definition at line 126 of file OP3D_InputSelectorBase.h.
void OP3D_InputSelectorBase::setAllowFinishWithExistingSelection | ( | bool | allow | ) |
|
inline |
Definition at line 137 of file OP3D_InputSelectorBase.h.
|
inlinestatic |
Definition at line 180 of file OP3D_InputSelectorBase.h.
Definition at line 286 of file OP3D_InputSelectorBase.h.
void OP3D_InputSelectorBase::setDrawableMask | ( | UT_StringArray const & | drawable_mask | ) |
Definition at line 253 of file OP3D_InputSelectorBase.h.
|
inline |
Definition at line 160 of file OP3D_InputSelectorBase.h.
Definition at line 258 of file OP3D_InputSelectorBase.h.
|
inlinestatic |
Definition at line 177 of file OP3D_InputSelectorBase.h.
|
inline |
Definition at line 109 of file OP3D_InputSelectorBase.h.
void OP3D_InputSelectorBase::setPriorSelections | ( | const UT_StringArray & | paths, |
const UT_StringArray & | ids, | ||
const OP3D_SelectionHandles & | selections | ||
) |
Tells the selector about previous selection information that we still want to display in the viewport, but which is not part of the current selection operation.
|
inlinestatic |
Definition at line 184 of file OP3D_InputSelectorBase.h.
Definition at line 297 of file OP3D_InputSelectorBase.h.
Definition at line 263 of file OP3D_InputSelectorBase.h.
|
overridevirtual |
Reimplemented from BM_InputSelector.
|
overridevirtual |
Reimplemented from BM_InputSelector.
Definition at line 275 of file OP3D_InputSelectorBase.h.
|
static |
|
static |
|
overridevirtual |
Reimplemented from BM_InputSelector.
|
overridevirtual |
Reimplemented from BM_InputSelector.
|
protectedvirtual |
|
inlineprotected |
Definition at line 247 of file OP3D_InputSelectorBase.h.
|
inlineprotected |
Definition at line 248 of file OP3D_InputSelectorBase.h.
|
protected |
|
inlineprotected |
Definition at line 250 of file OP3D_InputSelectorBase.h.
|
inlineprotected |
Definition at line 251 of file OP3D_InputSelectorBase.h.
|
friend |
Definition at line 479 of file OP3D_InputSelectorBase.h.