GelPosition.h

/********************************************************************/
/* Copyright (c) 2015 DG Technologies Inc. and Yuzi Mizuno          */
/* All rights reserved.                                             */
/********************************************************************/
#ifndef _MGGelPosition_HH_
#define _MGGelPosition_HH_

#include <iosfwd>
#include <vector>
#include "mg/MGCL.h"
#include "mg/Group.h"
#include "mg/AttribedGel.h"
class MGShell;

//
//Define MGGelPosition Class.


class MG_DLL_DECLR MGGelPosition{

public:

MG_DLL_DECLR friend std::ostream& operator<< (std::ostream&, const MGGelPosition&);


MGGelPosition();

explicit MGGelPosition(MGGroup* group, MGObject* obj=0);

MGGelPosition(const MGGelPosition& obj2);

virtual ~MGGelPosition(){;};

virtual MGGelPosition& operator= (const MGGelPosition& GelPosition2);

bool operator== (const MGGelPosition& gelp2) const;
bool operator!= (const MGGelPosition& gelp2) const{return !(*this==gelp2);}

bool operator<(const MGGelPosition& gp2)const;
bool operator>(const MGGelPosition& gp2)const{return gp2<(*this);};
bool operator<=(const MGGelPosition& gp2)const{return !((*this)>gp2);};
bool operator>=(const MGGelPosition& gp2)const{return !(gp2>(*this));};


void append_lower_gel(MGGel* gel);

const MGGel* gel(int i)const{return m_Ghierarcy[i];};
MGGel* gel(int i){return m_Ghierarcy[i];};

virtual MGGelPosition* clone()const;

void do_add();

void do_remove();

const MGGroup* bottom_group()const;
MGGroup* bottom_group();

const MGGroup* top_group()const{return m_group;};
MGGroup* top_group(){return m_group;};

//Get the shell pointer when this is_shell_face() is true.
//When is_shell_face() is false, behavior is undefined.
MGShell* get_shell_of_shell_face()const;

const MGGroup* is_a_member_of(const MGGroup* grp)const;

bool is_null() const;

bool is_shell_face()const;

//Test if this is this is one of the type of types.
bool is_type(const MGAbstractGels& types)const;

//Test if this leaf is MGGroup.
bool leaf_is_group()const;

const MGObject* top_object()const;
MGObject* top_object();

const MGObject* leaf_object()const{return m_object;};
MGObject* leaf_object(){return m_object;};

const MGAttribedGel* leafAttribedGel()const{return m_agel;};
MGAttribedGel* leafAttribedGel(){return m_agel;};

void set_attribedGel(MGAttribedGel* agel);

void set_leaf_object(MGObject* obj);

void set_top_group(MGGroup* group){m_group=group;};

void set_null();

bool symmetric(const MGGelPosition& gp2)const;

MGAttribedGel* targetGel();

protected:
    MGGroup* m_group;
    std::vector<MGGel*> m_Ghierarcy;//The group hierarcy. Let n=m_Ghierarcy.size(),
    MGAttribedGel* m_agel;
    MGObject* m_object; 

private:
    //Get the object pointer of this.
    const MGObject* top_object_sub()const;

    //Get the lowerest level of group pointer of this.
    const MGGroup* bottom_group_sub()const;
};
 // end of GelRelated group
#endif