OMK::Vis::MaterialSetTransparency Class Reference

Action to change this instance transparency. More...

#include <OMKEntityMaterialAction.h>

Inheritance diagram for OMK::Vis::MaterialSetTransparency:

[legend]Collaboration diagram for OMK::Vis::MaterialSetTransparency:

[legend]List of all members.

Public Member Functions
	MaterialSetTransparency (Ogre::Real transparency)
	The contructor stores the argument.
virtual	~MaterialSetTransparency ()
	Destructor.
Protected Attributes
Ogre::Real	_transparency
	The argument.
Private Member Functions
virtual bool	entityAction (EntityMaterial *entity) const
	The action update the entity.
virtual void	passAction (SubEntityMaterial *subEntity, Ogre::Pass *passDest, Ogre::Pass *passSrc) const
	The action for each pass of each technique.

---

Detailed Description

Action to change this instance transparency.

Parameters:

transparency

The new transparency. Values will be clamped to [0.0f..1.0f].

Note:

This changes transparency. A value of 0 means full opacity, while 1 means full transparency (invisible)

If transparency equals 0, it will use the original material instead of the copy (the copy is mandatory transparent, and thus might be slower than the original).

Definition at line 73 of file OMKEntityMaterialAction.h.

---

Constructor & Destructor Documentation

MaterialSetTransparency::MaterialSetTransparency

(

Ogre::Real

transparency

)

The contructor stores the argument.

Definition at line 46 of file OMKEntityMaterialAction.cpp.

: IMaterialPassAction(), 
_transparency( transparency < 0.0f ? 0.0 : ( 1.0f < transparency ? 1.0f : transparency ) ) 
{
}

virtual OMK::Vis::MaterialSetTransparency::~MaterialSetTransparency

(

)

[inline, virtual]

Destructor.

Definition at line 79 of file OMKEntityMaterialAction.h.

{}

---

Member Function Documentation

bool MaterialSetTransparency::entityAction

(

EntityMaterial *

entity

)

const [private, virtual]

The action update the entity.

Reimplemented from OMK::Vis::IMaterialAction.

Definition at line 52 of file OMKEntityMaterialAction.cpp.

References _transparency, and OMK::Vis::EntityMaterial::getOgreEntity().

{
  entity->getOgreEntity()->setVisible( 1.0f != _transparency ) ;
  return true ;
}

virtual void OMK::Vis::MaterialSetTransparency::passAction	(	SubEntityMaterial *	subEntity,
		Ogre::Pass *	passDest,
		Ogre::Pass *	passSrc
	)			const [private, virtual]

The action for each pass of each technique.

Implements OMK::Vis::IMaterialPassAction.

---

Member Data Documentation

Ogre::Real OMK::Vis::MaterialSetTransparency::_transparency [protected]

The argument.

It is given to the function.

Definition at line 83 of file OMKEntityMaterialAction.h.

Referenced by entityAction().

---