visualization_iterator.h

//
// Copyright (c) 2014 Limit Point Systems, Inc.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//   http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
//

// Interface for class visualization_iterator


#ifndef VISUALIZATION_ITERATOR_H
#define VISUALIZATION_ITERATOR_H

#ifndef SHEAF_DLL_SPEC_H
#include "SheafSystem/sheaf_dll_spec.h"
#endif

#ifndef FILTERED_DEPTH_FIRST_ITERATOR_H
#include "SheafSystem/filtered_depth_first_iterator.h"
#endif

#ifndef SEC_VD_H
#include "SheafSystem/sec_vd.h"
#endif

#ifndef SECTION_ITERATION_STATE_H
#include "SheafSystem/section_iteration_state.h"
#endif

#ifndef VTKTYPE_H
#include "vtkType.h"
#endif
   
class vtkDoubleArray;
class vtkIdTypeArray;

namespace tool
{

using namespace fiber_bundle;

class SHEAF_DLL_SPEC visualization_iterator :
  public filtered_depth_first_iterator
{
public:

  // ===========================================================
  // ANY FACET
  // ===========================================================

  virtual bool is_ancestor_of(const any* xother) const;

  virtual visualization_iterator* clone() const = 0;

  bool invariant() const;

  // ===========================================================
  // DEPTH_FIRST_ITERATOR FACET
  // ===========================================================

  virtual void force_is_done();

  using filtered_depth_first_iterator::put_anchor;

  virtual void put_anchor(const section_space_schema_member& xcoords_schema,
                          const section_space_schema_member& xprop_schema);

  virtual void put_anchor(const section_space_schema_member& xcoords_schema);

  virtual void reset(bool xreset_markers = true);

  // ===========================================================
  // VISUALIZATION_ITERATOR FACET
  // ===========================================================

  static visualization_iterator*
  new_visualization_iterator(const section_space_schema_member& xcoords_schema,
                             const section_space_schema_member& xprop_schema,
                             bool xinitialize = true);

  static visualization_iterator*
  new_visualization_iterator(const section_space_schema_member& xcoords_schema,
                             bool xinitialize = true);

  ~visualization_iterator();

  const section_space_schema_member& coordinates_schema() const;

  bool has_property() const;

  const section_space_schema_member& property_schema() const;

  bool use_point_top_ids() const;
  
  void put_use_point_top_ids(bool xvalue);

  bool use_cell_top_ids() const;
  
  void put_use_cell_top_ids(bool xvalue);
  

  virtual void set_vtk_data(const sec_vd& xcoords,
                            const sec_vd& xprop,
                            vtkDoubleArray* xvtk_pt_coords,
                            vtkDoubleArray* xvtk_prop,
                            int xprop_tensor_rank,
                            block<int>& xvtk_cell_types,
                            block<vtkIdType>& xvtk_cell_connectivity,
                            block<int>& xvtk_cell_type_map,
                            vtkIdTypeArray* xvtk_pt_label_ids,
                            vtkIdTypeArray* xvtk_cell_label_ids);

  virtual void set_vtk_data(const sec_vd& xcoords,
                            vtkDoubleArray* xvtk_pt_coords,
                            block<int>& xvtk_cell_types,
                            block<vtkIdType>& xvtk_cell_connectivity,
                            block<int>& xvtk_cell_type_map,
                            vtkIdTypeArray* xvtk_pt_label_ids,
                            vtkIdTypeArray* xvtk_cell_label_ids);

  virtual void set_vtk_data(const sec_vd& xprop,
                            vtkDoubleArray* xvtk_prop,
                            int xprop_tensor_rank);

protected:

  visualization_iterator();

  visualization_iterator(const visualization_iterator& xother)
  {}

  void initialize_iteration(const section_space_schema_member& xcoordinates_schema,
                            const section_space_schema_member& xproperty_schema);

  void initialize_iteration(
    const section_space_schema_member& xcoordinates_schema);

  bool _has_property;

  bool _use_point_top_ids;

  bool _use_cell_top_ids;

  section_iteration_state _coord_state;

  section_iteration_state _prop_state;

  section_iteration_state _vis_state;

  struct SHEAF_DLL_SPEC depth_flags_type
  {
    bool coord_eval;
    bool coord_disc;
    bool prop_eval;
    bool prop_disc;
    bool vis_eval;
    bool vis_disc;

    depth_flags_type& operator=(bool xvalue)
    {
      coord_eval = xvalue;
      coord_disc = xvalue;
      prop_eval  = xvalue;
      prop_disc  = xvalue;
      vis_eval   = xvalue;
      vis_disc   = xvalue;

      return(*this);
    };
  };

  depth_flags_type _at;

  depth_flags_type _above;

  // static const size_type _coord_dofs_ub = 3;

  enum static_const_int {COORD_DOFS_UB = 3, PROP_DOFS_UB = 16};

  sec_vd_dof_type _coord_dofs[COORD_DOFS_UB];

  //static const size_type _prop_dofs_ub = 16;

  sec_vd_dof_type _prop_dofs[PROP_DOFS_UB];

  void initialize_buffers();

  void clear_down_set();

  const abstract_poset_member& min(const abstract_poset_member& x1,
                                   const abstract_poset_member& x2) const;

  void initialize_states(const section_space_schema_member& xcoordinates_schema,
                         const section_space_schema_member& xproperty_schema);


  void initialize_states(const section_space_schema_member& xcoordinates_schema);

  int _cell_seq_id;

  int _pt_seq_id;

  void put_prop_dofs(sec_vd_dof_type* xprop_dofs,
                     size_type xprop_df,
                     int xprop_tensor_rank,
                     vtkDoubleArray* xvtk_prop,
                     int xvtk_tuple_id);

  double _st2_e3[3][3];

  double _st2_e2[3][3];

  scoped_index _maximal_eval_id;

};
 
} // namespace tool

#endif // ifndef VISUALIZATION_ITERATOR_H