OpenWalnut
1.4.0
|
This calls serves a simple purpose: have a texture and its scaling information together which allows very easy binding of textures to nodes with associated shaders. More...
#include <WGETexture.h>
Public Types | |
typedef osg::ref_ptr< WGETexture< TextureType > > | RPtr |
Convenience type for OSG reference pointer on WGETextures. More... | |
Public Member Functions | |
WGETexture (double scale=1.0, double min=0.0) | |
Default constructor. More... | |
WGETexture (osg::Image *image, double scale=1.0, double min=0.0) | |
Creates texture from given image. More... | |
WGETexture (const WGETexture< TextureType > &texture, const osg::CopyOp ©op=osg::CopyOp::SHALLOW_COPY) | |
Copy the texture. More... | |
virtual | ~WGETexture () |
Destructor. More... | |
WPropString | name () const |
Returns the name property of the texture. More... | |
WPropInt | sortIndex () const |
The sorting index in the colormapper's texture list. More... | |
WPropDouble | minimum () const |
Get the minimum in the de-scaled value space. More... | |
WPropDouble | scale () const |
Get the scaling factor for de-scaling the texture. More... | |
WPropDouble | alpha () const |
Returns the alpha property. More... | |
WPropBool | clipZero () const |
Clip the values assumed to be zero. More... | |
WPropDouble | thresholdLower () const |
Returns the threshold property. More... | |
WPropDouble | thresholdUpper () const |
Returns the threshold property. More... | |
WPropBool | thresholdEnabled () const |
Returns the property responsible for enabling threshold based clipping. More... | |
WPropBool | interpolation () const |
Returns the interpolation property. More... | |
WPropSelection | colormap () const |
Returns the colormap property. More... | |
WPropBool | active () const |
Returns the active property. More... | |
WPropInterval | window () const |
Returns the window level definition for the colormap. More... | |
WPropBool | windowEnabled () const |
Returns the property responsible for enabling window based interval scaling. More... | |
WPropMatrix4X4 | transformation () const |
Returns the texture transformation matrix. More... | |
void | bind (osg::ref_ptr< osg::Node > node, size_t unit=0) |
Binds the texture to the specified node and texture unit. More... | |
boost::shared_ptr< WProperties > | getProperties () const |
Return a pointer to the properties object of the dataset. More... | |
boost::shared_ptr< WProperties > | getInformationProperties () const |
Return a pointer to the information properties object of the dataset. More... | |
virtual void | applyUniforms (std::string prefix, osg::StateSet *states) const |
Applies some custom uniforms to the specified state-set which directly relate to this texture. More... | |
void | setFilterMinMag (osg::Texture::FilterMode mode) |
For all the lazy guys to set the filter MIN and MAG at once. More... | |
void | setWrapSTR (osg::Texture::WrapMode mode) |
For all the lazy guys to set the wrapping for s,t and r directions at once. More... | |
virtual WBoundingBox | getBoundingBox () const |
Returns the texture's bounding box. More... | |
Static Public Member Functions | |
static WPVBaseTypes::PV_INT | getUnsetSortIndex () |
Get the index used to refer to an unset sort index. More... | |
Static Public Attributes | |
static std::size_t const | MAX_NUMBER_OF_TEXTURES = 8 |
We support only 8 textures because some known hardware does not support more texture coordinates. More... | |
static std::size_t const | MAX_TEXTURE_DIMENSION = 2048 |
The maximum texture dimension. More... | |
Protected Member Functions | |
virtual void | handleUpdate () |
Handles all property updates. More... | |
virtual void | create () |
Creates the texture data. More... | |
virtual void | updateCallback (osg::StateAttribute *state) |
This method implements an update callback which updates the texture image if needed and several other properties like texture matrix. More... | |
Static Protected Member Functions | |
static void | initTextureSize (osg::Texture1D *texture, int width, int height, int depth) |
Initialize the size of the texture properly according to real texture type (1D,2D,3D). More... | |
static void | initTextureSize (osg::Texture2D *texture, int width, int height, int depth) |
Initialize the size of the texture properly according to real texture type (1D,2D,3D). More... | |
static void | initTextureSize (osg::Texture3D *texture, int width, int height, int depth) |
Initialize the size of the texture properly according to real texture type (1D,2D,3D). More... | |
Private Member Functions | |
void | setupProperties (double scale, double min) |
Creates and assigns all properties. More... | |
Private Attributes | |
boost::shared_ptr< WCondition > | m_propCondition |
A condition used to notify about changes in several properties. More... | |
boost::shared_ptr< WProperties > | m_properties |
The property object for the dataset. More... | |
boost::shared_ptr< WProperties > | m_infoProperties |
The property object for the dataset containing only props whose purpose is "PV_PURPOSE_INFORMNATION". More... | |
bool | m_needCreate |
If true, the texture gets created. More... | |
WPropString | m_name |
The texture name. More... | |
WPropInt | m_sortIdx |
The sort index of the texture. More... | |
WPropDouble | m_min |
The minimum of each value in the texture in unscaled space. More... | |
WPropDouble | m_scale |
The scaling factor to de-scale a [0-1] texture to original space. More... | |
boost::shared_ptr< WItemSelection > | m_colorMapSelectionsList |
A list of color map selection types. More... | |
WPropSelection | m_colorMap |
Selection property for color map. More... | |
WPropDouble | m_alpha |
Alpha blending value. More... | |
WPropBool | m_clipZero |
If set to true, zero values are clipped by making them transparent. More... | |
WPropDouble | m_thresholdLower |
Threshold for clipping areas. More... | |
WPropDouble | m_thresholdUpper |
Threshold for clipping areas. More... | |
WPropBool | m_thresholdEnabled |
Threshold-enable flag. More... | |
WPropBool | m_interpolation |
True if interpolation should be used. More... | |
WPropBool | m_active |
True if the texture is active. More... | |
WPropMatrix4X4 | m_texMatrix |
The texture transformation matrix. More... | |
WPropInterval | m_window |
Window level setting for the current colormap. More... | |
WPropBool | m_windowEnabled |
Window-Level-Setting-enable flag. More... | |
This calls serves a simple purpose: have a texture and its scaling information together which allows very easy binding of textures to nodes with associated shaders.
When this texture gets bind using the bindTo methods, uniforms get added containing needed scaling information.
Definition at line 55 of file WGETexture.h.
typedef osg::ref_ptr< WGETexture< TextureType > > WGETexture< TextureType >::RPtr |
Convenience type for OSG reference pointer on WGETextures.
Definition at line 61 of file WGETexture.h.
WGETexture< TextureType >::WGETexture | ( | double | scale = 1.0 , |
double | min = 0.0 |
||
) |
Default constructor.
Creates an empty instance of the texture.
scale | the scaling factor needed for de-scaling the texture values |
min | the minimum value allowing negative values too. |
Definition at line 450 of file WGETexture.h.
References WGETexture< TextureType >::setupProperties().
WGETexture< TextureType >::WGETexture | ( | osg::Image * | image, |
double | scale = 1.0 , |
||
double | min = 0.0 |
||
) |
Creates texture from given image.
Scaling is set to identity.
image | the image to use as texture |
scale | the scaling factor needed for de-scaling the texture values |
min | the minimum value allowing negative values too. |
Definition at line 461 of file WGETexture.h.
References WGETexture< TextureType >::initTextureSize(), and WGETexture< TextureType >::setupProperties().
WGETexture< TextureType >::WGETexture | ( | const WGETexture< TextureType > & | texture, |
const osg::CopyOp & | copyop = osg::CopyOp::SHALLOW_COPY |
||
) |
Copy the texture.
texture | the texture to copy |
copyop |
Definition at line 473 of file WGETexture.h.
|
virtual |
Destructor.
Definition at line 555 of file WGETexture.h.
|
inline |
Returns the active property.
The property can be changed. A change affects all colormaps using this texture.
Definition at line 639 of file WGETexture.h.
|
inline |
Returns the alpha property.
The property can be changed. A change affects all colormaps using this texture.
Definition at line 597 of file WGETexture.h.
|
virtual |
Applies some custom uniforms to the specified state-set which directly relate to this texture.
prefix | the prefix used for the uniforms |
states | the state where to add the uniforms |
Definition at line 673 of file WGETexture.h.
void WGETexture< TextureType >::bind | ( | osg::ref_ptr< osg::Node > | node, |
size_t | unit = 0 |
||
) |
Binds the texture to the specified node and texture unit.
It also adds two uniforms: u_textureXMin and u_textureXScale, where X is the unit number. This can be used in shaders to unscale it.
node | the node where to bind the texture to |
unit | the unit, by default 0 |
Definition at line 689 of file WGETexture.h.
References wge::bindTexture().
|
inline |
Clip the values assumed to be zero.
Definition at line 603 of file WGETexture.h.
|
inline |
Returns the colormap property.
The property can be changed. A change affects all colormaps using this texture.
Definition at line 633 of file WGETexture.h.
|
protectedvirtual |
Creates the texture data.
Overwrite this method if you want to provide a custom texture creation procedure.
Reimplemented in WDataTexture3D.
Definition at line 696 of file WGETexture.h.
|
virtual |
Returns the texture's bounding box.
This is const. Although there exists the transformation() property, it is an information property and can't be changed.
Reimplemented in WDataTexture3D.
Definition at line 747 of file WGETexture.h.
boost::shared_ptr< WProperties > WGETexture< TextureType >::getInformationProperties | ( | ) | const |
Return a pointer to the information properties object of the dataset.
The dataset intends these properties to not be modified.
Definition at line 567 of file WGETexture.h.
boost::shared_ptr< WProperties > WGETexture< TextureType >::getProperties | ( | ) | const |
Return a pointer to the properties object of the dataset.
Add all the modifiable settings here. This allows the user to modify several properties of a dataset.
Definition at line 561 of file WGETexture.h.
|
static |
Get the index used to refer to an unset sort index.
Definition at line 753 of file WGETexture.h.
Referenced by WGEColormapping::resetSortIndices().
|
protectedvirtual |
Handles all property updates.
Called by m_propCondition.
Definition at line 663 of file WGETexture.h.
|
staticprotected |
Initialize the size of the texture properly according to real texture type (1D,2D,3D).
texture | the texture where to set the size |
width | the new width |
height | the new height |
depth | the new depth |
Definition at line 729 of file WGETexture.h.
Referenced by WDataTexture3D::WDataTexture3D(), and WGETexture< TextureType >::WGETexture().
|
staticprotected |
Initialize the size of the texture properly according to real texture type (1D,2D,3D).
texture | the texture where to set the size |
width | the new width |
height | the new height |
depth | the new depth |
Definition at line 735 of file WGETexture.h.
|
staticprotected |
Initialize the size of the texture properly according to real texture type (1D,2D,3D).
texture | the texture where to set the size |
width | the new width |
height | the new height |
depth | the new depth |
Definition at line 741 of file WGETexture.h.
|
inline |
Returns the interpolation property.
The property can be changed. A change affects all colormaps using this texture.
Definition at line 627 of file WGETexture.h.
|
inline |
Get the minimum in the de-scaled value space.
The property can be changed. A change affects all colormaps using this texture. But be careful as the texture creating depends on these values.
Definition at line 585 of file WGETexture.h.
Referenced by WDataTexture3D::createTexture().
|
inline |
Returns the name property of the texture.
You should set it if you create a texture.
Definition at line 573 of file WGETexture.h.
|
inline |
Get the scaling factor for de-scaling the texture.
The property can be changed. A change affects all colormaps using this texture. But be careful as the texture creating depends on these values.
Definition at line 591 of file WGETexture.h.
Referenced by WDataTexture3D::createTexture(), and WDataTexture3D::WDataTexture3D().
void WGETexture< TextureType >::setFilterMinMag | ( | osg::Texture::FilterMode | mode | ) |
For all the lazy guys to set the filter MIN and MAG at once.
mode | the new mode for MIN_FILTER and MAG_FILTER. |
Definition at line 714 of file WGETexture.h.
|
private |
Creates and assigns all properties.
min | the min value of the texture |
scale | the scale value of the texture |
Definition at line 482 of file WGETexture.h.
References WPropertyHelper::PC_SELECTONLYONE::addTo(), and WMatrixFixed< double, 4, 4 >::identity().
Referenced by WGETexture< TextureType >::WGETexture().
void WGETexture< TextureType >::setWrapSTR | ( | osg::Texture::WrapMode | mode | ) |
For all the lazy guys to set the wrapping for s,t and r directions at once.
mode | the new mode for WRAP_S, WRAP_T and WRAP_R. |
Definition at line 721 of file WGETexture.h.
|
inline |
The sorting index in the colormapper's texture list.
Definition at line 579 of file WGETexture.h.
|
inline |
Returns the property responsible for enabling threshold based clipping.
If this is false, the threshold is ignored.
Definition at line 621 of file WGETexture.h.
|
inline |
Returns the threshold property.
The property can be changed. A change affects all colormaps using this texture.
Definition at line 609 of file WGETexture.h.
Referenced by WDataTexture3D::WDataTexture3D().
|
inline |
Returns the threshold property.
The property can be changed. A change affects all colormaps using this texture.
Definition at line 615 of file WGETexture.h.
Referenced by WDataTexture3D::WDataTexture3D().
|
inline |
Returns the texture transformation matrix.
The property can be changed. A change affects all colormaps using this texture. This matrix converts an world-space coordinate to an texture coordinate! This can be seen as a scaled inverse matrix of the grid's transformation.
Definition at line 657 of file WGETexture.h.
Referenced by WDataTexture3D::WDataTexture3D().
|
protectedvirtual |
This method implements an update callback which updates the texture image if needed and several other properties like texture matrix.
state | the state to update |
Definition at line 702 of file WGETexture.h.
|
inline |
Returns the window level definition for the colormap.
The property can be changed. A change affects all colormaps using this texture.
Definition at line 651 of file WGETexture.h.
Referenced by WDataTexture3D::WDataTexture3D().
|
inline |
Returns the property responsible for enabling window based interval scaling.
If this is false, the window setting is ignored.
Definition at line 645 of file WGETexture.h.
|
private |
True if the texture is active.
Definition at line 413 of file WGETexture.h.
|
private |
Alpha blending value.
Definition at line 383 of file WGETexture.h.
|
private |
If set to true, zero values are clipped by making them transparent.
Definition at line 388 of file WGETexture.h.
|
private |
Selection property for color map.
Definition at line 378 of file WGETexture.h.
|
private |
A list of color map selection types.
Definition at line 373 of file WGETexture.h.
|
private |
The property object for the dataset containing only props whose purpose is "PV_PURPOSE_INFORMNATION".
It is useful to define some property to only be of informational nature. The GUI does not modify them. As it is a WProperties instance, you can use it the same way as m_properties.
Definition at line 343 of file WGETexture.h.
|
private |
True if interpolation should be used.
Definition at line 408 of file WGETexture.h.
|
private |
The minimum of each value in the texture in unscaled space.
Definition at line 363 of file WGETexture.h.
|
private |
The texture name.
This might be useful to identify textures.
Definition at line 353 of file WGETexture.h.
|
private |
If true, the texture gets created.
This is used to create texture on demand.
Definition at line 348 of file WGETexture.h.
|
private |
A condition used to notify about changes in several properties.
Definition at line 331 of file WGETexture.h.
|
private |
The property object for the dataset.
Definition at line 336 of file WGETexture.h.
|
private |
The scaling factor to de-scale a [0-1] texture to original space.
Definition at line 368 of file WGETexture.h.
|
private |
The sort index of the texture.
This is important for restoring and saving the colormapper's sorting.
Definition at line 358 of file WGETexture.h.
|
private |
The texture transformation matrix.
Definition at line 418 of file WGETexture.h.
|
private |
Threshold-enable flag.
Definition at line 403 of file WGETexture.h.
|
private |
Threshold for clipping areas.
Definition at line 393 of file WGETexture.h.
|
private |
Threshold for clipping areas.
Definition at line 398 of file WGETexture.h.
|
private |
Window level setting for the current colormap.
Definition at line 423 of file WGETexture.h.
|
private |
Window-Level-Setting-enable flag.
Definition at line 428 of file WGETexture.h.
|
static |
We support only 8 textures because some known hardware does not support more texture coordinates.
Definition at line 64 of file WGETexture.h.
|
static |
The maximum texture dimension.
Definition at line 67 of file WGETexture.h.