OGRE: Ogre::CompositionPassTranslator Class Reference - OGRE Documentation

# Ogre::CompositionPassTranslator Class Reference

`#include <OgreScriptTranslator.h>`

Inheritance diagram for Ogre::CompositionPassTranslator:

[legend]

List of all members.

## Public Member Functions
| CompositionPassTranslator ()
void | translate (ScriptCompiler *compiler, const AbstractNodePtr &node)
| This function translates the given node into Ogre resource(s).
void * | operator new (size_t sz, const char *file, int line, const char *func)
| operator new, with debug line info
void * | operator new (size_t sz)
void * | operator new (size_t sz, void *ptr)
| placement operator new
void * | operator new[] (size_t sz, const char *file, int line, const char *func)
| array operator new, with debug line info
void * | operator new[] (size_t sz)
void | operator delete (void *ptr)
void | operator delete (void *ptr, void *)
void | operator delete (void *ptr, const char *, int, const char *)
void | operator delete[] (void *ptr)
void | operator delete[] (void *ptr, const char *, int, const char *)
## Protected Member Functions
void | processNode (ScriptCompiler *compiler, const AbstractNodePtr &node)
| Retrieves a new translator from the factories and uses it to process the give node.
## Static Protected Member Functions
static AbstractNodeList::const_iterator | getNodeAt (const AbstractNodeList &nodes, int index)
| Retrieves the node iterator at the given index.
static bool | getBoolean (const AbstractNodePtr &node, bool *result)
| Converts the node to a boolean and returns true if successful.
static bool | getString (const AbstractNodePtr &node, String *result)
| Converts the node to a string and returns true if successful.
static bool | getReal (const AbstractNodePtr &node, Real *result)
| Converts the node to a Real and returns true if successful.
static bool | getFloat (const AbstractNodePtr &node, float *result)
| Converts the node to a float and returns true if successful.
static bool | getInt (const AbstractNodePtr &node, int *result)
| Converts the node to an integer and returns true if successful.
static bool | getUInt (const AbstractNodePtr &node, uint32 *result)
| Converts the node to an unsigned integer and returns true if successful.
static bool | getColour (AbstractNodeList::const_iterator i, AbstractNodeList::const_iterator end, ColourValue *result, int maxEntries=4)
| Converts the range of nodes to a ColourValue and returns true if successful.
static bool | getSceneBlendFactor (const AbstractNodePtr &node, SceneBlendFactor *sbf)
| Converts the node to a SceneBlendFactor enum and returns true if successful.
static bool | getCompareFunction (const AbstractNodePtr &node, CompareFunction *func)
| Converts the node to a CompareFunction enum and returns true if successful.
static bool | getMatrix4 (AbstractNodeList::const_iterator i, AbstractNodeList::const_iterator end, Matrix4 *m)
| Converts the range of nodes to a Matrix4 and returns true if successful.
static bool | getInts (AbstractNodeList::const_iterator i, AbstractNodeList::const_iterator end, int *vals, int count)
| Converts the range of nodes to an array of ints and returns true if successful.
static bool | getFloats (AbstractNodeList::const_iterator i, AbstractNodeList::const_iterator end, float *vals, int count)
| Converts the range of nodes to an array of floats and returns true if successful.
static bool | getStencilOp (const AbstractNodePtr &node, StencilOperation *op)
| Converts the node to a StencilOperation enum and returns true if successful.
## Protected Attributes
CompositionPass * | mPass

## Detailed Description

Definition at line 226 of file OgreScriptTranslator.h.

## Constructor & Destructor Documentation

Ogre::CompositionPassTranslator::CompositionPassTranslator | ( |  | ) |

## Member Function Documentation

void Ogre::CompositionPassTranslator::translate | ( | ScriptCompiler * | compiler,
|  | const AbstractNodePtr & | node |
| ) |  |  | `[virtual]`

This function translates the given node into Ogre resource(s).

Parameters:

  | compiler | The compiler invoking this translator
  | node | The current AST node to be translated

Implements Ogre::ScriptTranslator.

void Ogre::ScriptTranslator::processNode | ( | ScriptCompiler * | compiler,
|  | const AbstractNodePtr & | node |
| ) |  |  | `[protected, inherited]`

Retrieves a new translator from the factories and uses it to process the give node.

static AbstractNodeList::const_iterator Ogre::ScriptTranslator::getNodeAt | ( | const AbstractNodeList & | nodes,
|  | int | index |
| ) |  |  | `[static, protected, inherited]`

Retrieves the node iterator at the given index.

static bool Ogre::ScriptTranslator::getBoolean | ( | const AbstractNodePtr & | node,
|  | bool * | result |
| ) |  |  | `[static, protected, inherited]`

Converts the node to a boolean and returns true if successful.

static bool Ogre::ScriptTranslator::getString | ( | const AbstractNodePtr & | node,
|  | String * | result |
| ) |  |  | `[static, protected, inherited]`

Converts the node to a string and returns true if successful.

static bool Ogre::ScriptTranslator::getReal | ( | const AbstractNodePtr & | node,
|  | Real * | result |
| ) |  |  | `[static, protected, inherited]`

Converts the node to a Real and returns true if successful.

static bool Ogre::ScriptTranslator::getFloat | ( | const AbstractNodePtr & | node,
|  | float * | result |
| ) |  |  | `[static, protected, inherited]`

Converts the node to a float and returns true if successful.

static bool Ogre::ScriptTranslator::getInt | ( | const AbstractNodePtr & | node,
|  | int * | result |
| ) |  |  | `[static, protected, inherited]`

Converts the node to an integer and returns true if successful.

static bool Ogre::ScriptTranslator::getUInt | ( | const AbstractNodePtr & | node,
|  | uint32 * | result |
| ) |  |  | `[static, protected, inherited]`

Converts the node to an unsigned integer and returns true if successful.

static bool Ogre::ScriptTranslator::getColour | ( | AbstractNodeList::const_iterator | i,
|  | AbstractNodeList::const_iterator | end,
|  | ColourValue * | result,
|  | int | maxEntries = `4` |
| ) |  |  | `[static, protected, inherited]`

Converts the range of nodes to a ColourValue and returns true if successful.

static bool Ogre::ScriptTranslator::getSceneBlendFactor | ( | const AbstractNodePtr & | node,
|  | SceneBlendFactor * | sbf |
| ) |  |  | `[static, protected, inherited]`

Converts the node to a SceneBlendFactor enum and returns true if successful.

static bool Ogre::ScriptTranslator::getCompareFunction | ( | const AbstractNodePtr & | node,
|  | CompareFunction * | func |
| ) |  |  | `[static, protected, inherited]`

Converts the node to a CompareFunction enum and returns true if successful.

static bool Ogre::ScriptTranslator::getMatrix4 | ( | AbstractNodeList::const_iterator | i,
|  | AbstractNodeList::const_iterator | end,
|  | Matrix4 * | m |
| ) |  |  | `[static, protected, inherited]`

Converts the range of nodes to a Matrix4 and returns true if successful.

static bool Ogre::ScriptTranslator::getInts | ( | AbstractNodeList::const_iterator | i,
|  | AbstractNodeList::const_iterator | end,
|  | int * | vals,
|  | int | count |
| ) |  |  | `[static, protected, inherited]`

Converts the range of nodes to an array of ints and returns true if successful.

static bool Ogre::ScriptTranslator::getFloats | ( | AbstractNodeList::const_iterator | i,
|  | AbstractNodeList::const_iterator | end,
|  | float * | vals,
|  | int | count |
| ) |  |  | `[static, protected, inherited]`

Converts the range of nodes to an array of floats and returns true if successful.

static bool Ogre::ScriptTranslator::getStencilOp | ( | const AbstractNodePtr & | node,
|  | StencilOperation * | op |
| ) |  |  | `[static, protected, inherited]`

Converts the node to a StencilOperation enum and returns true if successful.

template<class Alloc>

void* Ogre::AllocatedObject< Alloc >::operator new | ( | size_t | sz,
|  | const char * | file,
|  | int | line,
|  | const char * | func |
| ) |  |  | `[inherited]`

operator new, with debug line info

Definition at line 62 of file OgreMemoryAllocatedObject.h.

template<class Alloc>

void* Ogre::AllocatedObject< Alloc >::operator new | ( | size_t | sz | ) | `[inherited]`

Definition at line 67 of file OgreMemoryAllocatedObject.h.

template<class Alloc>

void* Ogre::AllocatedObject< Alloc >::operator new | ( | size_t | sz,
|  | void * | ptr |
| ) |  |  | `[inherited]`

placement operator new

Definition at line 73 of file OgreMemoryAllocatedObject.h.

template<class Alloc>

void* Ogre::AllocatedObject< Alloc >::operator new[] | ( | size_t | sz,
|  | const char * | file,
|  | int | line,
|  | const char * | func |
| ) |  |  | `[inherited]`

array operator new, with debug line info

Definition at line 79 of file OgreMemoryAllocatedObject.h.

template<class Alloc>

void* Ogre::AllocatedObject< Alloc >::operator new[] | ( | size_t | sz | ) | `[inherited]`

Definition at line 84 of file OgreMemoryAllocatedObject.h.

template<class Alloc>

void Ogre::AllocatedObject< Alloc >::operator delete | ( | void * | ptr | ) | `[inherited]`

Definition at line 89 of file OgreMemoryAllocatedObject.h.

template<class Alloc>

void Ogre::AllocatedObject< Alloc >::operator delete | ( | void * | ptr,
|  | void * |  |
| ) |  |  | `[inherited]`

Definition at line 95 of file OgreMemoryAllocatedObject.h.

template<class Alloc>

void Ogre::AllocatedObject< Alloc >::operator delete | ( | void * | ptr,
|  | const char * | ,
|  | int | ,
|  | const char * |  |
| ) |  |  | `[inherited]`

Definition at line 101 of file OgreMemoryAllocatedObject.h.

template<class Alloc>

void Ogre::AllocatedObject< Alloc >::operator delete[] | ( | void * | ptr | ) | `[inherited]`

Definition at line 106 of file OgreMemoryAllocatedObject.h.

template<class Alloc>

void Ogre::AllocatedObject< Alloc >::operator delete[] | ( | void * | ptr,
|  | const char * | ,
|  | int | ,
|  | const char * |  |
| ) |  |  | `[inherited]`

Definition at line 112 of file OgreMemoryAllocatedObject.h.

## Member Data Documentation

CompositionPass* Ogre::CompositionPassTranslator::mPass`[protected]`

Definition at line 229 of file OgreScriptTranslator.h.

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

- OgreScriptTranslator.h

Copyright © 2008 Torus Knot Software Ltd
This work is licensed under a Creative Commons Attribution-ShareAlike 2.5 License.
Last modified Sun Jul 26 11:36:50 2009