RefCountMField.h

Go to the documentation of this file.

//    Copyright 2004-2019, SenseGraphics AB
//
//    This file is part of H3D API.
//
//    H3D API is free software; you can redistribute it and/or modify
//    it under the terms of the GNU General Public License as published by
//    the Free Software Foundation; either version 2 of the License, or
//    (at your option) any later version.
//
//    H3D API is distributed in the hope that it will be useful,
//    but WITHOUT ANY WARRANTY; without even the implied warranty of
//    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
//    GNU General Public License for more details.
//
//    You should have received a copy of the GNU General Public License
//    along with H3D API; if not, write to the Free Software
//    Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
//
//    A commercial license is also available. Please contact us at 
//    www.sensegraphics.com for more information.
//
//
//
#ifndef __REFCOUNTMFIELD_H__
#define __REFCOUNTMFIELD_H__
 
#include <H3D/MField.h>
#include <H3D/MFNodeAutoRefVector.h>
 
namespace H3D {
 
  typedef AutoRefVector< Node > NodeVector;
  
  template< class RefClass >
  class RefCountMField: 
    public MFieldBase< RefClass *, 
                       FieldInternals::MFNodeAutoRefVector< RefClass >,
                       Field > {
  public:   
 
    typedef NodeVector vector_return_type;
    
    typedef MFieldBase< RefClass *, 
                        FieldInternals::MFNodeAutoRefVector< RefClass >,
                        Field > BaseFieldType;
 
    H3D_VALUE_EXCEPTION( typename BaseFieldType::size_type, InvalidIndex );
 
 
    RefCountMField() {
      AUTOREF_DEBUG_NAME( value, "RefCountMField::value")
      this->value.owner = this;
    }
 
    RefCountMField( typename FieldInternals::MFNodeAutoRefVector< RefClass >::size_type sz ) : 
      MFieldBase< RefClass *, 
                  FieldInternals::MFNodeAutoRefVector< RefClass >,
                  Field >( sz ){
      AUTOREF_DEBUG_NAME( value, "RefCountMField::value")
      this->value.owner = this;
    }
    
    ~RefCountMField() {
      this->value.clear();
    };
 
    inline virtual const NodeVector &getValue( int id = 0 ) {
      this->checkAccessTypeGet( id );
      this->upToDate();
      return this->value;
    }
 
    inline virtual RefClass * getValueByIndex( 
                                              typename BaseFieldType::size_type i,
                                              int id = 0 ) {
      this->checkAccessTypeGet( id );
      this->upToDate();
      // i < 0 is never true..
      if( /* i < 0 || */i >= this->value.size() ) {
        stringstream s;
        s << "Trying to access value outside the bounds of field "
          << this->getFullName() << ". Field has size " << this->value.size()
          << ". ";
        throw InvalidIndex( i, s.str(), H3D_FULL_LOCATION );
      }
      return this->value[i];    
    }
 
    inline void setValue( typename FieldInternals::MFNodeAutoRefVector< RefClass >::size_type i,
                          const typename FieldInternals::MFNodeAutoRefVector< RefClass >::value_type &v,
                          int id = 0 ) {
      this->checkAccessTypeSet( id );
      this->value.set( i, v );
      // generate an event.
      this->startEvent();                                  
    }
    
    inline virtual void setValue( const AutoRefVector< RefClass > &v,
                                  int id = 0  ) {
      this->checkAccessTypeSet( id );
      this->value = v;
      this->startEvent();
    }
    
    inline virtual void setValue( const vector< RefClass * > &v, int id = 0 ) {
      this->checkAccessTypeSet( id );
      this->value = v;
      this->startEvent();
    }
 
    inline virtual void swap( vector< RefClass * > &v, int id = 0 ) {
      this->checkAccessTypeSet( id );
      this->checkAccessTypeGet( id );
      this->upToDate();
      this->value.swap( v );
      this->startEvent();
    }
 
    inline virtual void erase( RefClass *a, int id = 0 ) {
      this->checkAccessTypeSet( id );
      this->upToDate();
      this->value.erase( a );
      this->startEvent();
    } 
 
    inline virtual void erase( unsigned int pos, int id = 0 ) {
      this->checkAccessTypeSet( id );
      this->upToDate();
      this->value.erase( pos );
      this->startEvent();
    } 
 
    inline virtual void insert( unsigned int pos, 
                                RefClass *a, 
                                int id = 0 ) {
      this->checkAccessTypeSet( id );
      this->upToDate();
      this->value.insert( pos, a );
      this->startEvent();
    } 
    
    virtual string getTypeName() {
      return classTypeName();
    }
    
    static string classTypeName() {
      return "RefCountMField";
    }
    
  protected:
    friend class FieldInternals::MFNodeAutoRefVector<RefClass>;
    
    inline virtual void update() {
      this->value = static_cast< RefCountMField* >(this->event.ptr)->getValue();
    }
 
    virtual RefClass *preOnAdd( RefClass *n ) {
      return n;
    }
 
    virtual RefClass *preOnRemove( RefClass *n ) {
      return n;
    }
 
H3D_PUSH_WARNINGS()
H3D_DISABLE_UNUSED_PARAMETER_WARNING()
    virtual void onAdd( RefClass *n ) {
#ifdef REF_COUNT_DEBUG
      Console(LogLevel::Debug) << "RefCountMField::onAdd( " << getFullName() << " = " << this 
                 << ", n = " << n << ") " << endl;
#endif
    }
    
    virtual void onRemove( RefClass *n ) {
#ifdef REF_COUNT_DEBUG
      Console(LogLevel::Debug) << "RefCountMField::onRemove( " << getFullName() << " = " 
                 << this << ", n = " << n << ") " << endl;
#endif
    }
H3D_POP_WARNINGS()
  };
 
}
 
#endif