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 Member Functions | Public Attributes | List of all members
Seg3D::PreferencesManager Class Reference
Inheritance diagram for Seg3D::PreferencesManager:
Core::StateHandler Core::ConnectionHandler

Public Member Functions

const std::vector< Core::Color > & get_default_colors () const
 
Core::Color get_color (int index) const
 
Core::Color get_color (const Core::Color &color) const
 
Core::Color get_background_color () const
 
void save_state ()
 
- Public Member Functions inherited from Core::StateHandler
 StateHandler (const std::string &type_str, bool auto_id)
 
template<class HANDLE , class T >
bool add_state (const std::string &key, HANDLE &state, const T &default_value)
 Add a local state variable with default value.
 
template<class HANDLE , class T >
bool add_state (const std::string &key, HANDLE &state, const T &default_value, const T &min_value, const T &max_value, const T &step)
 Add a local state variable with default value and min and max.
 
template<class HANDLE >
bool add_state (const std::string &key, HANDLE &state)
 Add a local state variable without default value.
 
template<class HANDLE >
bool add_state (const std::string &key, HANDLE &state, const std::string &default_option, const std::string &option_list)
 Add a local state variable with option list.
 
template<class HANDLE >
bool add_state (const std::string &key, HANDLE &state, const std::string &default_option, const std::vector< std::string > option_list)
 Add a local state variable with option list.
 
template<class HANDLE >
bool add_state (const std::string &key, HANDLE &state, const std::string &default_option, const std::vector< OptionLabelPair > option_list)
 Add a local state variable with option list.
 
template<class HANDLE >
bool add_state (const std::string &key, HANDLE &state, const std::vector< std::string > &default_options, const std::vector< OptionLabelPair > option_list)
 Add a local state variable with option list.
 
template<class HANDLE >
bool add_state (const std::string &key, HANDLE &state, const std::vector< std::string > &default_options, const std::string &option_list)
 Add a local state variable with option list.
 
template<class HANDLE , class T >
bool add_state (const std::string &key, HANDLE &state, const std::vector< T > &default_value)
 Add a local state variable without default value.
 
void invalidate ()
 this function is called when you need to delete something from the state engine, but may have More...
 
bool is_valid ()
 returns true if the function hasn't been invalidated
 
void mark_as_project_data ()
 Mask the states that are added to this state handler as project data.
 
void do_not_save_id_number ()
 The id number of the statehandler will not be saved.
 
void set_initializing (bool initializing)
 
bool load_states (const StateIO &state_io)
 Load the states into the StateIO variable.
 
bool save_states (StateIO &state_io)
 Save the states into the StateIO variable.
 
const std::string & get_statehandler_id () const
 The id of the handler that will be the prefix of the state variables.
 
const std::string & get_statehandler_id_base () const
 The id of the handler that will be the prefix of the state variables.
 
size_t get_statehandler_id_number () const
 The id number of the handler that will be at the end of the prefix.
 

Public Attributes

Core::StateStringHandle project_path_state_
 
Core::StateStringHandle export_path_state_
 
Core::StateBoolHandle full_screen_on_startup_state_
 
Core::StateBoolHandle auto_save_state_
 
Core::StateRangedIntHandle auto_save_time_state_
 
Core::StateBoolHandle smart_save_state_
 
Core::StateBoolHandle advanced_visibility_settings_state_
 
Core::StateBoolHandle paint_cursor_invisibility_state_
 
Core::StateBoolHandle compression_state_
 
Core::StateRangedIntHandle compression_level_state_
 
Core::StateIntHandle slice_step_multiplier_state_
 
Core::StateLabeledOptionHandle axis_labels_option_state_
 
Core::StateStringHandle x_axis_label_state_
 
Core::StateStringHandle y_axis_label_state_
 
Core::StateStringHandle z_axis_label_state_
 
Core::StateBoolHandle enable_undo_state_
 
Core::StateRangedDoubleHandle percent_of_memory_state_
 
Core::StateBoolHandle embed_input_files_state_
 
Core::StateBoolHandle generate_osx_project_bundle_state_
 
Core::StateBoolHandle export_dicom_headers_state_
 
Core::StateOptionHandle default_viewer_mode_state_
 
Core::StateRangedIntHandle grid_size_state_
 
Core::StateLabeledOptionHandle background_color_state_
 
Core::StateBoolHandle show_slice_number_state_
 
Core::StateBoolHandle zero_based_slice_numbers_state_
 
Core::StateBoolHandle active_layer_navigation_state_
 
Core::StateRangedDoubleHandle default_layer_opacity_state_
 
Core::StateOptionHandle default_mask_fill_state_
 
Core::StateOptionHandle default_mask_border_state_
 
std::vector< Core::StateColorHandle > color_states_
 
Core::StateBoolHandle reverse_slice_navigation_state_
 
Core::StateBoolHandle show_tools_bar_state_
 
Core::StateBoolHandle show_layermanager_bar_state_
 
Core::StateBoolHandle show_projectmanager_bar_state_
 
Core::StateBoolHandle show_provenance_bar_state_
 
Core::StateBoolHandle show_rendering_bar_state_
 
Core::StateBoolHandle enable_large_volume_state_
 

Additional Inherited Members

- Protected Member Functions inherited from Core::StateHandler
virtual void clean_up ()
 This function is called by invalidate to clean up stuff in the statehandler subclasses.
 
void enable_signals (bool enabled)
 This function enables/disables signals in the state variables.
 
virtual bool pre_load_states (const StateIO &state_io)
 
virtual bool post_load_states (const StateIO &state_io)
 
virtual bool pre_save_states (StateIO &state_io)
 
virtual bool post_save_states (StateIO &state_io)
 
virtual void state_changed ()
 
virtual int get_session_priority ()
 
virtual int get_version ()
 Get the version number of this class, this one is used for versioning of session files.
 
int get_loaded_version ()
 Get the version number of the data that was loaded.
 
void set_loaded_version (int loaded_version)
 Set the version number of the data that was loaded.
 
- Protected Member Functions inherited from Core::ConnectionHandler
void add_connection (const boost::signals2::connection &connection)
 
void add_connection (const ConnectionHandlerConnectionHandle &connection)
 
void disconnect_all ()
 

Member Function Documentation

Core::Color Seg3D::PreferencesManager::get_background_color ( ) const

GET_BACKGROUND_COLOR: Get the currently selected background color for the viewers.

Core::Color Seg3D::PreferencesManager::get_color ( int  index) const

GET_COLOR: Get the color at the index.

const std::vector< Core::Color > & Seg3D::PreferencesManager::get_default_colors ( ) const

GET_DEFAULT_COLORS: This function returns a vector of the default colors

void Seg3D::PreferencesManager::save_state ( )

SAVE_STATE: Save the preferences to file.


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