AnimaL

Tutorial

Documentation

---

Documentation

• Overview
• Modules
• Namespace List
• Class Hierarchy
• Alphabetical List
• Compound List
• File List
• Namespace Members
• Compound Members
• File Members
• Examples

---

GeoLink.h

Go to the documentation of this file.

#ifndef _GEOLINK_H
#define _GEOLINK_H

#include <vector>

class GeoLink;


#include "ConstrainedVertex.h"


namespace animal
{
namespace octree 
{

/*
 * NB:
 * A free vertex can see it's parameters changed
 * A vertex is constrained by those types of link :
 *      - soft Link : the vertex is free to be changed, but for MR purposes,
 *          it's defined by 8 parents and 3 associated parameters. There are 4 types of parents' strains :
 *              * //0 parents, it's really free (only used for the 8 root's vertices)
 *              * 2 parents, when we move one of the 6 other vertices, we should FIRST updateParameters before
 *                  accessing the vertex position
 *              * 4 parents
 *              * 8 parents : so any change in a parent should NEVER updateParameters() !
 *      - hard link : the vertex is constrained only by it's geoparents, it will allways
 *          be defined by it's geoparents. There are only 2 cases :
 *              * 2 parents : the point is on a line, //use only  _alpha parameter
 *              * 4 parents : the point is on the "plane", //use only _alpha and _beta parameters
 *
 * The link also ensure that we are registred in our parents' children list
 * The destructor also unregister the vertex
 */
class GeoLink
{

public:
    
    /*
     * Give us the 8 pointers to our parents
     * Plus the number of geo linked parents and their corresponding IDs in the "allParents" array
     * Also give the fact that it's a hard link (for example, that the vertex IS NOT FREE)
     * or soft link (free, but from multiresolution edition, it can be moved)
     *
     * If the geolink is a hard link, then the parameters should never be updated !
     *
     * The parameters are updated
     */
    GeoLink( vector< ConstrainedVertex* > allParents, vector<unsigned short> geoParentsIds,
    bool isSoftLink, ConstrainedVertex *vertex );
    
    ~GeoLink();
    
    /*
     * Return true IFF vertex is in geoParents
     * For example, your should use this to see if we need to call updateParameters() or not
     * It the moved "vertex" is geolink parent then you should NOT update parameters
     * In the other case, you MUST update parameters
     * Require : isParent(vertex)
     */
    bool isGeoLinkParent( ConstrainedVertex *vertex );
    
    /*
     * Get the Vec3d position of the current vertex, by computing with the parameters
     */
    Vec3d getPosition()  const;

    
    void addVector( Vec3d v );
    unsigned short getNGeoParents() const;
    unsigned short getGeoParentId( unsigned short id )
    {
        Require( id < getNGeoParents() );
        return _geoParentsIds[id];
    }
    
    ConstrainedVertex * getGeoParent( unsigned short i )
    {
        Require( isGeoLinkParent(_parents[i]) );
        return _parents[i];
    };

    /*
     * This is used to change the cell we're in, for example when simplification occurs
     * We must change our geoparents and our geoparents ids so that we get the same vertices
     * which constrain the vertex
     */
    void changeCell( Cell *cell );
    
    
    /*
     * Update the parameters by recomputing it's barycentrical coordinates (if needed)
     * Require : isFree()
     */
     void updateParameters();
     
     /*
      * Return true if it's a soft link, and false if it's a hard link
        */
     bool isFree()  const;
    
     
     /*
      * Free it : make it a soft link and no more a hard link
        * Require : !isFree()
        * Ensure : isFree()
        */
        void freeIt();
        
        /*
         * Make it a hard link : project the point on the line
         * Require : isFree()
         * Require : vertices are parents
         */
        void hardLinkIt( ConstrainedVertex *v1, ConstrainedVertex *v2  );
        
        /*
         * Make it a hard link : project the point on the plane
         * Require : isFree()
         * Require : vertices are parents
         */
        void hardLinkIt( ConstrainedVertex *v1, ConstrainedVertex *v2, ConstrainedVertex *v3, ConstrainedVertex *v4  );

        void softLinkIt( ConstrainedVertex *v1, ConstrainedVertex *v2 );
        void softLinkIt( ConstrainedVertex *v1, ConstrainedVertex *v2, ConstrainedVertex *v3, ConstrainedVertex *v4 ); 
        void softLinkIt( ConstrainedVertex *v1, ConstrainedVertex *v2, ConstrainedVertex *v3, ConstrainedVertex *v4, ConstrainedVertex *v5, ConstrainedVertex *v6, ConstrainedVertex *v7, ConstrainedVertex *v8  );
        
        
        void print();

    /*
     * Return true IFF vertex is in parents list
     * Used only for debug
     */
     bool isParent( const ConstrainedVertex *vertex );
            
private:

     
     vector<ConstrainedVertex*> _parents;
     vector<unsigned short> _geoParentsIds;
     bool _isSoftLink;
     
     ConstrainedVertex * _vertex;
     
     /*
      * The parameters associated to each of the 8 parents
        */
     FloatingPointType _alpha, _beta, _gamma;
     FloatingPointType _alpha2, _beta2, _gamma2;

};

}
}

#endif

---