The Gnome Chemistry Utils  0.14.13
Public Member Functions | Protected Attributes | List of all members
gcu::GLDocument Class Referenceabstract

#include <gcu/gldocument.h>

Inheritance diagram for gcu::GLDocument:
gcu::Document gcu::Object gcu::DialogOwner gcr::Document gcu::Chem3dDoc gcugtk::Chem3dDoc

Public Member Functions

 GLDocument (Application *App)
 
virtual ~GLDocument ()
 
virtual void Draw (Matrix const &m) const =0
 
double GetMaxDist (void)
 
GLViewGetView (void)
 
- Public Member Functions inherited from gcu::Document
 Document (Application *App=NULL)
 
virtual ~Document ()
 
std::string & GetTranslatedId (const char *id)
 
void EraseTranslationId (const char *Id)
 
void EmptyTranslationTable ()
 
virtual void SetTitle (std::string &title)
 
virtual void SetTitle (char const *title)
 
std::string & GetTitle ()
 
void NotifyDirty (Object *pObject)
 
virtual void Save () const
 
virtual ResidueCreateResidue (char const *name, char const *symbol, Molecule *molecule)
 
virtual Residue const * GetResidue (char const *symbol, bool *ambiguous=NULL)
 
virtual GtkWindow * GetGtkWindow ()
 
bool SetTarget (char const *id, Object **target, Object *parent, Object *owner=NULL, Action action=ActionException) throw (std::runtime_error)
 
virtual bool Loaded () throw (LoaderError)
 
std::string Name ()
 
void ObjectLoaded (Object *obj)
 
std::set< Object * > GetNewObjects ()
 
virtual WindowGetWindow ()
 
ApplicationGetApp (void)
 
bool GetEmpty (void)
 
void SetScale (double val)
 
double GetScale (void) const
 
double & GetRefScale (void)
 
- Public Member Functions inherited from gcu::Object
 Object (TypeId Id=OtherType)
 
virtual ~Object ()
 
TypeId GetType () const
 
void SetId (gchar const *Id)
 
char const * GetId () const
 
virtual void AddChild (Object *object)
 
ObjectGetMolecule () const
 
ObjectGetReaction () const
 
ObjectGetGroup () const
 
DocumentGetDocument () const
 
ApplicationGetApplication () const
 
ObjectGetParentOfType (TypeId Id) const
 
ObjectGetChild (const gchar *Id) const
 
ObjectGetFirstChild (std::map< std::string, Object * >::iterator &i)
 
ObjectGetNextChild (std::map< std::string, Object * >::iterator &i)
 
ObjectGetDescendant (const char *Id) const
 
ObjectGetParent () const
 
void SetParent (Object *Parent)
 
virtual xmlNodePtr Save (xmlDocPtr xml) const
 
virtual bool Load (xmlNodePtr node)
 
virtual bool GetCoords (double *x, double *y, double *z=NULL) const
 
virtual void Move (double x, double y, double z=0.)
 
virtual void Transform2D (Matrix2D &m, double x, double y)
 
bool SaveChildren (xmlDocPtr xml, xmlNodePtr node) const
 
void SaveId (xmlNodePtr node) const
 
xmlNodePtr GetNodeByProp (xmlNodePtr node, char const *Property, char const *Id)
 
xmlNodePtr GetNextNodeByProp (xmlNodePtr node, char const *Property, char const *Id)
 
xmlNodePtr GetNodeByName (xmlNodePtr node, char const *Name)
 
xmlNodePtr GetNextNodeByName (xmlNodePtr node, char const *Name)
 
bool HasChildren () const
 
unsigned GetChildrenNumber () const
 
virtual ObjectGetAtomAt (double x, double y, double z=0.)
 
virtual bool Build (std::set< Object * > const &Children) throw (std::invalid_argument)
 
virtual double GetYAlign ()
 
virtual bool BuildContextualMenu (UIManager *uim, Object *object, double x, double y)
 
void EmitSignal (SignalId Signal)
 
virtual bool OnSignal (SignalId Signal, Object *Child)
 
void Lock (bool state=true)
 
bool IsLocked ()
 
ObjectGetFirstLink (std::set< Object * >::iterator &i)
 
ObjectGetNextLink (std::set< Object * >::iterator &i)
 
void Link (Object *object)
 
void Unlink (Object *object)
 
virtual void OnUnlink (Object *object)
 
void GetPossibleAncestorTypes (std::set< TypeId > &types) const
 
virtual bool SetProperty (unsigned property, char const *value)
 
virtual std::string GetProperty (unsigned property) const
 
virtual void OnLoaded ()
 
void SetDirty (bool dirty=true)
 
virtual void Clear ()
 
std::string Identity ()
 
virtual char const * HasPropertiesDialog () const
 
virtual bool CanSelect () const
 
virtual void NotifyEmpty ()
 
void ShowPropertiesDialog ()
 
bool GetDirty (void) const
 
- Public Member Functions inherited from gcu::DialogOwner
 DialogOwner ()
 
virtual ~DialogOwner ()
 
DialogGetDialog (std::string name) const
 
void ClearDialogs ()
 

Protected Attributes

double m_MaxDist
 
GLViewm_View
 
- Protected Attributes inherited from gcu::Document
std::string m_Title
 
std::set< Object * > m_DirtyObjects
 
Applicationm_App
 
bool m_Empty
 

Additional Inherited Members

- Static Public Member Functions inherited from gcu::Object
static TypeId AddType (std::string TypeName, Object *(*CreateFunc)(), TypeId id=OtherType)
 
static void AddAlias (TypeId id, std::string TypeName)
 
static ObjectCreateObject (const std::string &TypeName, Object *parent=NULL)
 
static TypeId GetTypeId (const std::string &Name)
 
static std::string GetTypeName (TypeId Id)
 
static void AddMenuCallback (TypeId Id, BuildMenuCb cb)
 
static void AddRule (TypeId type1, RuleId rule, TypeId type2)
 
static void AddRule (const std::string &type1, RuleId rule, const std::string &type2)
 
static const std::set< TypeId > & GetRules (TypeId type, RuleId rule)
 
static const std::set< TypeId > & GetRules (const std::string &type, RuleId rule)
 
static void SetCreationLabel (TypeId Id, std::string Label)
 
static const std::string & GetCreationLabel (TypeId Id)
 
static const std::string & GetCreationLabel (const std::string &TypeName)
 
static SignalId CreateNewSignalId ()
 
- Protected Member Functions inherited from gcu::Object
virtual DialogBuildPropertiesDialog ()
 

Detailed Description

This class is a base class for documents representing 3d objects.

Definition at line 42 of file gldocument.h.

Constructor & Destructor Documentation

gcu::GLDocument::GLDocument ( Application App)
Parameters
Appthe application owning the new document.

Default constructor.

virtual gcu::GLDocument::~GLDocument ( )
virtual

Default destructor.

Member Function Documentation

virtual void gcu::GLDocument::Draw ( Matrix const &  m) const
pure virtual
Parameters
mthe Matrix giving the current model orientation

Called by GLView::Update to render the model.

Implemented in gcr::Document, and gcu::Chem3dDoc.

gcu::GLDocument::GetMaxDist ( void  )
inline
Returns
the longest distance between any object and the center of the model.

Definition at line 70 of file gldocument.h.

gcu::GLDocument::GetView ( void  )
inline
Returns
the associated GLView instance.

Definition at line 77 of file gldocument.h.

Member Data Documentation

gcu::GLDocument::m_MaxDist
protected

The longest distance between any object and the center of the model.

Definition at line 70 of file gldocument.h.

gcu::GLDocument::m_View
protected

The associated GLView instance.

Definition at line 77 of file gldocument.h.


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