GmLuaRegularGridMesh Class Reference

A proxy class to export GmRegularGridMesh methods to the Lua environment. More...

#include <gmLuaMesh.h>

Inheritance diagram for GmLuaRegularGridMesh:

Collaboration diagram for GmLuaRegularGridMesh:

Public Member Functions
	GmLuaRegularGridMesh (GmRegularGridMesh *mesh, const GmLogCategory &logger)
	Constructor.
virtual const char *	typeName () const
	Returns the object type as will be stored in the object metatable.
virtual void	fillMetatable (lua_State *L, int index)
	Prepares the object metatable for calling methods.
virtual void *	getClassMetatableID ()
	Returns an unique identifier to identify an user object as a GmLuaMesh object.
Public Member Functions inherited from GmLuaMesh
	GmLuaMesh (GmMesh *mesh, const GmLogCategory &logger)
	Constructor. Receives the mesh to be wrapped.
virtual	~GmLuaMesh ()
	Destructor.
virtual QString	toString () const
	Default method used by the __tostring metamethod to capture the result of tostring() over an object.
GmMesh *	mesh () const
	Returns the wrapped mesh.
Public Member Functions inherited from GmLuaObject
virtual	~GmLuaObject ()
	Destrutor.
virtual void	populateMetatable (lua_State *L, int index)
	Fills the object metatable to allow for the proxy to export its methods.
QVariant	ptrToVariant ()
	Constructs a QVariant storing a POINTER to the current object.
void	ref ()
	Increments the object reference count. Use with care.

Private Member Functions
int	nodeSpacing (lua_State *L)
	Given a dimension index (starting from 1), retuns the spacing in that direction.
int	nodeCount (lua_State *L)
	Given a dimension index (starting from 1), retuns the node count in that direction.
int	nodeWrap (lua_State *L)
	Given a dimension index (starting from 1), retuns whether the mesh wraps around (last node connected to first) on that dimension.
int	nodeFromIndex (lua_State *L)
	Given a set of dimension indices (starting from 1), returns the equivalent node index.
int	indexFromNode (lua_State *L)
	Given a node index (starting from 1), returns its set of grid indices.
int	neighbor (lua_State *L)
	Given a node index (starting with 1) and an offset in each grid dimension, returns the index of the neighbor node or nil if no neighbor exists.

Additional Inherited Members
Protected Member Functions inherited from GmLuaObject
	GmLuaObject (const GmLogCategory &logger)
	Construtor protegido. Somente classes derivadas devem ser instanciadas.
Protected Attributes inherited from GmLuaMesh
GmMesh *	_mesh
	The mesh 'wrapped' by this proxy object.
Protected Attributes inherited from GmLuaObject
const GmLogCategory &	_logger
	A logger used by the proxy when needed.
QAtomicInteger< int >	_refCount
	Lua objects are reference counted to enable sharing them among different states. This is needed to allow for passing objects as parameters in a parallel call. The garbage collection method releases memory only for the last reference.

Detailed Description

A proxy class to export GmRegularGridMesh methods to the Lua environment.

---

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

• inc/gmLuaMesh.h
• src/gmLuaMesh.cpp