ShowField.h

Go to the documentation of this file.

/*
   For more information, please see: http://software.sci.utah.edu

   The MIT License

   Copyright (c) 2012 Scientific Computing and Imaging Institute,
   University of Utah.

   License for the specific language governing rights and limitations under
   Permission is hereby granted, free of charge, to any person obtaining a
   copy of this software and associated documentation files (the "Software"),
   to deal in the Software without restriction, including without limitation
   the rights to use, copy, modify, merge, publish, distribute, sublicense,
   and/or sell copies of the Software, and to permit persons to whom the
   Software is furnished to do so, subject to the following conditions:

   The above copyright notice and this permission notice shall be included
   in all copies or substantial portions of the Software.

   THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
   OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
   FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
   THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
   LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
   FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
   DEALINGS IN THE SOFTWARE.
*/
/// @todo Documentation Modules/Visualization/ShowField.h

#ifndef MODULES_VISUALIZATION_SHOW_FIELD_H
#define MODULES_VISUALIZATION_SHOW_FIELD_H

#include <Dataflow/Network/Module.h>
#include <Core/Datatypes/Geometry.h>
#include <Core/Datatypes/Legacy/Field/VMesh.h>
#include <Modules/Visualization/share.h>

namespace SCIRun {
namespace Modules {
namespace Visualization {

  class SCISHARE ShowFieldModule : public SCIRun::Dataflow::Networks::Module,
    public Has2InputPorts<FieldPortTag, ColorMapPortTag>,
    public Has1OutputPort<GeometryPortTag>
  {
  public:
    ShowFieldModule();
    virtual void execute();

    static Core::Algorithms::AlgorithmParameterName ShowNodes;
    static Core::Algorithms::AlgorithmParameterName ShowEdges;
    static Core::Algorithms::AlgorithmParameterName ShowFaces;
    static Core::Algorithms::AlgorithmParameterName NodeTransparency;
    static Core::Algorithms::AlgorithmParameterName EdgeTransparency;
    static Core::Algorithms::AlgorithmParameterName FaceTransparency;
    static Core::Algorithms::AlgorithmParameterName FaceInvertNormals;
    static Core::Algorithms::AlgorithmParameterName DefaultMeshColor;

    INPUT_PORT(0, Field, LegacyField);
    INPUT_PORT(1, ColorMapObject, ColorMap);
    OUTPUT_PORT(0, SceneGraph, GeometryObject);
  
    static Dataflow::Networks::ModuleLookupInfo staticInfo_;

    virtual void setStateDefaults();
  private:
    /// Constructs a geometry object (essentially a spire object) from the given 
    /// field data.
    /// \param field    Field from which to construct geometry.
    /// \param state    
    /// \param id       Ends up becoming the name of the spire object.
    Core::Datatypes::GeometryHandle buildGeometryObject(
        boost::shared_ptr<SCIRun::Field> field,
        boost::optional<boost::shared_ptr<SCIRun::Core::Datatypes::ColorMap>> colorMap,
        Dataflow::Networks::ModuleStateHandle state, const std::string& id);


    /// IBO Construction
    /// @{
    void buildFacesIBO(
        SCIRun::Core::Datatypes::MeshTraits<VMesh>::MeshFacadeHandle facade, 
        Core::Datatypes::GeometryHandle geom, const std::string& desiredIBOName);

    void buildEdgesIBO(
        SCIRun::Core::Datatypes::MeshTraits<VMesh>::MeshFacadeHandle facade,
        Core::Datatypes::GeometryHandle geom, const std::string& desiredIBOName);

    void buildNodesIBO(
        SCIRun::Core::Datatypes::MeshTraits<VMesh>::MeshFacadeHandle facade,
        Core::Datatypes::GeometryHandle geom, const std::string& desiredIBOName);
    /// @}

  };

} // Visualization
} // Modules
} // SCIRun

#endif