gpucalc::GLGraphicCorePlugin Class Reference

This class represents Plugin for GLGraphicCore. More...

#include <gl_graphic_core_plugin.h>

Inheritance diagram for gpucalc::GLGraphicCorePlugin:

List of all members.

Public Member Functions
const std::string &	getClassName () const
	Returns name of class of our object.
const std::string &	getObjectName () const
	Returns name of our object.
void	getSpecificParameter (const std::string &ParameterName, void *ParameterValue)
	Method for obtaining some specific parameters, such as texture specific params, and so on.
	GLGraphicCorePlugin ()
void	install ()
bool	isLocked () const
	returns state of object.
void	uninstall ()
	~GLGraphicCorePlugin ()
Protected Member Functions
void	addSpecificParameter (const std::string &ParameterName, void *ParameterValue, size_t Size)
void	lock ()
void	unlock ()
Private Attributes
GLGraphicCore *	mGraphicCore

---

Detailed Description

This class represents Plugin for GLGraphicCore.

Definition at line 47 of file gl_graphic_core_plugin.h.

---

Constructor & Destructor Documentation

gpucalc::GLGraphicCorePlugin::GLGraphicCorePlugin

(

)

Definition at line 41 of file gl_graphic_core_plugin.cpp.

                                         : Plugin(_GLGraphicCorePluginObjectName), mGraphicCore(0)
 {
 }

gpucalc::GLGraphicCorePlugin::~GLGraphicCorePlugin

(

)

Definition at line 46 of file gl_graphic_core_plugin.cpp.

 {
 }

---

Member Function Documentation

void gpucalc::Object::addSpecificParameter	(	const std::string &	ParameterName,
		void *	ParameterValue,
		size_t	Size
	)			[inline, protected, inherited]

Definition at line 254 of file object.h.

   {
    SpecificParametersMap::iterator i = mSpecificParameters.find(ParameterName);
    if (i != mSpecificParameters.end())
    {
     mSpecificParameters.erase(i);
    }
    mSpecificParameters[ParameterName] = Any(ParameterValue, Size);
   }

const std::string& gpucalc::Object::getClassName

(

)

const [inline, inherited]

Returns name of class of our object.

Definition at line 92 of file object.h.

   {
    return mClassName;
   }

const std::string& gpucalc::Object::getObjectName

(

)

const [inline, inherited]

Returns name of our object.

Definition at line 101 of file object.h.

   {
    return mObjectName;
   }

void gpucalc::Object::getSpecificParameter	(	const std::string &	ParameterName,
		void *	ParameterValue
	)			[inline, inherited]

Method for obtaining some specific parameters, such as texture specific params, and so on.

Parameters:

	ParameterName	- name of parameter, usually it similar to specific method of some object (for example, GLTextureID)
	ParameterValue	- contain value of named parameter, it must be allocated and have sufficient size.

Todo:

Think for better realization.

Definition at line 128 of file object.h.

   {
    SpecificParametersMap::iterator i = mSpecificParameters.find(ParameterName);
    if (i != mSpecificParameters.end())
    {
     i->second.copyValue(ParameterValue);
    }
    else
    {
     Except<ERR_ITEM_NOT_FOUND>(this, "Parameter \"" + ParameterName + "\" does not exists.", "Object::getSpecificParameter()", __FILE__, __LINE__);
    }
   }

void gpucalc::GLGraphicCorePlugin::install

(

)

[virtual]

Implements gpucalc::Plugin.

Definition at line 51 of file gl_graphic_core_plugin.cpp.

 {
  mGraphicCore = new GLGraphicCore;
  Application::getSingleton().addGraphicCore(mGraphicCore);
  LogManager::getSingleton().logMessage(this, "OpenGLGraphicCore successfully installed.", LML_Trivial);
 }

bool gpucalc::Object::isLocked

(

)

const [inline, inherited]

returns state of object.

If object is locked then we cannot change some state of it, because object is used in computation. If object is unlocked then we can change some state of it, object is not in computation.

Definition at line 113 of file object.h.

   {
    return mIsLocked;
   }

void gpucalc::Object::lock

(

)

[inline, protected, inherited]

Definition at line 265 of file object.h.

   {
    mIsLocked = true;
   }

void gpucalc::GLGraphicCorePlugin::uninstall

(

)

[virtual]

Implements gpucalc::Plugin.

Definition at line 59 of file gl_graphic_core_plugin.cpp.

 {
  Application::getSingleton().removeGraphicCore(mGraphicCore);
  delete mGraphicCore;
  mGraphicCore = 0;
  LogManager::getSingleton().logMessage(this, "OpenGLGraphicCore successfully uninstalled.", LML_Trivial);
 }

void gpucalc::Object::unlock

(

)

[inline, protected, inherited]

Definition at line 271 of file object.h.

   {
    mIsLocked = false;
   }

---

Member Data Documentation

GLGraphicCore* gpucalc::GLGraphicCorePlugin::mGraphicCore [private]

Definition at line 73 of file gl_graphic_core_plugin.h.

---

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

• plugins/gl_graphic_core/gl_graphic_core_plugin.h
• plugins/gl_graphic_core/gl_graphic_core_plugin.cpp