HDK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
OP3D_InputSelectorBase Class Referenceabstract

#include <OP3D_InputSelectorBase.h>

+ Inheritance diagram for OP3D_InputSelectorBase:

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_ValuefinishedValue ()
 
const UI_ValuefinishedValue () 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_SelectorTemplategetTemplate ()
 
const PI_SelectorTemplategetTemplate () 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_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 *)
 

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_NodegetNodeFromPath (const char *path)
 
static const SIM_ObjectgetSimObjectFromPath (const char *path)
 
static const SIM_DatagetSimModifierFromPath (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_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)
 

Protected Member Functions

OP3D_View & viewer ()
 
const OP3D_View & viewer () const
 
DM_Workbench & workbench ()
 
const DM_Workbench & workbench () const
 
void setFinishedValuePtr (UI_Value *new_value)
 
UI_ValuegetFinishedValuePtr () const
 
void setLocatedValuePtr (UI_Value *new_value)
 
UI_ValuegetLocatedValuePtr () const
 
void setSelectionStylePtr (UI_Value *new_value)
 
UI_ValuegetSelectionStylePtr () const
 
DM_SelectionStyle selectionStyle () const
 
void setVisiblePickPtr (UI_Value *new_value)
 
UI_ValuegetVisiblePickPtr () const
 
bool getVisiblePick () const
 
void setContainedPickPtr (UI_Value *new_value)
 
UI_ValuegetContainedPickPtr () const
 
bool getContainedPick () const
 
void setSelectionRulePtr (UI_Value *new_value)
 
UI_ValuegetSelectionRulePtr () const
 
GU_SelectionRule selectionRule () const
 
void selectionRule (GU_SelectionRule srule)
 
SI_Brush * getPickBrushPtr () const
 
SI_Brush * getPickLaserPtr () const
 
SI_Lasso * getPickLassoPtr () const
 
bool isDragSelectActive () const
 
virtual bool needObjectPick () const
 
bool selectModeMatchesTemplateType ()
 
bool pickChosenOp (UT_Array< GR_PickRecord > &pick_records, bool *changed=nullptr)
 
GU_ConstDetailHandle getGeometryFromPickRecord (const GR_PickRecord &pick, GUI_DetailLook **detail_look=nullptr)
 
virtual OP_NodeswitchToChosenOp (OP_Node *parent, bool *changed=nullptr)
 
virtual void saveForUndo ()
 
virtual bool getPickName (const OP3D_PickId &pickid, UT_String &name, bool descriptivename) const =0
 
void enablePicker (UI_Event *event)
 
void disablePicker ()
 
void disableActivePicking ()
 
bool isActivePicking () const
 
virtual void handleBoxPick (UI_Event *event)
 
virtual void activeBoxPick (UI_Event *event)
 
virtual void handleLassoPick (UI_Event *event)
 
virtual void activeLassoPick (UI_Event *event)
 
virtual void handleBrushPick (UI_Event *event)
 
virtual void activeBrushPick (UI_Event *event)
 
virtual void handleLaserPick (UI_Event *event)
 
virtual void activeLaserPick (UI_Event *event)
 
bool visibleSelectToggle (UI_Event *event, const char *echo_hotkey)
 
bool containedSelectToggle (UI_Event *event, const char *echo_hotkey)
 
const UT_StringArraydrawableMask () const override
 
void onLocateDrawableSelection () override
 
unsigned drawablePickMask (unsigned pick_mask) const
 
bool filterDrawable (const char *drawable_name) const
 
ProxyHandle getProxy ()
 
ConstProxyHandle getProxy () const
 
- Protected Member Functions inherited from BM_InputSelector
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 ()
 

Static Protected Member Functions

static fpreal getTime ()
 
- 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)
 

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
 

Detailed Description

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.

Member Typedef Documentation

Constructor & Destructor Documentation

OP3D_InputSelectorBase::OP3D_InputSelectorBase ( OP3D_View &  viewer,
PI_SelectorTemplate templ 
)
OP3D_InputSelectorBase::~OP3D_InputSelectorBase ( )
override

Member Function Documentation

virtual void OP3D_InputSelectorBase::activeBoxPick ( UI_Event event)
protectedvirtual
virtual void OP3D_InputSelectorBase::activeBrushPick ( UI_Event event)
protectedvirtual
virtual void OP3D_InputSelectorBase::activeLaserPick ( UI_Event event)
protectedvirtual
virtual void OP3D_InputSelectorBase::activeLassoPick ( UI_Event event)
protectedvirtual
bool OP3D_InputSelectorBase::allowDragging ( ) const
inline

Definition at line 117 of file OP3D_InputSelectorBase.h.

bool OP3D_InputSelectorBase::allowEmptyQuickSelect ( ) const
inline

Definition at line 140 of file OP3D_InputSelectorBase.h.

bool OP3D_InputSelectorBase::allowFinishing ( ) const
inline

Definition at line 124 of file OP3D_InputSelectorBase.h.

bool OP3D_InputSelectorBase::allowFinishWithExistingSelection ( ) const
bool OP3D_InputSelectorBase::allowQuickSelect ( ) const
inline

Definition at line 135 of file OP3D_InputSelectorBase.h.

bool OP3D_InputSelectorBase::canSelectDrawables ( ) const
overridevirtual

Reimplemented from DM_InputSelector.

bool OP3D_InputSelectorBase::containedSelectToggle ( UI_Event event,
const char *  echo_hotkey 
)
protected
const char* OP3D_InputSelectorBase::cursor ( ) const
overridevirtual

Reimplemented from BM_InputSelector.

void OP3D_InputSelectorBase::disableActivePicking ( )
inlineprotected

Definition at line 364 of file OP3D_InputSelectorBase.h.

void OP3D_InputSelectorBase::disablePicker ( )
protected
void OP3D_InputSelectorBase::doRender ( RE_Render r,
int  x,
int  y,
int  ghost 
)
overridevirtual

Reimplemented from BM_InputSelector.

const UT_StringArray& OP3D_InputSelectorBase::drawableMask ( ) const
overrideprotectedvirtual

Reimplemented from DM_InputSelector.

unsigned OP3D_InputSelectorBase::drawablePickMask ( unsigned  pick_mask) const
protected
void OP3D_InputSelectorBase::enableDrawableSelection ( bool  select_drawables)
void OP3D_InputSelectorBase::enablePicker ( UI_Event event)
protected
bool OP3D_InputSelectorBase::evalStateParm ( const char *  name,
UT_StringHolder ret 
)
overridevirtual

Reimplemented from BM_InputSelector.

bool OP3D_InputSelectorBase::filterDrawable ( const char *  drawable_name) const
protected
UI_Value& OP3D_InputSelectorBase::finishedValue ( )
inline

Definition at line 102 of file OP3D_InputSelectorBase.h.

const UI_Value& OP3D_InputSelectorBase::finishedValue ( ) const
inline

Definition at line 104 of file OP3D_InputSelectorBase.h.

static bool OP3D_InputSelectorBase::getAllowUseExistingSelection ( )
inlinestatic

Definition at line 178 of file OP3D_InputSelectorBase.h.

bool OP3D_InputSelectorBase::getContainedPick ( ) const
inlineprotected

Definition at line 290 of file OP3D_InputSelectorBase.h.

UI_Value* OP3D_InputSelectorBase::getContainedPickPtr ( ) const
inlineprotected

Definition at line 288 of file OP3D_InputSelectorBase.h.

UI_Feel* OP3D_InputSelectorBase::getCustomToolbox ( ) const
overridevirtual

Reimplemented from DM_InputSelector.

UI_Value* OP3D_InputSelectorBase::getFinishedValuePtr ( ) const
inlineprotected

Definition at line 255 of file OP3D_InputSelectorBase.h.

static const char* OP3D_InputSelectorBase::getFloodFillSelectionHotkeyStringRef ( UT_WorkBuffer buffer)
static
static GU_ConstDetailHandle OP3D_InputSelectorBase::getGeometryFromPath ( const char *  path)
static
GU_ConstDetailHandle OP3D_InputSelectorBase::getGeometryFromPickRecord ( const GR_PickRecord pick,
GUI_DetailLook **  detail_look = nullptr 
)
protected
UI_Value* OP3D_InputSelectorBase::getLocatedValuePtr ( ) const
inlineprotected

Definition at line 260 of file OP3D_InputSelectorBase.h.

static const char* OP3D_InputSelectorBase::getLoopSelectionHotkeyStringRef ( UT_WorkBuffer buffer)
static
static OP_Node* OP3D_InputSelectorBase::getNodeFromPath ( const char *  path)
static
SI_Brush* OP3D_InputSelectorBase::getPickBrushPtr ( ) const
inlineprotected

Definition at line 315 of file OP3D_InputSelectorBase.h.

static bool OP3D_InputSelectorBase::getPickingMenuOn ( )
inlinestatic

Definition at line 176 of file OP3D_InputSelectorBase.h.

SI_Brush* OP3D_InputSelectorBase::getPickLaserPtr ( ) const
inlineprotected

Definition at line 316 of file OP3D_InputSelectorBase.h.

SI_Lasso* OP3D_InputSelectorBase::getPickLassoPtr ( ) const
inlineprotected

Definition at line 317 of file OP3D_InputSelectorBase.h.

virtual bool OP3D_InputSelectorBase::getPickName ( const OP3D_PickId pickid,
UT_String name,
bool  descriptivename 
) const
protectedpure virtual

Implemented in OP3D_InputSelector.

DM_SelectMode OP3D_InputSelectorBase::getPreferredSelectMode ( ) const
inline

Definition at line 111 of file OP3D_InputSelectorBase.h.

ProxyHandle OP3D_InputSelectorBase::getProxy ( )
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.

ConstProxyHandle OP3D_InputSelectorBase::getProxy ( ) const
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.

static bool OP3D_InputSelectorBase::getSelectFullLoops ( )
inlinestatic

Definition at line 182 of file OP3D_InputSelectorBase.h.

UI_Value* OP3D_InputSelectorBase::getSelectionRulePtr ( ) const
inlineprotected

Definition at line 299 of file OP3D_InputSelectorBase.h.

UI_Value* OP3D_InputSelectorBase::getSelectionStylePtr ( ) const
inlineprotected

Definition at line 265 of file OP3D_InputSelectorBase.h.

static const SIM_Data* OP3D_InputSelectorBase::getSimModifierFromPath ( const char *  path)
static
static const SIM_Object* OP3D_InputSelectorBase::getSimObjectFromPath ( const char *  path)
static
bool OP3D_InputSelectorBase::getStateParmNames ( UT_StringArray ret,
const char *  prefix = nullptr 
)
overridevirtual

Reimplemented from BM_InputSelector.

static fpreal OP3D_InputSelectorBase::getTime ( )
staticprotected
bool OP3D_InputSelectorBase::getVisiblePick ( ) const
inlineprotected

Definition at line 279 of file OP3D_InputSelectorBase.h.

UI_Value* OP3D_InputSelectorBase::getVisiblePickPtr ( ) const
inlineprotected

Definition at line 277 of file OP3D_InputSelectorBase.h.

virtual void OP3D_InputSelectorBase::handleBoxPick ( UI_Event event)
protectedvirtual
virtual void OP3D_InputSelectorBase::handleBrushPick ( UI_Event event)
protectedvirtual
virtual void OP3D_InputSelectorBase::handleLaserPick ( UI_Event event)
protectedvirtual
virtual void OP3D_InputSelectorBase::handleLassoPick ( UI_Event event)
protectedvirtual
int OP3D_InputSelectorBase::handleMouseWheelEvent ( UI_Event event)
overridevirtual

Reimplemented from BM_InputSelector.

void OP3D_InputSelectorBase::handleSelectionStyleChange ( UI_Event event)
bool OP3D_InputSelectorBase::handleTransitoryKey ( const UI_Event event,
int  hotkey_id 
)
overridevirtual

Reimplemented from DM_InputSelector.

void OP3D_InputSelectorBase::intrusive_ptr_release ( ) const
inline

Definition at line 459 of file OP3D_InputSelectorBase.h.

bool OP3D_InputSelectorBase::isActivePicking ( ) const
inlineprotected

Definition at line 365 of file OP3D_InputSelectorBase.h.

bool OP3D_InputSelectorBase::isDragSelectActive ( ) const
protected
static bool OP3D_InputSelectorBase::isTransitoryLoopSelectionHotkey ( const UI_DeviceEvent state,
int  hotkey_id = 0 
)
static
static bool OP3D_InputSelectorBase::isTransitoryLoopSelectionHotkeyPressed ( DM_Viewport *  viewport,
UT_UniquePtr< DM_HeldHotkeyCache > &  cache 
)
static
bool OP3D_InputSelectorBase::isValid ( ) const
inline

Returns true if the proxy is still pointing to a valid selector.

Definition at line 453 of file OP3D_InputSelectorBase.h.

bool OP3D_InputSelectorBase::justDisplayedOp ( ) const
inline

Definition at line 158 of file OP3D_InputSelectorBase.h.

virtual bool OP3D_InputSelectorBase::needObjectPick ( ) const
protectedvirtual

Reimplemented in OP3D_InputSelector.

void OP3D_InputSelectorBase::onLocateDrawableSelection ( )
overrideprotectedvirtual

Reimplemented from DM_InputSelector.

bool OP3D_InputSelectorBase::pickChosenOp ( UT_Array< GR_PickRecord > &  pick_records,
bool *  changed = nullptr 
)
protected
bool OP3D_InputSelectorBase::pressStateButton ( const char *  name)
overridevirtual

Reimplemented from BM_InputSelector.

virtual void OP3D_InputSelectorBase::saveForUndo ( )
protectedvirtual

Reimplemented in OP3D_InputSelector.

GU_SelectionRule OP3D_InputSelectorBase::selectionRule ( ) const
inlineprotected

Definition at line 301 of file OP3D_InputSelectorBase.h.

void OP3D_InputSelectorBase::selectionRule ( GU_SelectionRule  srule)
inlineprotected

Definition at line 309 of file OP3D_InputSelectorBase.h.

DM_SelectionStyle OP3D_InputSelectorBase::selectionStyle ( ) const
inlineprotected

Definition at line 267 of file OP3D_InputSelectorBase.h.

bool OP3D_InputSelectorBase::selectModeMatchesTemplateType ( )
protected
void OP3D_InputSelectorBase::setAllowDragging ( bool  on)
inline

Definition at line 119 of file OP3D_InputSelectorBase.h.

void OP3D_InputSelectorBase::setAllowEmptyQuickSelect ( bool  on)
inline

Definition at line 142 of file OP3D_InputSelectorBase.h.

void OP3D_InputSelectorBase::setAllowFinishing ( bool  allow_finishing)
inline

Definition at line 126 of file OP3D_InputSelectorBase.h.

void OP3D_InputSelectorBase::setAllowFinishWithExistingSelection ( bool  allow)
void OP3D_InputSelectorBase::setAllowQuickSelect ( bool  on)
inline

Definition at line 137 of file OP3D_InputSelectorBase.h.

static void OP3D_InputSelectorBase::setAllowUseExistingSelection ( bool  val)
inlinestatic

Definition at line 180 of file OP3D_InputSelectorBase.h.

void OP3D_InputSelectorBase::setContainedPickPtr ( UI_Value new_value)
inlineprotected

Definition at line 286 of file OP3D_InputSelectorBase.h.

void OP3D_InputSelectorBase::setDrawableMask ( UT_StringArray const &  drawable_mask)
void OP3D_InputSelectorBase::setFinishedValuePtr ( UI_Value new_value)
inlineprotected

Definition at line 253 of file OP3D_InputSelectorBase.h.

void OP3D_InputSelectorBase::setJustDisplayedOp ( bool  on)
inline

Definition at line 160 of file OP3D_InputSelectorBase.h.

void OP3D_InputSelectorBase::setLocatedValuePtr ( UI_Value new_value)
inlineprotected

Definition at line 258 of file OP3D_InputSelectorBase.h.

static void OP3D_InputSelectorBase::setPickingMenuOn ( bool  val)
inlinestatic

Definition at line 177 of file OP3D_InputSelectorBase.h.

void OP3D_InputSelectorBase::setPreferredSelectMode ( DM_SelectMode  selmode)
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.

static void OP3D_InputSelectorBase::setSelectFullLoops ( bool  val)
inlinestatic

Definition at line 184 of file OP3D_InputSelectorBase.h.

void OP3D_InputSelectorBase::setSelectionRulePtr ( UI_Value new_value)
inlineprotected

Definition at line 297 of file OP3D_InputSelectorBase.h.

void OP3D_InputSelectorBase::setSelectionStylePtr ( UI_Value new_value)
inlineprotected

Definition at line 263 of file OP3D_InputSelectorBase.h.

bool OP3D_InputSelectorBase::setStateParm ( const char *  name,
const UT_StringHolder val 
)
overridevirtual

Reimplemented from BM_InputSelector.

void OP3D_InputSelectorBase::setViewer ( BM_View *  viewer)
overridevirtual

Reimplemented from BM_InputSelector.

void OP3D_InputSelectorBase::setVisiblePickPtr ( UI_Value new_value)
inlineprotected

Definition at line 275 of file OP3D_InputSelectorBase.h.

static void OP3D_InputSelectorBase::showLoopSelectionMessage ( DM_Workbench &  workbench)
static
static void OP3D_InputSelectorBase::showSelectionHintsMessage ( DM_Workbench &  workbench)
static
void OP3D_InputSelectorBase::startSelecting ( )
overridevirtual

Reimplemented from BM_InputSelector.

void OP3D_InputSelectorBase::stopSelecting ( )
overridevirtual

Reimplemented from BM_InputSelector.

virtual OP_Node* OP3D_InputSelectorBase::switchToChosenOp ( OP_Node parent,
bool *  changed = nullptr 
)
protectedvirtual
OP3D_View& OP3D_InputSelectorBase::viewer ( )
inlineprotected
Examples:
SOP/MSS_BrushHairLenSelector.h.

Definition at line 247 of file OP3D_InputSelectorBase.h.

const OP3D_View& OP3D_InputSelectorBase::viewer ( ) const
inlineprotected

Definition at line 248 of file OP3D_InputSelectorBase.h.

bool OP3D_InputSelectorBase::visibleSelectToggle ( UI_Event event,
const char *  echo_hotkey 
)
protected
DM_Workbench& OP3D_InputSelectorBase::workbench ( )
inlineprotected

Definition at line 250 of file OP3D_InputSelectorBase.h.

const DM_Workbench& OP3D_InputSelectorBase::workbench ( ) const
inlineprotected

Definition at line 251 of file OP3D_InputSelectorBase.h.

Friends And Related Function Documentation

Definition at line 479 of file OP3D_InputSelectorBase.h.


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