Home Page Toolkit Overview Using GML   User Input Services     Finger Tracker     Calibrator     Frame Grabber     Service protocol Obtaining GML   Installing GML   Licence Developer Documentation   Tcl/Tk API     The GML Canvas     Image processing   Tcl Scripts Library     List of Classes     List of Files   C/C++ API     List of Classes     List of Files

gml_GRItem.h // gml_GRItem.h -- // // Declares the "gml_TGRItem" class. A gml_TGRItem objects is a graphical // object. It as a parent and its geometric transformation is expressed in // its parent reference. // // Copyright (c) 2003 CLIPS-IMAG // // See the file "gml_LicenseTerms.txt" for information on usage and redistribution // of this file, and for a DISCLAIMER OF ALL WARRANTIES. // // November 17, 2003 (FB) // Re-written for gml // separate GL rendering // debug // // Created on July 2003 (Yohan Piccoli / FB). #ifndef __GML_GRITEM__ #define __GML_GRITEM__ #include <stdlib.h> #include "gml/base/gml_Errors.h" #include "gml/base/gml_List.h" #include "gml/ui/gml_GRItem_Scene.h" #include "gml/ui/gml_GRItemTransfo.h" extern gml_TError gml_gGRItem_noScene; extern gml_TError gml_gGRItem_settingSelfAsParent; extern gml_TError gml_gGRItem_settingOffspringAsParent; extern gml_TError gml_gGRItem_notEnoughShapePoints; extern gml_TError gml_gGRItem_clippingLoop; extern gml_TError gml_gGRItem_settingSelfAsClipper; // gml_TGRItemAnchor -- // // Anchor of an item to a point, one on the 9 possibilities: // NW N NE // W C E // SW S SE typedef enum { gml_cGRItem_AnchorN, gml_cGRItem_AnchorNE, gml_cGRItem_AnchorE, gml_cGRItem_AnchorSE, gml_cGRItem_AnchorS, gml_cGRItem_AnchorSW, gml_cGRItem_AnchorW, gml_cGRItem_AnchorNW, gml_cGRItem_AnchorC } gml_TGRItemAnchor; extern char gml_cGRItem_AnchorStrings[9][3]; // gml_TGRItem -- class gml_TGRItem { public: // Init -- // // Initializes the item. // <scene> is the scene in which to add the new item. May be <NULL> is // <parentItem> is not NULL: an item is always in its parent scene. // <parentItem> is the parent item which transformation is applied before // drawing the item. // <NULL> means that this item is the root item. // <transfo> is the initial transformation from parent reference to // the origin of the item reference. // <NULL> means identity. // <clientData> is a client supplied parameter stored in the item and // made accessible through the "ClientData" method. virtual gml_TError Init (gml_TGRItem_Scene* scene = (gml_TGRItem_Scene*)NULL, gml_TGRItem* parentItem = (gml_TGRItem*)NULL, gml_TGRItemTransfo* transfo = (gml_TGRItemTransfo*)NULL, gml_TPointer clientData = (gml_TPointer)NULL); // Dispose -- // // Removes the Item from the hierarchy. virtual void Dispose (); virtual ~gml_TGRItem () {} // Suicide -- // // The C++ delete operator should not be called on gml_TGRItems, instead call // the "Suicide" method which must me implemented as "delete this;" in // the join (most specialized) class. virtual void Suicide () = 0; // Scene -- // // Return the scene in which the item is drawn. gml_TGRItem_Scene* Scene () { return fScene; } // SetParent -- // // Set <parent> as the parent of this item. Manages the update // of a previous parent if necessary. // <parent> may be NULL. gml_TError SetParent (gml_TGRItem* item); // Children -- // // Returns the list of children of this item. The list must be // used as read only. gml_TList* Children () { return fChildren; } // IsAncestor -- gml_TBoolean IsAncestor (gml_TGRItem* item); // IsOffspring -- gml_TBoolean IsOffspring (gml_TGRItem* item); // IsClipped -- gml_TBoolean IsClipped () { return (gml_TBoolean)(fClipper != NULL); } // ClippedByMe -- // // Returns the list of items clipped by this item. The list must be // used as read only. gml_TList* ClippedByMe () { return fClippedByMe; } // Clipper -- gml_TGRItem* Clipper () { return fClipper; } // SetClipper -- gml_TError SetClipper (gml_TGRItem* item); // SetItemTransfo -- // SetItemStdTransfov -- // SetItemStdTransfo -- inline void SetItemTransfo (gml_TGRItemTransfo* t); inline void SetItemStdTransfov (gml_TGRItemParam* stdTransfo); inline void SetItemStdTransfo (gml_TGRItemParam tx, gml_TGRItemParam ty, gml_TGRItemParam r, gml_TGRItemParam sx, gml_TGRItemParam sy); // Transfo -- // // Returns local transformation of the item from its immediate parent. gml_TGRItemTransfo* Transfo () { return fTransfo; } // GlobalTransfo -- // // Returns a pointer to the global transformation of the item. The returned // transformation must be considered as read only. inline gml_TGRItemTransfo* GlobalTransfo (); // ComputeGlobalTransfo -- // // Compute the global transformation: the transformation from item coordinates to // root coordinates. void ComputeGlobalTransfo (); // InvalidateGlobalTransfo -- // // Mark the global transformation as "dirty" so that the next time it is requested, it will // be recalculated. Inverse global transformation, bouding box and extended bounding box // are also marked "dirty". Propagates to the children. // If <ancestors> is true, propagates the invalidation of the extended bounding box to the // ancestors of the item. void InvalidateGlobalTransfo (gml_TBoolean ancestors = gml_cTrue); // InvGlobalTransfo -- // // Returns a pointer to the inverse global transformation of the item. The returned // transformation must be considered as read only. inline gml_TGRItemTransfo* InvGlobalTransfo (); // BBox -- // // Returns a pointer to the bounding box of the item. The returned array must be // considered as read only. // The bounding box is the smallest rectangle aligned with the root axis that // contains the item, expressed in root coordinates. // The bounding box is represented by the array of its // { left, bottom, right, top } coordinates. inline gml_TGRItemParam* BBox (); // UpdateNonClippedBBox -- // // Update the bounding box of an item as if it was not clipped by another item // (which may be the cas). virtual void UpdateNonClippedBBox () = 0; // InvalidateBBox -- // // Mark the bounding box "dirty" so that the next time it is requested, it will // be recalculated. Propagates to parent's extended bounding box. inline void InvalidateBBox (); // ExtBBox -- // // Returns the extended BBox of the item. See the "BBox" method for a definition of the // bouding box of the item. The extended BBox is the bounding box of the item and all // its children that are not clipped inside the item. inline gml_TGRItemParam* ExtBBox (); // ComputeExtBBox -- // // Updates the extended bounding box of the item. void ComputeExtBBox (); // InvalidateExtBBox -- // // Mark the extended bounding box "dirty" so that the next time it is requested, // it will be recalculated. Propagates to parent's extended bounding box. inline void InvalidateExtBBox (); // Draw -- // // Draws the item on screen. virtual void Draw () =0; // LocalToGlobal -- // GlobalToLocal -- // // "LocalToGlobal" transforms local (item) 2 dimentional vector coordinates in <locSrc> // to global (root window) 2 dimentional vector coordinates in <gloDst>. // "GlobalToLocal" does the opposite from <gloSrc> to <locDst>. inline void LocalToGlobal (gml_TGRItemParam* locSrc, gml_TGRItemParam* gloDst); inline void GlobalToLocal (gml_TGRItemParam* gloSrc, gml_TGRItemParam* locDst); // IsOverItem -- // // Returns true if the point <pt>, expressed in the global reference, is above a non // transparent pixel of the item. virtual gml_TBoolean IsOverItem (gml_TGRItemParam* pt) =0; // PointToItem and RelationToRect are deprecated. The only available way to pick items is // by calling "IsOverItem". // // PointToItem -- // // Returns the distance between the point <pt>, expressed in root coordinates, // to the item. virtual gml_TGRItemParam PointToItem (gml_TGRItemParam* pt) =0; // RelationToRect -- // // Returns the relation of the item versus a rectangle <rect>. // Returns 1 if the item is completely enclosed in the rectangle, // returns 0 if the item boundaries intersect the rectangle, and // returns -1 if the item is completely outside the rectangle. // <rect> is specified as the array of left, bottom, right, top coordinates // of the rectangle. virtual int RelationToRect (gml_TGRItemParam* rect) =0; // Layer -- int Layer () { return fLayer; } // SetLayer -- // // Set this layer level to <level> // change all descendant layer level if <withHierarchy> is not 0 // don't modify DisplayList order void SetLayer (int level, int whithHierarchy); // Visible -- gml_TBoolean Visible ( ) { return fVisible; } // SetVisible -- void SetVisible (gml_TBoolean visible) { fVisible = visible; } // GetEvents -- gml_TBoolean GetEvents ( ) { return fGetEvents; } // SetGetEvents -- void SetGetEvents (gml_TBoolean getEvents) { fGetEvents = getEvents; } // SetClientData-- // // Stores a pointer <clientData> in the item. This pointer is never used by the GRItem // library, it is provided to the library client code through the "ClientData" method. void SetClientData (void* clientData) { fClientData = clientData; } // ClientData -- // // See "SetClientData". gml_TPointer ClientData () { return fClientData; } protected: // IsInMyClippers -- gml_TBoolean IsInMyClippers (gml_TGRItem *item); friend gml_TError gml_GRItem_Initialize (); gml_TGRItem_Scene* fScene; /* scene in which item is drawn */ gml_TGRItemTransfo* fTransfo; /* transformation from item coordinates to parent's */ gml_TGRItemTransfo* fGlobal; /* transformation from item coordinates to root coordinates */ gml_TBoolean fGlobalDirty; /* true if fGlobal needs to be recomputed */ gml_TGRItemTransfo* fInvGlobal; /* transformation from root coordinates to item coordinates */ gml_TBoolean fInvGlobalDirty; /* true if fInvGlobal needs to be recomputed */ gml_TGRItemParam fBBox[4]; /* bounding box in global coords. (left bottom right top) */ gml_TBoolean fBBoxDirty; /* true if fBBox needs to be recomputed */ gml_TGRItemParam fExtBBox[4]; /* extended bounding box in global coords. (left bottom right top), i.e. the bouding box of the item plus all its non clipped children */ gml_TBoolean fExtBBoxDirty; /* true if fExtBBox needs to be recomputed */ gml_TGRItem* fParent; /* parent item */ gml_TList* fChildren; /* list of children */ gml_TGRItem* fClipper; /* clipping item */ gml_TList* fClippedByMe; /* list of items directly clipped by this item */ int fLayer; /* layer number (0 = bottom most) */ gml_TBoolean fVisible; /* true if item is visible */ gml_TBoolean fGetEvents; /* true if item recieves events */ gml_TPointer fClientData; /* Arbitrary one-word value for client use */ }; // Inline function definitions. // gml_TGRItem::SetItemTransfo -- // gml_TGRItem::SetItemStdTransfov -- // gml_TGRItem::SetItemStdTransfo -- inline void gml_TGRItem::SetItemTransfo (gml_TGRItemTransfo* t) { t->CopyTo (fTransfo); this->InvalidateGlobalTransfo (); } inline void gml_TGRItem::SetItemStdTransfov (gml_TGRItemParam* stdTransfo) { fTransfo->SetFromStdv (stdTransfo); this->InvalidateGlobalTransfo (); } inline void gml_TGRItem::SetItemStdTransfo (gml_TGRItemParam tx, gml_TGRItemParam ty, gml_TGRItemParam r, gml_TGRItemParam sx, gml_TGRItemParam sy) { fTransfo->SetFromStd (tx, ty, r, sx, sy); this->InvalidateGlobalTransfo (); } // gml_TGRItem::GlobalTransfo -- inline gml_TGRItemTransfo* gml_TGRItem::GlobalTransfo () { if (fGlobalDirty) this->ComputeGlobalTransfo (); return fGlobal; } // gml_TGRItem::InvGlobalTransfo -- inline gml_TGRItemTransfo* gml_TGRItem::InvGlobalTransfo () { if (fInvGlobalDirty) { fInvGlobal->SetFromInverse (this->GlobalTransfo ()); fInvGlobalDirty = gml_cFalse; } return fInvGlobal; } // gml_TGRItem::BBox -- inline gml_TGRItemParam* gml_TGRItem::BBox () { gml_TGRItemParam* bbox; if (fBBoxDirty) { this->UpdateNonClippedBBox (); if (fClipper != NULL) { bbox = fClipper->BBox (); if (bbox[0] > fBBox[0]) fBBox[0] = bbox[0]; if (bbox[1] > fBBox[1]) fBBox[1] = bbox[1]; if (bbox[2] < fBBox[2]) fBBox[2] = bbox[2]; if (bbox[3] < fBBox[3]) fBBox[3] = bbox[3]; } fBBoxDirty = gml_cFalse; } return fBBox; } // gml_TGRItem::InvalidateBBox -- inline void gml_TGRItem::InvalidateBBox () { fBBoxDirty = gml_cTrue; fExtBBoxDirty = gml_cTrue; if (fParent != (gml_TGRItem*)NULL) fParent->InvalidateExtBBox (); } // gml_TGRItem::ExtBBox -- inline gml_TGRItemParam* gml_TGRItem::ExtBBox () { if (fExtBBoxDirty) this->ComputeExtBBox (); return fExtBBox; } // gml_TGRItem::InvalidateExtBBox -- inline void gml_TGRItem::InvalidateExtBBox () { fExtBBoxDirty = gml_cTrue; if (fParent != (gml_TGRItem*)NULL) fParent->InvalidateExtBBox (); } // gml_TGRItem::LocalToGlobal -- inline void gml_TGRItem::LocalToGlobal (gml_TGRItemParam* locSrc, gml_TGRItemParam* gloDst) { this->GlobalTransfo ()->Transform2v (locSrc, gloDst); } // gml_TGRItem::GlobalToLocal -- inline void gml_TGRItem::GlobalToLocal (gml_TGRItemParam* gloSrc, gml_TGRItemParam* locDst) { this->InvGlobalTransfo ()->Transform2v (gloSrc, locDst); } #endif Generated on Tue Jun 12 14:03:27 2007 for gml by Doxygen 1.5.2.

Contact: julien (dot) letessier (at) gmail (dot) com. Copyright (c) 2000-2007 CLIPS-IMAG Laboratory, Grenoble, France. All rights reserved. W3CXHTML 1.0 W3CCSS 2.0