Main Page | Namespace List | Class Hierarchy | Alphabetical List | Class List | Directories | File List | Namespace Members | Class Members | File Members | Related Pages

Ogre::CompositorPtr Class Reference

Specialisation of SharedPtr to allow SharedPtr to be assigned to CompositorPtr. More...

#include <OgreCompositor.h>

Inheritance diagram for Ogre::CompositorPtr:

Ogre::SharedPtr< Compositor > List of all members.

Public Member Functions

 CompositorPtr ()
 CompositorPtr (Compositor *rep)
 CompositorPtr (const CompositorPtr &r)
 CompositorPtr (const ResourcePtr &r)
CompositorPtr & operator= (const ResourcePtr &r)
 Operator used to convert a ResourcePtr to a CompositorPtr.
OGRE_AUTO_SHARED_MUTEX SharedPtr ()
 Constructor, does not initialise the SharedPtr.
 SharedPtr (Compositor *rep)
 SharedPtr (const SharedPtr &r)
Compositor & operator * () const
Compositor * operator-> () const
Compositor * get () const
void bind (Compositor *rep)
 Binds rep to the SharedPtr.
bool unique () const
unsigned int useCount () const
unsigned int * useCountPointer () const
Compositor * getPointer () const
bool isNull (void) const
void setNull (void)

Protected Member Functions

void release (void)
virtual void destroy (void)

Protected Attributes

Compositor * pRep
unsigned int * pUseCount

Detailed Description

Specialisation of SharedPtr to allow SharedPtr to be assigned to CompositorPtr.

Note:
Has to be a subclass since we need operator=. We could templatise this instead of repeating per Resource subclass, except to do so requires a form VC6 does not support i.e. ResourceSubclassPtr<T> : public SharedPtr<T>

Definition at line 124 of file OgreCompositor.h.


Constructor & Destructor Documentation

Ogre::CompositorPtr::CompositorPtr (   ) 
 

Definition at line 127 of file OgreCompositor.h.

Ogre::CompositorPtr::CompositorPtr (  Compositor *  rep  )  [explicit]
 

Definition at line 128 of file OgreCompositor.h.

Ogre::CompositorPtr::CompositorPtr (  const CompositorPtr &  r  ) 
 

Definition at line 129 of file OgreCompositor.h.

Ogre::CompositorPtr::CompositorPtr (  const ResourcePtr &  r  ) 
 

Definition at line 130 of file OgreCompositor.h.

References Ogre::SharedPtr< T >::getPointer(), OGRE_COPY_AUTO_SHARED_MUTEX, OGRE_LOCK_MUTEX, OGRE_MUTEX_CONDITIONAL, and Ogre::SharedPtr< T >::useCountPointer().


Member Function Documentation

void Ogre::SharedPtr< Compositor >::bind (  Compositor *  rep  )  [inherited]
 

Binds rep to the SharedPtr.

Remarks:
Assumes that the SharedPtr is uninitialised!

Definition at line 114 of file OgreSharedPtr.h.

virtual void Ogre::SharedPtr< Compositor >::destroy (  void   )  [protected, virtual, inherited]
 

Definition at line 168 of file OgreSharedPtr.h.

Compositor * Ogre::SharedPtr< Compositor >::get (   )  const [inherited]
 

Definition at line 108 of file OgreSharedPtr.h.

Compositor * Ogre::SharedPtr< Compositor >::getPointer (   )  const [inherited]
 

Definition at line 126 of file OgreSharedPtr.h.

bool Ogre::SharedPtr< Compositor >::isNull (  void   )  const [inherited]
 

Definition at line 128 of file OgreSharedPtr.h.

Compositor & Ogre::SharedPtr< Compositor >::operator * (   )  const [inherited]
 

Definition at line 106 of file OgreSharedPtr.h.

Compositor * Ogre::SharedPtr< Compositor >::operator-> (   )  const [inherited]
 

Definition at line 107 of file OgreSharedPtr.h.

CompositorPtr& Ogre::CompositorPtr::operator= (  const ResourcePtr &  r  ) 
 

Operator used to convert a ResourcePtr to a CompositorPtr.

Definition at line 147 of file OgreCompositor.h.

References OGRE_COPY_AUTO_SHARED_MUTEX, OGRE_LOCK_MUTEX, and OGRE_MUTEX_CONDITIONAL.

void Ogre::SharedPtr< Compositor >::release (  void   )  [protected, inherited]
 

Definition at line 142 of file OgreSharedPtr.h.

void Ogre::SharedPtr< Compositor >::setNull (  void   )  [inherited]
 

Definition at line 130 of file OgreSharedPtr.h.

Ogre::SharedPtr< Compositor >::SharedPtr (  const SharedPtr< Compositor > &  r  )  [inherited]
 

Definition at line 64 of file OgreSharedPtr.h.

Ogre::SharedPtr< Compositor >::SharedPtr (  Compositor *  rep  )  [explicit, inherited]
 

Definition at line 59 of file OgreSharedPtr.h.

OGRE_AUTO_SHARED_MUTEX Ogre::SharedPtr< Compositor >::SharedPtr (   )  [inherited]
 

Constructor, does not initialise the SharedPtr.

Remarks:
Dangerous! You have to call bind() before using the SharedPtr.

Definition at line 54 of file OgreSharedPtr.h.

bool Ogre::SharedPtr< Compositor >::unique (   )  const [inherited]
 

Definition at line 122 of file OgreSharedPtr.h.

unsigned int Ogre::SharedPtr< Compositor >::useCount (   )  const [inherited]
 

Definition at line 123 of file OgreSharedPtr.h.

unsigned int* Ogre::SharedPtr< Compositor >::useCountPointer (   )  const [inherited]
 

Definition at line 124 of file OgreSharedPtr.h.


Member Data Documentation

Compositor * Ogre::SharedPtr< Compositor >::pRep [protected, inherited]
 

Definition at line 46 of file OgreSharedPtr.h.

unsigned int* Ogre::SharedPtr< Compositor >::pUseCount [protected, inherited]
 

Definition at line 47 of file OgreSharedPtr.h.


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

Copyright © 2000-2005 by The OGRE Team
Creative Commons License
This work is licensed under a Creative Commons Attribution-ShareAlike 2.5 License.
Last modified Sun Jan 21 10:01:59 2007