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 | List of all members
Core::TransferFunction Class Reference
Inheritance diagram for Core::TransferFunction:
Core::StateHandler Core::ConnectionHandler

Public Types

typedef boost::signals2::signal< void(TransferFunctionFeatureHandle) > feature_signal_type
 

Public Member Functions

TransferFunctionFeatureHandle create_feature ()
 
void delete_feature (const std::string &feature_id)
 
void clear ()
 
TextureHandle get_diffuse_lut () const
 Get the lookup texture of the diffuse color.
 
TextureHandle get_specular_lut () const
 
TransferFunctionFeatureHandle get_feature (const std::string &feature_id) const
 
- 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

StateBoolHandle faux_shading_state_
 Whether to use faux shading.
 
feature_signal_type feature_added_signal_
 
feature_signal_type feature_deleted_signal_
 
boost::signals2::signal< void() > transfer_function_changed_signal_
 

Protected Member Functions

virtual bool post_load_states (const StateIO &state_io)
 
virtual bool post_save_states (StateIO &state_io)
 
- 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 pre_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

TextureHandle Core::TransferFunction::get_specular_lut ( ) const

Get the lookup texture of the specular color. The alpha component contains the shininess value.

bool Core::TransferFunction::post_load_states ( const StateIO state_io)
protectedvirtual

This virtual function can be implemented in the StateHandlers and will be called after its states are loaded. If it doesn't succeed it needs to return false.

Reimplemented from Core::StateHandler.

bool Core::TransferFunction::post_save_states ( StateIO state_io)
protectedvirtual

This virtual function can be implemented in the StateHandlers and will be called after its states are saved. If it doesn't succeed it needs to return false.

Reimplemented from Core::StateHandler.


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