SMTK  @SMTK_VERSION@
Simulation Modeling Tool Kit
Classes | Typedefs | Enumerations | Functions
smtk::view Namespace Reference

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  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  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::AvailableOperationsAvailableOperationsPtr
 
typedef smtk::weak_ptr< smtk::view::AvailableOperationsWeakAvailableOperationsPtr
 
typedef smtk::shared_ptr< smtk::view::BadgeBadgePtr
 
typedef smtk::shared_ptr< smtk::view::DescriptivePhraseDescriptivePhrasePtr
 
typedef smtk::weak_ptr< smtk::view::DescriptivePhraseWeakDescriptivePhrasePtr
 
typedef std::vector< smtk::view::DescriptivePhrasePtrDescriptivePhrases
 
typedef smtk::shared_ptr< smtk::view::ManagerManagerPtr
 
typedef smtk::weak_ptr< smtk::view::ManagerWeakManagerPtr
 
typedef smtk::shared_ptr< smtk::view::PhraseModelPhraseModelPtr
 
typedef smtk::weak_ptr< smtk::view::PhraseModelWeakPhraseModelPtr
 
typedef smtk::shared_ptr< smtk::view::SelectionSelectionPtr
 
typedef smtk::weak_ptr< smtk::view::SelectionWeakSelectionPtr
 
typedef smtk::shared_ptr< smtk::view::SubphraseGeneratorSubphraseGeneratorPtr
 
typedef smtk::weak_ptr< smtk::view::SubphraseGeneratorWeakSubphraseGeneratorPtr
 
typedef smtk::shared_ptr< smtk::view::ConfigurationConfigurationPtr
 
typedef smtk::weak_ptr< smtk::view::ConfigurationWeakConfigurationPtr
 
typedef smtk::shared_ptr< smtk::view::PhraseContentPhraseContentPtr
 
typedef smtk::shared_ptr< const smtk::view::PhraseContentConstPhraseContentPtr
 
typedef smtk::shared_ptr< smtk::view::PhraseListContentPhraseListContentPtr
 
typedef smtk::shared_ptr< smtk::view::ComponentPhraseContentComponentPhraseContentPtr
 
typedef smtk::shared_ptr< smtk::view::ResourcePhraseContentResourcePhraseContentPtr
 
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< PhraseModelObserverPhraseModelObservers
 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< SelectionObserverSelectionObservers
 A class for holding SelectionObserver functors that observe selection events.
 

Enumerations

enum  DescriptivePhraseType {
  DescriptivePhraseType::RESOURCE_SUMMARY, DescriptivePhraseType::RESOURCE_LIST, DescriptivePhraseType::COMPONENT_SUMMARY, DescriptivePhraseType::COMPONENT_LIST,
  DescriptivePhraseType::PROPERTY_LIST, DescriptivePhraseType::FLOAT_PROPERTY_VALUE, DescriptivePhraseType::STRING_PROPERTY_VALUE, DescriptivePhraseType::INTEGER_PROPERTY_VALUE,
  DescriptivePhraseType::LIST, DescriptivePhraseType::INVALID_DESCRIPTION
}
 Possible types of relationships that the iterator will report. More...
 
enum  PhraseModelEvent {
  PhraseModelEvent::ABOUT_TO_INSERT, PhraseModelEvent::INSERT_FINISHED, PhraseModelEvent::ABOUT_TO_REMOVE, PhraseModelEvent::REMOVE_FINISHED,
  PhraseModelEvent::ABOUT_TO_MOVE, PhraseModelEvent::MOVE_FINISHED, PhraseModelEvent::PHRASE_MODIFIED
}
 Events that can be observed on an smtk::view::PhraseModel. More...
 
enum  SelectionAction {
  SelectionAction::FILTERED_REPLACE = 0, SelectionAction::UNFILTERED_REPLACE = 1, SelectionAction::FILTERED_ADD = 2, SelectionAction::UNFILTERED_ADD = 3,
  SelectionAction::FILTERED_SUBTRACT = 4, SelectionAction::UNFILTERED_SUBTRACT = 5, SelectionAction::DEFAULT = 6
}
 Descriptors for how lists passed to the selection should modify the selection-map. More...
 

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)
 

Detailed Description

Classes for presenting resources and their components to users.

Typedef Documentation

◆ AvailableOperationsPtr

◆ BadgePtr

typedef smtk::shared_ptr<smtk::view::Badge> smtk::view::BadgePtr

◆ ComponentPhraseContentPtr

◆ ConfigurationPtr

◆ ConstPhraseContentPtr

◆ DescriptivePhrasePtr

◆ DescriptivePhrases

◆ ManagerPtr

typedef smtk::shared_ptr<smtk::view::Manager> smtk::view::ManagerPtr

◆ PhraseContentPtr

◆ PhraseListContentPtr

◆ PhraseModelPtr

◆ ResourcePhraseContentPtr

◆ SelectionPtr

◆ SubphraseGeneratorPtr

◆ WeakAvailableOperationsPtr

◆ WeakConfigurationPtr

◆ WeakDescriptivePhrasePtr

◆ WeakManagerPtr

◆ WeakPhraseModelPtr

◆ WeakSelectionPtr

◆ WeakSubphraseGeneratorPtr

Enumeration Type Documentation

◆ DescriptivePhraseType

Possible types of relationships that the iterator will report.

Enumerator
RESOURCE_SUMMARY 

Summarize a resource by name, filename, and perhaps timestamp.

RESOURCE_LIST 

This phrase summarizes multiple resources.

COMPONENT_SUMMARY 

Summarize a component by displaying its name.

COMPONENT_LIST 

This phrase summarizes multiple components.

PROPERTY_LIST 

Summarize a list of properties (usually of a single component).

FLOAT_PROPERTY_VALUE 

Show floating-point values for a named property.

STRING_PROPERTY_VALUE 

Show string values for a named property.

INTEGER_PROPERTY_VALUE 

Show integer values for a named property.

LIST 

A list of descriptive phrases with no constraint on their type.

INVALID_DESCRIPTION 

This is used to indicate an invalid or empty descriptive phrase.

◆ PhraseModelEvent

Events that can be observed on an smtk::view::PhraseModel.

Enumerator
ABOUT_TO_INSERT 

A phrase or range of phrases is about to be inserted in the parent.

INSERT_FINISHED 

A phrase of range of phrases has been inserted in the parent.

ABOUT_TO_REMOVE 

A phrase or range of phrases is about to be removed from the parent.

REMOVE_FINISHED 

A phrase or range of phrases has been removed from the parent.

ABOUT_TO_MOVE 

A phrase or range of phrases is being moved from one place to another.

MOVE_FINISHED 

A phrase or range of phrases has been moved and the update is complete.

PHRASE_MODIFIED 

The given phrase has had its text, color, or some other property modified.

◆ SelectionAction

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.

Function Documentation

◆ wrap() [1/2]

template<typename OperationType >
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.

◆ wrap() [2/2]

template<typename OperationType >
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.