PxObservable Class Reference
[Physics]
Observable interface for classes which can send out state change notifications.
More...
#include <PxObserver.h>
Inheritance diagram for PxObservable:
Public Member Functions | |
| virtual PxObservableType::Enum | getObservableType () const =0 |
| Return the type of the observable object. | |
| virtual void | registerObserver (PxObserver &observer)=0 |
| Register an observer. | |
| virtual void | unregisterObserver (PxObserver &observer)=0 |
| Unregister an observer. | |
| virtual PxU32 | getNbObservers () const =0 |
| Return the number of registered observers. | |
| virtual PxU32 | getObservers (PxObserver **userBuffer, PxU32 bufferSize) const =0 |
| Retrieve an array of all the registered observers. | |
Protected Member Functions | |
| virtual | ~PxObservable () |
Detailed Description
Observable interface for classes which can send out state change notifications.
- See also:
- PxObserver
Constructor & Destructor Documentation
| virtual PxObservable::~PxObservable | ( | ) | [inline, protected, virtual] |
Member Function Documentation
| virtual PxU32 PxObservable::getNbObservers | ( | ) | const [pure virtual] |
Return the number of registered observers.
- Returns:
- Number of registered observers
- See also:
- getObservers() PxObserver
| virtual PxObservableType::Enum PxObservable::getObservableType | ( | ) | const [pure virtual] |
Return the type of the observable object.
- Returns:
- Type of observable object
- See also:
- PxObservableType
| virtual PxU32 PxObservable::getObservers | ( | PxObserver ** | userBuffer, | |
| PxU32 | bufferSize | |||
| ) | const [pure virtual] |
Retrieve an array of all the registered observers.
- Parameters:
-
[out] userBuffer The buffer to receive observer pointers. [in] bufferSize Size of provided user buffer.
- Returns:
- Number of observers written to the buffer.
- See also:
- getNbObservers() PxObserver
| virtual void PxObservable::registerObserver | ( | PxObserver & | observer | ) | [pure virtual] |
Register an observer.
- Parameters:
-
[in] observer Observer object to send notifications to
- See also:
- PxObserver
| virtual void PxObservable::unregisterObserver | ( | PxObserver & | observer | ) | [pure virtual] |
Unregister an observer.
- Parameters:
-
[in] observer Observer object to send notifications to
- See also:
- PxObserver
The documentation for this class was generated from the following file:
Copyright © 2008-2012 NVIDIA Corporation, 2701 San Tomas Expressway, Santa Clara, CA 95050 U.S.A. All rights reserved. www.nvidia.com