Inheritance diagram for tools::sg::node:

[legend]

Public Member Functions
virtual void *	cast (const std::string &a_class) const

virtual const std::string &	s_cls () const =0

virtual node *	copy () const =0

virtual unsigned int	cls_version () const

virtual const desc_fields &	node_desc_fields () const

virtual void	render (render_action &)

virtual void	pick (pick_action &)

virtual void	bbox (bbox_action &)

virtual void	search (search_action &a_action)

virtual void	get_matrix (get_matrix_action &a_action)

virtual bool	write (write_action &a_action)

virtual void	event (event_action &)

virtual bool	read (read_action &a_action)

virtual void	is_visible (visible_action &)

virtual void	protocol_one_fields (std::vector< field * > &a_fields) const

virtual bool	draw_in_frame_buffer () const

virtual bool	touched ()

virtual void	reset_touched ()

	node ()

virtual	~node ()

void	touch ()

field &	field_from_desc (const field_desc &a_desc) const

void	dump_field_descs (std::ostream &a_out) const

field *	find_field_by_name (const std::string &a_name) const

Protected Member Functions
	node (const node &)

node &	operator= (const node &)

void	add_field (field *a_field)

bool	write_fields (write_action &a_action)

bool	read_fields (read_action &a_action)

field_desc::offset_t	field_offset (const field *a_field) const

field *	find_field (const field_desc &a_rdesc) const

void	check_fields (std::ostream &a_out) const

Detailed Description

Definition at line 28 of file node.

Constructor & Destructor Documentation

◆ node() [1/2]

tools::sg::node::node ( )

inline

Definition at line 106 of file node.

   {
 #ifdef TOOLS_MEM
     mem::increment(s_class().c_str());
 #endif
   }

◆ ~node()

virtual tools::sg::node::~node ( )

inlinevirtual

Definition at line 112 of file node.

                  {
 #ifdef TOOLS_MEM
     mem::decrement(s_class().c_str());
 #endif
   }

◆ node() [2/2]

tools::sg::node::node ( const node & )

inlineprotected

Definition at line 118 of file node.

   {
 #ifdef TOOLS_MEM
     mem::increment(s_class().c_str());
 #endif
   }

Member Function Documentation

◆ add_field()

void tools::sg::node::add_field ( field * a_field )

inlineprotected

Definition at line 128 of file node.

                                  {
     m_fields.push_back(a_field); //it does not take ownerhship.
   }

◆ bbox()

virtual void tools::sg::node::bbox ( bbox_action & )

inlinevirtual

◆ cast()

virtual void* tools::sg::node::cast ( const std::string & a_class ) const

inlinevirtual

Reimplemented in tools::sg::tex_rect, tools::sg::tex_quadrilateral, tools::sg::holder< T >, and tools::sg::ellipse.

Definition at line 38 of file node.

                                                      {
     if(void* p = cmp_cast<node>(this,a_class)) return p;
     return 0;
   }

◆ check_fields()

void tools::sg::node::check_fields ( std::ostream & a_out ) const

inlineprotected

Definition at line 296 of file node.

                                              {
     const std::vector<field_desc>& fds = node_desc_fields();
     tools_vforcit(field*,m_fields,it) {
       bool found = false;
       tools_vforcit(field_desc,fds,itd) {
         if( ((*itd).offset()==field_offset(*it)) &&
             ((*itd).cls()==(*it)->s_cls())
         ){
           found = true;
           break;
         }
       }
       if(!found) {
         a_out << "tools::sg::node::check_fields :"
               << " WARNING : node of class " << s_cls()
               << " has bad fields description."
               << std::endl;
       }
     }
   }

◆ cls_version()

virtual unsigned int tools::sg::node::cls_version ( ) const

inlinevirtual

Definition at line 46 of file node.

46 {return 1;}

◆ copy()

virtual node* tools::sg::node::copy ( ) const

pure virtual

Implemented in tools::sg::holder< T >.

◆ draw_in_frame_buffer()

virtual bool tools::sg::node::draw_in_frame_buffer ( ) const

inlinevirtual

Reimplemented in tools::sg::text_hershey_marker, tools::sg::text_freetype_marker, and tools::sg::markers.

Definition at line 94 of file node.

94 {return false;} // marker nodes return true.

◆ dump_field_descs()

void tools::sg::node::dump_field_descs ( std::ostream & a_out ) const

inline

Definition at line 253 of file node.

                                                  {
     a_out << "field descs of node class " << s_cls() << " :" << std::endl;
     const std::vector<field_desc>& fds = node_desc_fields();
     tools_vforcit(field_desc,fds,itd) {
       a_out << "name " << (*itd).name()
             << ", class " << (*itd).cls()
             << ", offset " << (*itd).offset()
             << std::endl;
     }
   }

◆ event()

virtual void tools::sg::node::event ( event_action & )

inlinevirtual

Reimplemented in tools::sg::separator, tools::sg::plots, tools::sg::noderef, tools::sg::matrix, tools::sg::group, tools::sg::base_camera, and tools::sg::_switch.

Definition at line 88 of file node.

88 {}

◆ field_from_desc()

field& tools::sg::node::field_from_desc ( const field_desc & a_desc ) const

inline

Definition at line 249 of file node.

                                                          {
     //WARNING : touchy.
     return *((field*)((char*)this+a_desc.offset()));
   }

◆ field_offset()

field_desc::offset_t tools::sg::node::field_offset ( const field * a_field ) const

inlineprotected

Definition at line 278 of file node.

                                                               {
     //WARNING : touchy.
     return ((char*)(a_field)-(char*)(this));
   }

◆ find_field()

field* tools::sg::node::find_field ( const field_desc & a_rdesc ) const

inlineprotected

Definition at line 283 of file node.

                                                      {
     const std::vector<field_desc>& fds = node_desc_fields();
     tools_vforcit(field_desc,fds,it) {
       if((*it).name()==a_rdesc.name()) {
         tools_vforcit(field*,m_fields,itf) {
           //::printf("debug : find_field :   look : %s\n",field_name(*(*it)).c_str());
           if(field_offset(*itf)==(*it).offset()) return (*itf);
         }
       }
     }
     return 0;
   }

◆ find_field_by_name()

field* tools::sg::node::find_field_by_name ( const std::string & a_name ) const

inline

Definition at line 263 of file node.

                                                            {
     // a_name is of the form <class>.<field>. For example for color on sg::text, there are :
     //   tools::sg::back_area.color
     //   tools::sg::text.color
     const std::vector<field_desc>& fds = node_desc_fields();
     tools_vforcrit(field_desc,fds,it) {
       if((*it).name()==a_name) {
         tools_vforcit(field*,m_fields,itf) {
           if(field_offset(*itf)==(*it).offset()) return (*itf);
         }
       }
     }
     return 0;
   }

◆ get_matrix()

virtual void tools::sg::node::get_matrix ( get_matrix_action & a_action )

inlinevirtual

Reimplemented in tools::sg::separator, tools::sg::noderef, tools::sg::matrix, tools::sg::group, and tools::sg::base_camera.

Definition at line 76 of file node.

                                                        {
     if(this==a_action.node()){
       a_action.set_found_model(a_action.model_matrix());
       a_action.set_done(true);
     }
   }

◆ is_visible()

virtual void tools::sg::node::is_visible ( visible_action & )

inlinevirtual

Reimplemented in tools::sg::vertices, tools::sg::separator, tools::sg::noderef, tools::sg::matrix, tools::sg::group, and tools::sg::base_camera.

Definition at line 90 of file node.

90 {}

◆ node_desc_fields()

virtual const desc_fields& tools::sg::node::node_desc_fields ( ) const

inlinevirtual

Reimplemented in tools::sg::vertices, tools::sg::torche, tools::sg::text_valop, tools::sg::text_style, tools::sg::text_hershey, tools::sg::text, tools::sg::tex_rect, tools::sg::tex_quadrilateral, tools::sg::style, tools::sg::rgba, tools::sg::polyhedron, tools::sg::plotter, tools::sg::plots, tools::sg::perspective, tools::sg::ortho, tools::sg::normal, tools::sg::matrix, tools::sg::markers, tools::sg::line_style, tools::sg::line_set, tools::sg::legend, tools::sg::infos_box, tools::sg::holder< T >, tools::sg::ellipse, tools::sg::draw_style, tools::sg::cube, tools::sg::color, tools::sg::blend, tools::sg::base_text, tools::sg::base_freetype, tools::sg::base_camera, tools::sg::back_area, tools::sg::axis, tools::sg::atb_vertices, and tools::sg::_switch.

Definition at line 48 of file node.

                                                       {
     static const desc_fields s_v;
     return s_v;
   }

◆ operator=()

node& tools::sg::node::operator= ( const node & )

inlineprotected

Definition at line 124 of file node.

                               {
     return *this;
   }

◆ pick()

virtual void tools::sg::node::pick ( pick_action & )

inlinevirtual

◆ protocol_one_fields()

virtual void tools::sg::node::protocol_one_fields ( std::vector< field * > & a_fields ) const

inlinevirtual

Reimplemented in tools::sg::atb_vertices.

Definition at line 92 of file node.

92 {a_fields = m_fields;}

◆ read()

virtual bool tools::sg::node::read ( read_action & a_action )

inlinevirtual

Definition at line 89 of file node.

89 {return read_fields(a_action);}

◆ read_fields()

bool tools::sg::node::read_fields ( read_action & a_action )

inlineprotected

Definition at line 153 of file node.

                                           { //used in protocol-2.
     node_desc rndesc;
     if(!a_action.get_node_desc(s_cls(),rndesc)) {
       a_action.out() << "tools::node::read_fields :"
                      << " for node class " << s_cls()
                      << " : read_action.get_node_desc() failed."
                      << std::endl;
       return false;
     }
     //Whatever the current node fields, we must read all rndesc.fields() :
     tools_vforcit(field_desc,rndesc.fields(),it) {
       const field_desc& fdesc = *it;
  
       field* fd = find_field(fdesc);
       if(!fd) {
         a_action.out() << "tools::node::read_fields :"
                        << " for node class " << s_cls()
                        << " : field desc name " << fdesc.name()
                        << " : field desc class " << fdesc.cls()
                        << " : field desc offset " << fdesc.offset()
                        << " : field not found."
                        << "."
                        << std::endl;
 //#define TOOLS_NODE_DEBUG_READ_FIELD
 #ifdef TOOLS_NODE_DEBUG_READ_FIELD
         check_fields(a_action.out()); //costly.
         dump_field_descs(a_action.out());
        {a_action.out() << "read field descs of node class " << s_cls() << " :" << std::endl;
         tools_vforcit(field_desc,rndesc.fields(),itr) {
           a_action.out() << "name " << (*itr).name()
                 << ", class " << (*itr).cls()
                 << ", offset " << (*itr).offset()
                 << std::endl;
         }}
        {a_action.out() << "m_fields of node class " << s_cls() << " :" << std::endl;
         tools_vforcit(field*,m_fields,itm) {
           a_action.out() << "field class " << (*itm)->s_cls()
                 << ", found offset " << field_offset(*itm)
                 << std::endl;
         }}
         ::exit(0);
 #endif
         fd = a_action.field_factory().create(fdesc.cls());
         if(!fd) {
           a_action.out() << "tools::node::read_fields :"
                          << " for node class " << s_cls()
                          << " : field desc class " << fdesc.cls()
                          << " : can't create generic field."
                          << "."
                          << std::endl;
           return false;
         }
       } /*else {
         a_action.out() << "debug : inlib::node::read_fields :"
                        << " for node class " << s_cls()
                        << " : field desc class " << fdesc.cls()
                        << " : field desc offset " << fdesc.offset()
                        << " : field found."
                        << "."
                        << std::endl;
       }*/
  
       if(!fd->read(a_action.buffer())) {
         a_action.out() << "tools::node::read_fields :"
                        << " for node class " << s_cls()
                        << " : and field class " << fd->s_cls()
                        << " : field read() failed."
                        << std::endl;
         return false;
       }
       //fd->dump(a_action.out());
     }
  
     //NOTE : if some current node fields had not been found
     //       in rndesc.fields(), they catch the default value
     //       of the node fields.
  
     return true;
   }

◆ render()

virtual void tools::sg::node::render ( render_action & )

inlinevirtual

Reimplemented in tools::sg::text_freetype_marker, tools::sg::text_freetype, tools::sg::vertices, tools::sg::torche, tools::sg::text_valop, tools::sg::text_hershey_marker, tools::sg::text_hershey, tools::sg::text, tools::sg::tex_rect, tools::sg::tex_quadrilateral, tools::sg::separator, tools::sg::rgba, tools::sg::polyhedron, tools::sg::plotter, tools::sg::plots, tools::sg::normal, tools::sg::noderef, tools::sg::nodekit, tools::sg::matrix, tools::sg::markers, tools::sg::line_set, tools::sg::legend, tools::sg::infos_box, tools::sg::head_light, tools::sg::group, tools::sg::ellipse, tools::sg::dummy_freetype, tools::sg::draw_style, tools::sg::cube, tools::sg::color, tools::sg::blend, tools::sg::base_camera, tools::sg::back_area, tools::sg::axis, tools::sg::atb_vertices, and tools::sg::_switch.

Definition at line 53 of file node.

53 {}

◆ reset_touched()

virtual void tools::sg::node::reset_touched ( )

inlinevirtual

Reimplemented in tools::sg::plotter, and tools::sg::axis.

Definition at line 102 of file node.

                                {
     tools_vforcit(field*,m_fields,it) (*it)->reset_touched();
   }

◆ s_cls()

virtual const std::string& tools::sg::node::s_cls ( ) const

pure virtual

Implemented in tools::sg::holder< T >.

◆ search()

virtual void tools::sg::node::search ( search_action & a_action )

inlinevirtual

Reimplemented in tools::sg::text_valop, tools::sg::text, tools::sg::plotter, tools::sg::plots, tools::sg::noderef, tools::sg::nodekit, tools::sg::legend, tools::sg::infos_box, tools::sg::group, tools::sg::back_area, tools::sg::axis, and tools::sg::_switch.

Definition at line 56 of file node.

                                                {
     if(a_action.what()==search_action::search_node_of_class) {
       if(void* p = cast(a_action.sclass())) {
         a_action.add_obj(p);
         if(a_action.stop_at_first()) a_action.set_done(true);
       }
     } else if(a_action.what()==search_action::search_path_to_node) {
       if(this==a_action.node()){
         a_action.path_push(this); //ending node in the path.
         a_action.set_done(true);
       }
     } else if(a_action.what()==search_action::search_path_to_node_of_class) {
       if(cast(a_action.sclass())) {
         search_action::path_t path = a_action.path();
         path.push_back(this);
         a_action.add_path(path);
         if(a_action.stop_at_first()) a_action.set_done(true);
       }
     }
   }

◆ touch()

void tools::sg::node::touch ( )

inline

Definition at line 233 of file node.

                {
     if(m_fields.empty()) return;
     m_fields.front()->touch();
   }

◆ touched()

virtual bool tools::sg::node::touched ( )

inlinevirtual

Reimplemented in tools::sg::plotter, tools::sg::plots, and tools::sg::axis.

Definition at line 96 of file node.

                          { //virtual for plotter.
     tools_vforcit(field*,m_fields,it) {
       if((*it)->touched()) return true;
     }
     return false;
   }

◆ write()

virtual bool tools::sg::node::write ( write_action & a_action )

inlinevirtual

Reimplemented in tools::sg::separator, tools::sg::plotter, tools::sg::plots, tools::sg::noderef, tools::sg::infos_box, tools::sg::group, tools::sg::axis, and tools::sg::_switch.

Definition at line 82 of file node.

                                              {
     if(!a_action.beg_node(*this)) return false;
     if(!write_fields(a_action)) return false;
     if(!a_action.end_node(*this)) return false;
     return true;
   }

◆ write_fields()

bool tools::sg::node::write_fields ( write_action & a_action )

inlineprotected

Definition at line 132 of file node.

                                             {
  
     check_fields(a_action.out()); //costly.
   //dump_field_descs(a_action.out());
  
     unsigned int index = 0;
     tools_vforcit(field*,m_fields,it) {
       if(!(*it)->write(a_action.buffer())) {
         a_action.out() << "node::write_fields :"
                        << " for field index " << index
                        << " and field class " << (*it)->s_cls()
                        << " of node class " << s_cls()
                        << " : field.write() failed" << "."
                        << std::endl;
         return false;
       }
       index++;
     }
     return true;
   }

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

/Users/barrand/private/dev/softinex/g4tools/g4tools/tools/sg/node

Public Member Functions

Protected Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ node() [1/2]

◆ ~node()

◆ node() [2/2]

Member Function Documentation

◆ add_field()

◆ bbox()

◆ cast()

◆ check_fields()

◆ cls_version()

◆ copy()

◆ draw_in_frame_buffer()

◆ dump_field_descs()

◆ event()

◆ field_from_desc()

◆ field_offset()

◆ find_field()

◆ find_field_by_name()

◆ get_matrix()

◆ is_visible()

◆ node_desc_fields()

◆ operator=()

◆ pick()

◆ protocol_one_fields()

◆ read()

◆ read_fields()

◆ render()

◆ reset_touched()

◆ s_cls()

◆ search()

◆ touch()

◆ touched()

◆ write()

◆ write_fields()