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

#include <OP3D_InputSelectorBase.h>

+ Inheritance diagram for OP3D_InputSelectorBase:

Public Member Functions

 OP3D_InputSelectorBase (OP3D_View &viewer, PI_SelectorTemplate &templ)
 
virtual ~OP3D_InputSelectorBase ()
 
virtual void setViewer (BM_View *viewer)
 
virtual void startSelecting ()
 
virtual void stopSelecting ()
 
virtual void doRender (RE_Render *r, int x, int y, int ghost)
 
UI_ValuefinishedValue ()
 
const UI_ValuefinishedValue () const
 
UI_Feel * getCustomToolbox () const
 
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)
 
void setPriorSelections (const UT_StringArray &paths, const UT_StringArray &ids, const OP3D_SelectionHandles &selections)
 
bool justDisplayedOp () const
 
void setJustDisplayedOp (bool on)
 
virtual int handleMouseWheelEvent (UI_Event *event)
 
virtual int handleKeyEvent (UI_Event *event, DM_Viewport &viewport)=0
 
virtual bool handleTransitoryKey (const UI_Event &event)
 
virtual UI_Menu * getSelectorMenu () const =0
 
virtual UI_Menu * getSelectorHotkeyMenu () const
 
virtual const char * cursor () const
 
void handleSelectionStyleChange (UI_Event *event)
 
- Public Member Functions inherited from DM_InputSelector
 DM_InputSelector (BM_View &viewer, PI_SelectorTemplate &templ)
 
virtual ~DM_InputSelector ()
 
virtual const char * className () const
 
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
GEO_PrimTypeCompat::TypeMask 
primMask () const
 
- Public Member Functions inherited from BM_InputSelector
 BM_InputSelector (BM_View &viewer, PI_SelectorTemplate &templ)
 
virtual ~BM_InputSelector ()
 
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)
 
virtual ~AP_Interface ()
 
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
 
void removeObjectSymbol (const char *symbol)
 Delete the entry for the given object symbol name. More...
 
template<typename T >
TfindObject (const char *name) const
 
template<typename T >
TfindValue (const char *name) const
 
void resetApplication ()
 
virtual void handleEvent (UI_Event *event)
 
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)
 
bool restoreUIInitPrefs ()
 
bool getFunctionKeyScript (UI_Event *event, UT_String &script)
 
- 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_String &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 *)
 

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_DetailgetGeometryFromPath (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 * getLoopSelectionHotkeyStringRepr ()
 
static bool isTransitoryLoopSelectionHotkey (const UI_DeviceEvent &state)
 
static bool isTransitoryLoopSelectionHotkeyPressed (DM_Viewport *viewport)
 
static void showLoopSelectionMessage (DM_Workbench &workbench)
 
- Static Public Member Functions inherited from AP_Interface
static FILE * createPreferenceFile (const char *filename)
 
static int mapStrToInt (const char *label, const UT_Pair< const char *, int > *map)
 
static const char * mapIntToStr (int index, const UT_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 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 &)
 

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 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)
 
const GU_DetailgetGeometryFromPickRecord (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)
 
bool containedSelectToggle (UI_Event *event)
 
- Protected Member Functions inherited from BM_InputSelector
BM_View & baseViewer ()
 
const BM_View & baseViewer () const
 
virtual void initApplication (UI_Manager *, int c, const char **v)
 
- Protected Member Functions inherited from AP_Interface
UI_NamedValueMapgetValueTable (void) const
 
UI_NamedObjectMapgetObjectTable (void) const
 
virtual void getSignalList (int *signals, int max_signals)
 
- 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 setAppForeground ()
 
static void setTheMainApplication (AP_Interface *app)
 
static AP_InterfacegetMainApplication ()
 
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)
 

Additional Inherited Members

- Static Public Attributes inherited from AP_Interface
static const UT_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 *constmyValueNames
 
UI_EventMethod constmyMethods
 

Detailed Description

Definition at line 68 of file OP3D_InputSelectorBase.h.

Constructor & Destructor Documentation

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

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 110 of file OP3D_InputSelectorBase.h.

bool OP3D_InputSelectorBase::allowFinishing ( ) const
inline

Definition at line 117 of file OP3D_InputSelectorBase.h.

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

Definition at line 128 of file OP3D_InputSelectorBase.h.

bool OP3D_InputSelectorBase::containedSelectToggle ( UI_Event event)
protected
virtual const char* OP3D_InputSelectorBase::cursor ( ) const
virtual

Reimplemented from BM_InputSelector.

void OP3D_InputSelectorBase::disableActivePicking ( )
inlineprotected

Definition at line 324 of file OP3D_InputSelectorBase.h.

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

Reimplemented from BM_InputSelector.

void OP3D_InputSelectorBase::enablePicker ( UI_Event event)
protected
UI_Value& OP3D_InputSelectorBase::finishedValue ( )
inline

Definition at line 96 of file OP3D_InputSelectorBase.h.

const UI_Value& OP3D_InputSelectorBase::finishedValue ( ) const
inline

Definition at line 98 of file OP3D_InputSelectorBase.h.

static bool OP3D_InputSelectorBase::getAllowUseExistingSelection ( )
inlinestatic

Definition at line 175 of file OP3D_InputSelectorBase.h.

bool OP3D_InputSelectorBase::getContainedPick ( ) const
inlineprotected

Definition at line 250 of file OP3D_InputSelectorBase.h.

UI_Value* OP3D_InputSelectorBase::getContainedPickPtr ( ) const
inlineprotected

Definition at line 248 of file OP3D_InputSelectorBase.h.

UI_Feel* OP3D_InputSelectorBase::getCustomToolbox ( ) const
UI_Value* OP3D_InputSelectorBase::getFinishedValuePtr ( ) const
inlineprotected

Definition at line 220 of file OP3D_InputSelectorBase.h.

static GU_Detail* OP3D_InputSelectorBase::getGeometryFromPath ( const char *  path)
static
const GU_Detail* OP3D_InputSelectorBase::getGeometryFromPickRecord ( const GR_PickRecord pick,
GUI_DetailLook **  detail_look = nullptr 
)
protected
static const char* OP3D_InputSelectorBase::getLoopSelectionHotkeyStringRepr ( )
static
static OP_Node* OP3D_InputSelectorBase::getNodeFromPath ( const char *  path)
static
SI_Brush* OP3D_InputSelectorBase::getPickBrushPtr ( ) const
inlineprotected

Definition at line 275 of file OP3D_InputSelectorBase.h.

static bool OP3D_InputSelectorBase::getPickingMenuOn ( )
inlinestatic

Definition at line 173 of file OP3D_InputSelectorBase.h.

SI_Brush* OP3D_InputSelectorBase::getPickLaserPtr ( ) const
inlineprotected

Definition at line 276 of file OP3D_InputSelectorBase.h.

SI_Lasso* OP3D_InputSelectorBase::getPickLassoPtr ( ) const
inlineprotected

Definition at line 277 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 105 of file OP3D_InputSelectorBase.h.

static bool OP3D_InputSelectorBase::getSelectFullLoops ( )
inlinestatic

Definition at line 179 of file OP3D_InputSelectorBase.h.

UI_Value* OP3D_InputSelectorBase::getSelectionRulePtr ( ) const
inlineprotected

Definition at line 259 of file OP3D_InputSelectorBase.h.

UI_Value* OP3D_InputSelectorBase::getSelectionStylePtr ( ) const
inlineprotected

Definition at line 225 of file OP3D_InputSelectorBase.h.

virtual UI_Menu* OP3D_InputSelectorBase::getSelectorHotkeyMenu ( ) const
inlinevirtual

Reimplemented in OP3D_InputSelector.

Definition at line 165 of file OP3D_InputSelectorBase.h.

virtual UI_Menu* OP3D_InputSelectorBase::getSelectorMenu ( ) const
pure virtual

Implemented in OP3D_InputSelector.

static const SIM_Data* OP3D_InputSelectorBase::getSimModifierFromPath ( const char *  path)
static
static const SIM_Object* OP3D_InputSelectorBase::getSimObjectFromPath ( const char *  path)
static
static fpreal OP3D_InputSelectorBase::getTime ( )
staticprotected
bool OP3D_InputSelectorBase::getVisiblePick ( ) const
inlineprotected

Definition at line 239 of file OP3D_InputSelectorBase.h.

UI_Value* OP3D_InputSelectorBase::getVisiblePickPtr ( ) const
inlineprotected

Definition at line 237 of file OP3D_InputSelectorBase.h.

virtual void OP3D_InputSelectorBase::handleBoxPick ( UI_Event event)
protectedvirtual
virtual void OP3D_InputSelectorBase::handleBrushPick ( UI_Event event)
protectedvirtual
virtual int OP3D_InputSelectorBase::handleKeyEvent ( UI_Event event,
DM_Viewport &  viewport 
)
pure virtual

Implemented in OP3D_InputSelector.

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

Reimplemented from BM_InputSelector.

void OP3D_InputSelectorBase::handleSelectionStyleChange ( UI_Event event)
virtual bool OP3D_InputSelectorBase::handleTransitoryKey ( const UI_Event event)
virtual

Reimplemented in OP3D_InputSelector.

bool OP3D_InputSelectorBase::isActivePicking ( ) const
inlineprotected

Definition at line 325 of file OP3D_InputSelectorBase.h.

bool OP3D_InputSelectorBase::isDragSelectActive ( ) const
protected
static bool OP3D_InputSelectorBase::isTransitoryLoopSelectionHotkey ( const UI_DeviceEvent state)
static
static bool OP3D_InputSelectorBase::isTransitoryLoopSelectionHotkeyPressed ( DM_Viewport *  viewport)
static
bool OP3D_InputSelectorBase::justDisplayedOp ( ) const
inline

Definition at line 146 of file OP3D_InputSelectorBase.h.

virtual bool OP3D_InputSelectorBase::needObjectPick ( ) const
protectedvirtual

Reimplemented in OP3D_InputSelector.

bool OP3D_InputSelectorBase::pickChosenOp ( UT_Array< GR_PickRecord > &  pick_records,
bool *  changed = nullptr 
)
protected
virtual void OP3D_InputSelectorBase::saveForUndo ( )
protectedvirtual

Reimplemented in OP3D_InputSelector.

GU_SelectionRule OP3D_InputSelectorBase::selectionRule ( ) const
inlineprotected

Definition at line 261 of file OP3D_InputSelectorBase.h.

void OP3D_InputSelectorBase::selectionRule ( GU_SelectionRule  srule)
inlineprotected

Definition at line 269 of file OP3D_InputSelectorBase.h.

DM_SelectionStyle OP3D_InputSelectorBase::selectionStyle ( ) const
inlineprotected

Definition at line 227 of file OP3D_InputSelectorBase.h.

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

Definition at line 112 of file OP3D_InputSelectorBase.h.

void OP3D_InputSelectorBase::setAllowFinishing ( bool  allow_finishing)
inline

Definition at line 119 of file OP3D_InputSelectorBase.h.

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

Definition at line 130 of file OP3D_InputSelectorBase.h.

static void OP3D_InputSelectorBase::setAllowUseExistingSelection ( bool  val)
inlinestatic

Definition at line 177 of file OP3D_InputSelectorBase.h.

void OP3D_InputSelectorBase::setContainedPickPtr ( UI_Value new_value)
inlineprotected

Definition at line 246 of file OP3D_InputSelectorBase.h.

void OP3D_InputSelectorBase::setFinishedValuePtr ( UI_Value new_value)
inlineprotected

Definition at line 218 of file OP3D_InputSelectorBase.h.

void OP3D_InputSelectorBase::setJustDisplayedOp ( bool  on)
inline

Definition at line 148 of file OP3D_InputSelectorBase.h.

static void OP3D_InputSelectorBase::setPickingMenuOn ( bool  val)
inlinestatic

Definition at line 174 of file OP3D_InputSelectorBase.h.

void OP3D_InputSelectorBase::setPreferredSelectMode ( DM_SelectMode  selmode)
inline

Definition at line 103 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 181 of file OP3D_InputSelectorBase.h.

void OP3D_InputSelectorBase::setSelectionRulePtr ( UI_Value new_value)
inlineprotected

Definition at line 257 of file OP3D_InputSelectorBase.h.

void OP3D_InputSelectorBase::setSelectionStylePtr ( UI_Value new_value)
inlineprotected

Definition at line 223 of file OP3D_InputSelectorBase.h.

virtual void OP3D_InputSelectorBase::setViewer ( BM_View *  viewer)
virtual

Reimplemented from BM_InputSelector.

Reimplemented in OP3D_InputSelector.

void OP3D_InputSelectorBase::setVisiblePickPtr ( UI_Value new_value)
inlineprotected

Definition at line 235 of file OP3D_InputSelectorBase.h.

static void OP3D_InputSelectorBase::showLoopSelectionMessage ( DM_Workbench &  workbench)
static
virtual void OP3D_InputSelectorBase::startSelecting ( )
virtual

Reimplemented from BM_InputSelector.

Reimplemented in OP3D_InputSelector.

virtual void OP3D_InputSelectorBase::stopSelecting ( )
virtual

Reimplemented from BM_InputSelector.

Reimplemented in OP3D_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 212 of file OP3D_InputSelectorBase.h.

const OP3D_View& OP3D_InputSelectorBase::viewer ( ) const
inlineprotected

Definition at line 213 of file OP3D_InputSelectorBase.h.

bool OP3D_InputSelectorBase::visibleSelectToggle ( UI_Event event)
protected
DM_Workbench& OP3D_InputSelectorBase::workbench ( )
inlineprotected

Definition at line 215 of file OP3D_InputSelectorBase.h.

const DM_Workbench& OP3D_InputSelectorBase::workbench ( ) const
inlineprotected

Definition at line 216 of file OP3D_InputSelectorBase.h.


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