This reference page is linked to from the following overview topics: Nitrous Graphics SDK Extensions, About RenderItem.
#include <RenderItemHandleDecorator.h>
This is a decorator class for RenderItemHandle.
RenderItemHandleDecorator is mainly used when we want to create an additional instance of an existing RenderItemHandle, namely a decorator. The decorator will share the same render geometry of the original render item but it will have some different visual appearance. For e.g, it would have different material assigned, different world position or visibility group, etc. In such cases, there's no need to completely copy the original render item of which we can simply create a decorator. And we can specify the different visual appearance/behavior for the decorator.
Public Member Functions |
|
GraphicsDriverAPI | RenderItemHandleDecorator () |
GraphicsDriverAPI | RenderItemHandleDecorator (const RenderItemHandleDecorator &from) |
GraphicsDriverAPI RenderItemHandleDecorator & |
operator= (const RenderItemHandleDecorator &from) |
virtual GraphicsDriverAPI | ~RenderItemHandleDecorator () |
GraphicsDriverAPI bool | Initialize (const RenderItemHandle &itemToDecorate) |
Initialize the decorator. |
|
GraphicsDriverAPI RenderItemHandle | GetDecoratedRenderItem () const |
Get the decorated render item. |
|
GraphicsDriverAPI void | SetOffsetMatrix (const Matrix44 &offsetMatrix) |
Set the offset matrix for the decorator.
|
|
GraphicsDriverAPI bool | GetOffsetMatrix (Matrix44 &offsetMatrix) const |
Get the offset matrix. |
|
GraphicsDriverAPI void | SetAbsoluteMatrix (const Matrix44 &absoluteMatrix) |
Set the absolute matrix for the decorator.
|
|
GraphicsDriverAPI bool | GetAbsoluteMatrix (Matrix44 &absoluteMatrix) const |
Get the absolute matrix. |
GraphicsDriverAPI RenderItemHandleDecorator | ( | ) |
GraphicsDriverAPI RenderItemHandleDecorator | ( | const RenderItemHandleDecorator & | from | ) |
virtual GraphicsDriverAPI ~RenderItemHandleDecorator | ( | ) | [virtual] |
GraphicsDriverAPI RenderItemHandleDecorator& operator= | ( | const RenderItemHandleDecorator & | from | ) |
GraphicsDriverAPI bool Initialize | ( | const RenderItemHandle & | itemToDecorate | ) |
Initialize the decorator.
itemToDecorate | the original render item to be decorated. |
GraphicsDriverAPI RenderItemHandle GetDecoratedRenderItem | ( | ) | const |
Get the decorated render item.
the | original render item to be decorated. |
GraphicsDriverAPI void SetOffsetMatrix | ( | const Matrix44 & | offsetMatrix | ) |
Set the offset matrix for the decorator.
The world position of this decorator would be an offset from the world position of the node owning it.
the | offset matrix |
GraphicsDriverAPI bool GetOffsetMatrix | ( | Matrix44 & | offsetMatrix | ) | const |
Get the offset matrix.
[out] | offsetMatrix | use this parameter to get the offset matrix |
GraphicsDriverAPI void SetAbsoluteMatrix | ( | const Matrix44 & | absoluteMatrix | ) |
Set the absolute matrix for the decorator.
The world position of this decorator would be directly determined by absoluteMatrix.
the | absoluteMatrix matrix |
GraphicsDriverAPI bool GetAbsoluteMatrix | ( | Matrix44 & | absoluteMatrix | ) | const |
Get the absolute matrix.
[out] | absoluteMatrix | use this parameter to get the absolute matrix |