SMTK
@SMTK_VERSION@
Simulation Modeling Tool Kit
|
Classes for presenting resources and their components to users. More...
Classes | |
class | AssociationBadge |
A badge that appears when an object is missing a mandatory association. More... | |
class | AttributeIconConstructor |
class | AvailableOperations |
Maintain a list of operations that may be applied to a selection. More... | |
class | Badge |
A base class for descriptive-phrase badges. More... | |
class | BadgeAction |
A base class for actions taken on badges. More... | |
class | BadgeActionToggle |
The basic badge action: the user clicked on a badge. More... | |
class | BadgeFactory |
A factory for badges that appear in descriptive phrases. More... | |
class | BadgeSet |
A container for the badges that apply to a view. More... | |
class | BaseView |
class | ComponentPhraseContent |
Describe a resource component for user presentation. More... | |
class | ComponentPhraseModel |
Present phrases describing a set of acceptable components held by a single resource. More... | |
class | Configuration |
Configure a view, specifying types and attributes, without specifying a UI library. More... | |
class | DefaultIconConstructor |
class | DescriptivePhrase |
A base class for phrases describing an SMTK model. More... | |
class | EmptySubphraseGenerator |
Generate no subphrases (but decorate root-level phrases). More... | |
class | Information |
A class for information passed to views during initialization. More... | |
class | LockedResourceBadge |
A badge that appears next to resources that are locked. More... | |
class | Manager |
A view Manager is responsible for creating new views (eventually) as well as view components such as PhraseModels and SubPhraseGenerators. More... | |
class | MeshIconConstructor |
class | ModelIconConstructor |
class | NameManager |
An application-wide utility for assigning unique names to objects. More... | |
class | NodeGroupPhraseContent |
A phrase whose children are all components of a given type-name. More... | |
class | ObjectGroupPhraseContent |
Group a set of persistent objects for user presentation. More... | |
class | ObjectIconBadge |
A badge that illustrates the type and color of a persistent object. More... | |
class | ObjectIcons |
An icon factory creates icons for Resources and their Components. More... | |
class | OperationDecorator |
Decorate operations that should be presented to the user. More... | |
class | OperationIcons |
This factory class returns icon-constructors for Operations. More... | |
struct | PathComp |
class | PhraseContent |
An abstract base class for obtaining descriptive phrase information. More... | |
class | PhraseDeltas |
class | PhraseListContent |
Describe a list of child phrases to the user. More... | |
class | PhraseModel |
Hold and maintain a descriptive phrase hierarchy. More... | |
class | PhraseModelFactory |
A factory to create phrase models which is held by view managers. More... | |
class | QueryFilterSubphraseGenerator |
Generate subphrases by querying the filter in ObjectGroupPhraseContent. More... | |
class | ReferenceItemPhraseModel |
Present phrases describing a set of acceptable components held by a single resource. More... | |
class | Registrar |
class | ResourceIconConstructor |
class | ResourcePhraseContent |
Describe a resource component for user presentation. More... | |
class | ResourcePhraseModel |
Present phrases describing a set of resources held by one or more resource managers. More... | |
class | RespondToVTKSelection |
A base class for operations that should be invoked when the VTK selection changes. More... | |
class | Selection |
A class to manage linked selections in a context. More... | |
class | SelectionPhraseModel |
Present phrases describing a set of resources held by one or more resource managers. More... | |
class | SubphraseGenerator |
Generate subphrases to display for a given descriptive phrase. More... | |
class | SubphraseGeneratorFactory |
A factory to create suphrase generators which is held by view managers. More... | |
class | SVGIconConstructor |
class | TwoLevelSubphraseGenerator |
Generate subphrases in a relatively flat two-level hierarchy. More... | |
class | UIElementState |
A base class for user interface elements that wish to serialize their state. More... | |
class | ViewWidgetFactory |
A factory to create view widgets which is held by view managers. More... | |
class | VTKSelectionResponderGroup |
A group of operations that update an SMTK selection based on a VTK selection. More... | |
Typedefs | |
typedef smtk::shared_ptr< smtk::view::AvailableOperations > | AvailableOperationsPtr |
typedef smtk::weak_ptr< smtk::view::AvailableOperations > | WeakAvailableOperationsPtr |
typedef smtk::shared_ptr< smtk::view::Badge > | BadgePtr |
typedef smtk::shared_ptr< smtk::view::DescriptivePhrase > | DescriptivePhrasePtr |
typedef smtk::weak_ptr< smtk::view::DescriptivePhrase > | WeakDescriptivePhrasePtr |
typedef std::vector< smtk::view::DescriptivePhrasePtr > | DescriptivePhrases |
typedef smtk::shared_ptr< smtk::view::Manager > | ManagerPtr |
typedef smtk::weak_ptr< smtk::view::Manager > | WeakManagerPtr |
typedef smtk::shared_ptr< smtk::view::PhraseModel > | PhraseModelPtr |
typedef smtk::weak_ptr< smtk::view::PhraseModel > | WeakPhraseModelPtr |
typedef smtk::shared_ptr< smtk::view::Selection > | SelectionPtr |
typedef smtk::weak_ptr< smtk::view::Selection > | WeakSelectionPtr |
typedef smtk::shared_ptr< smtk::view::SubphraseGenerator > | SubphraseGeneratorPtr |
typedef smtk::weak_ptr< smtk::view::SubphraseGenerator > | WeakSubphraseGeneratorPtr |
typedef smtk::shared_ptr< smtk::view::Configuration > | ConfigurationPtr |
typedef smtk::weak_ptr< smtk::view::Configuration > | WeakConfigurationPtr |
typedef smtk::shared_ptr< smtk::view::PhraseContent > | PhraseContentPtr |
typedef smtk::shared_ptr< const smtk::view::PhraseContent > | ConstPhraseContentPtr |
typedef smtk::shared_ptr< smtk::view::PhraseListContent > | PhraseListContentPtr |
typedef smtk::shared_ptr< smtk::view::ComponentPhraseContent > | ComponentPhraseContentPtr |
typedef smtk::shared_ptr< smtk::view::ResourcePhraseContent > | ResourcePhraseContentPtr |
using | ElementStateMap = std::unordered_map< smtk::string::Token, UIElementState * > |
typedef std::unordered_map< smtk::common::UUID, std::set< std::weak_ptr< smtk::view::DescriptivePhrase >, std::owner_less< std::weak_ptr< smtk::view::DescriptivePhrase > > > > | UUIDsToPhrasesMap |
using | PhraseModelParameters = smtk::common::factory::Inputs< const Configuration *, Manager * > |
typedef std::function< void(DescriptivePhrasePtr, PhraseModelEvent, const std::vector< int > &, const std::vector< int > &, const std::vector< int > &)> | PhraseModelObserver |
Events that alter the phrase model trigger callbacks of this type. | |
typedef smtk::common::Observers< PhraseModelObserver > | PhraseModelObservers |
A class for holding PhraseModelObserver functors that observe phrase model events. | |
typedef std::function< void(const std::string &, SelectionPtr)> | SelectionObserver |
Events that alter the selection trigger callbacks of this type. | |
typedef smtk::common::Observers< SelectionObserver > | SelectionObservers |
A class for holding SelectionObserver functors that observe selection events. | |
Functions | |
template<typename ViewWidgetType > | |
std::size_t | typeIndex () |
std::ostream & | operator<< (std::ostream &os, const Configuration::Component &comp) |
Print component information to a stream (for debugging). | |
std::ostream & | operator<< (std::ostream &os, const Configuration &conf) |
Print configuration information to a stream (for debugging). | |
std::string SMTKCORE_EXPORT | DefaultOperationIcon (const std::string &secondaryColor) |
template<typename OperationType > | |
OperationDecorator::Entry | wrap () |
An Entry-constructor that takes an operation as a parameter. More... | |
template<typename OperationType > | |
OperationDecorator::Entry | wrap (const std::string &label, const std::string &toolTip, const std::set< smtk::string::Token > &groups={}, const std::string &buttonLabel=std::string()) |
An Entry-constructor that accepts overrides for all parameters. More... | |
template<typename T > | |
int | MutabilityOfComponent (const T &comp) |
template<typename T > | |
int | MutabilityOfObject (const T &obj) |
int | FindPhraseByTitle (const std::string &title, const DescriptivePhrases &phrases) |
int | FindPhraseLocation (DescriptivePhrase::Ptr &phr, const DescriptivePhrases &siblings) |
Classes for presenting resources and their components to users.
typedef smtk::shared_ptr<smtk::view::AvailableOperations> smtk::view::AvailableOperationsPtr |
typedef smtk::shared_ptr<smtk::view::Badge> smtk::view::BadgePtr |
typedef smtk::shared_ptr<smtk::view::ComponentPhraseContent> smtk::view::ComponentPhraseContentPtr |
typedef smtk::shared_ptr<smtk::view::Configuration> smtk::view::ConfigurationPtr |
typedef smtk::shared_ptr<const smtk::view::PhraseContent> smtk::view::ConstPhraseContentPtr |
typedef smtk::shared_ptr<smtk::view::DescriptivePhrase> smtk::view::DescriptivePhrasePtr |
typedef std::vector< DescriptivePhrasePtr > smtk::view::DescriptivePhrases |
typedef smtk::shared_ptr<smtk::view::Manager> smtk::view::ManagerPtr |
typedef smtk::shared_ptr<smtk::view::PhraseContent> smtk::view::PhraseContentPtr |
typedef smtk::shared_ptr<smtk::view::PhraseListContent> smtk::view::PhraseListContentPtr |
typedef smtk::shared_ptr<smtk::view::PhraseModel> smtk::view::PhraseModelPtr |
typedef smtk::shared_ptr<smtk::view::ResourcePhraseContent> smtk::view::ResourcePhraseContentPtr |
typedef smtk::shared_ptr<smtk::view::Selection> smtk::view::SelectionPtr |
typedef smtk::shared_ptr< SubphraseGenerator > smtk::view::SubphraseGeneratorPtr |
typedef smtk::weak_ptr<smtk::view::AvailableOperations> smtk::view::WeakAvailableOperationsPtr |
typedef smtk::weak_ptr<smtk::view::Configuration> smtk::view::WeakConfigurationPtr |
typedef smtk::weak_ptr<smtk::view::DescriptivePhrase> smtk::view::WeakDescriptivePhrasePtr |
typedef smtk::weak_ptr<smtk::view::Manager> smtk::view::WeakManagerPtr |
typedef smtk::weak_ptr<smtk::view::PhraseModel> smtk::view::WeakPhraseModelPtr |
typedef smtk::weak_ptr<smtk::view::Selection> smtk::view::WeakSelectionPtr |
typedef smtk::weak_ptr<smtk::view::SubphraseGenerator> smtk::view::WeakSubphraseGeneratorPtr |
|
strong |
Possible types of relationships that the iterator will report.
|
strong |
Events that can be observed on an smtk::view::PhraseModel.
|
strong |
Descriptors for how lists passed to the selection should modify the selection-map.
Enumerator | |
---|---|
FILTERED_REPLACE | Replace all the current selection and filter it. Example use case: normal selection from rendering window. |
UNFILTERED_REPLACE | Replace all the current selection and do not filter it. Example use case: selection from model tree and attribute panel. |
FILTERED_ADD | Filter the input selection and add it to the current selection. Example use case: addition from rendering window. |
UNFILTERED_ADD | Do not filter the input selection, just add it to the current selection. Example use case: addition from operator dialog where a the user is presented with a pre-filtered list. |
FILTERED_SUBTRACT | Filter the input selection, then subtract it from the current selection. Example use case: substraction from rendering window. |
UNFILTERED_SUBTRACT | Do not filter the input selection, just subtract it from the current selection. Example use case: subtraction from operator dialog where a pre-filtered list is provided. |
DEFAULT | Use the default SelectionAction provided by the Selection. Use it when SelectionAction should be decided by previous user input that resulted in a mode being set on the Selection. An example is when a user presses a modifier key while in a selection mode to switch between addition, subtraction, or replacement. In this case, the key presses will change the default action on the selection while the mouse clicks that identify entities signal their intent to use the updated default with this enum. |
OperationDecorator::Entry smtk::view::wrap | ( | ) |
An Entry-constructor that takes an operation as a parameter.
Includes the operation but does not provide any overrides. This method is a free function because templated constructors are disallowed.
OperationDecorator::Entry smtk::view::wrap | ( | const std::string & | label, |
const std::string & | toolTip, | ||
const std::set< smtk::string::Token > & | groups = {} , |
||
const std::string & | buttonLabel = std::string() |
||
) |
An Entry-constructor that accepts overrides for all parameters.
Note that buttonLabel is last and defaults to an empty string. This method is a free function because templated constructors are disallowed.