Seg3D  2.4
Seg3D is a free volume segmentation and processing tool developed by the NIH Center for Integrative Biomedical Computing at the University of Utah Scientific Computing and Imaging (SCI) Institute.
Public Types | Public Member Functions | Public Attributes | Protected Member Functions | Protected Attributes | List of all members
Core::StateView2D Class Reference
Inheritance diagram for Core::StateView2D:
Core::StateViewBase Core::StateBase

Public Types

typedef View2D value_type
 
typedef StateView2DHandle handle_type
 
typedef boost::signals2::signal< void(Core::View2D, Core::ActionSource) > value_changed_signal_type
 
- Public Types inherited from Core::StateBase
enum  { DO_NOT_LOAD_E = -1, LOAD_LAST_E = 0, DEFAULT_LOAD_E = 100 }
 
typedef boost::signals2::signal< void() > state_changed_signal_type
 This signal is triggered when the state is changed.
 

Public Member Functions

 StateView2D (const std::string &stateid)
 
virtual std::string export_to_string () const
 Convert the contents of the State into a string.
 
virtual bool import_from_string (const std::string &str, Core::ActionSource source=Core::ActionSource::NONE_E)
 Set the State from a string.
 
virtual void scale (double ratio)
 
virtual void translate (const Core::Vector &offset)
 
void dolly (double dz)
 
const Core::View2Dget () const
 Get the value of the state variable.
 
bool set (const Core::View2D &value, Core::ActionSource source=Core::ActionSource::NONE_E)
 
- Public Member Functions inherited from Core::StateViewBase
 StateViewBase (const std::string &stateid)
 
- Public Member Functions inherited from Core::StateBase
 StateBase (const std::string &stateid)
 
void set_is_project_data (bool is_project_data)
 Set whether the data is part of the project data.
 
void set_locked (bool locked)
 
bool get_locked () const
 Query whether the variable has been designated as locked.
 
int get_session_priority () const
 Get the priority in which loading sets the states.
 
void set_session_priority (int priority)
 By default the priority is set to DEAFULT_LOAD_E.
 
std::string get_stateid () const
 Get the unique id assigned to the state variable.
 
bool is_project_data () const
 Whether the data is tagged as project data that is saved in a session.
 

Public Attributes

value_changed_signal_type value_changed_signal_
 
- Public Attributes inherited from Core::StateBase
state_changed_signal_type state_changed_signal_
 

Protected Member Functions

virtual void export_to_variant (Variant &variant) const
 Export the state data to a variant parameter.
 
virtual bool import_from_variant (Variant &variant, Core::ActionSource source=Core::ActionSource::NONE_E)
 Import the state data from a variant parameter.
 
virtual bool validate_variant (Variant &variant, std::string &error)
 
- Protected Member Functions inherited from Core::StateBase
void enable_signals (bool signals_enabled)
 
bool signals_enabled ()
 Check whether signals are enabled.
 
void set_initializing (bool initializing)
 
bool get_initializing () const
 Query whether the state variable and its parent are still being initialized.
 
virtual void invalidate ()
 

Protected Attributes

Core::View2D value_
 

Member Typedef Documentation

typedef boost::signals2::signal< void( Core::View2D, Core::ActionSource ) > Core::StateView2D::value_changed_signal_type

Signal when the data in the state is changed, the second parameter indicates the source of the change

Member Function Documentation

bool Core::StateView2D::set ( const Core::View2D value,
Core::ActionSource  source = Core::ActionSource::NONE_E 
)

Set the value of the state variable NOTE: this function by passes the action mechanism and should only be used to enforce a constraint from another action.

bool Core::StateView2D::validate_variant ( Variant variant,
std::string &  error 
)
protectedvirtual

Validate a variant parameter This function returns false if the parameter is invalid or cannot be converted and in that case error will describe the error.

Implements Core::StateBase.


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