From 0ea5fc66924303d1bf73ba283a383e2aadee02f2 Mon Sep 17 00:00:00 2001 From: neodarz Date: Sat, 11 Aug 2018 20:21:34 +0200 Subject: Initial commit --- docs/doxygen/nel/classNL3D_1_1CWaveMakerShape.html | 1064 ++++++++++++++++++++ 1 file changed, 1064 insertions(+) create mode 100644 docs/doxygen/nel/classNL3D_1_1CWaveMakerShape.html (limited to 'docs/doxygen/nel/classNL3D_1_1CWaveMakerShape.html') diff --git a/docs/doxygen/nel/classNL3D_1_1CWaveMakerShape.html b/docs/doxygen/nel/classNL3D_1_1CWaveMakerShape.html new file mode 100644 index 00000000..48b5badd --- /dev/null +++ b/docs/doxygen/nel/classNL3D_1_1CWaveMakerShape.html @@ -0,0 +1,1064 @@ + + + + nevrax.org : docs + + + + + + + + + + + + + + +

Home

nevrax.com

+ + + + +

+ + + + + + + + + + +

+ + +

+ Nevrax.org

+ + + + + + + +

	News
	Mailing-list
	Documentation
	CVS
	Bugs
	License

+ + +

+ + + + + + +

Documentation

+ + +Main Page Namespace List Class Hierarchy Alphabetical List Compound List File List Namespace Members Compound Members File Members Related Pages Search +

NL3D::CWaveMakerShape Class Reference

A wave maker. It can generate waves where it is located. +More... +

+#include <water_shape.h> +

Inheritance diagram for NL3D::CWaveMakerShape: +

+ + + + + + +List of all members. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Public Methods
	NLMISC_DECLARE_CLASS (CWaveMakerShape)
virtual CTransformShape *	createInstance (CScene &scene)
	inherited from IShape. More...
virtual bool	clip (const std::vector< CPlane > &pyramid, const CMatrix &worldMatrix)
	inherited from IShape. More...
virtual void	render (IDriver drv, CTransformShape trans, bool opaquePass)
	inherited from IShape. Does nothing. A new observer was set for that. More...
virtual void	getAABBox (NLMISC::CAABBox &bbox) const
	inherited from IShape. More...
virtual float	getNumTriangles (float distance)
	inherited from ishape. More...
virtual void	flushTextures (IDriver &driver)
	inherited from ishape. More...
void	setPeriod (TAnimationTime period)
	set the period for this wave maker. More...
TAnimationTime	getPeriod () const
void	setIntensity (float intensity)
	set the intensity of the waves. More...
float	getIntensity () const
void	setRadius (float radius)
	radius of the impulsion. More...
float	getRadius () const
void	setWaterPoolID (uint32 id)
	set the water pool that's being modified. More...
uint32	getWaterPoolID () const
void	setImpulsionMode (bool on=true)
	use a periodic impulsion rather than a sinus. More...
bool	getImpulsionMode () const
CTrackDefaultVector *	getDefaultPos ()
Object
	CWaveMakerShape ()
	ctor. More...
	~CWaveMakerShape ()
	dtor. More...
void	serial (NLMISC::IStream &f) throw (NLMISC::EStream)
	serial this shape. More...
Private Attributes
TAnimationTime	_Period
float	_Radius
uint32	_PoolID
float	_Intensity
bool	_ImpulsionMode
CTrackDefaultVector	_DefaultPos
Friends
class	CWaveMakerDetailObs

Detailed Description

+A wave maker. It can generate waves where it is located. +

+ +

+Definition at line 251 of file water_shape.h.

Constructor & Destructor Documentation

+ + + + +
+ + + + + + + + + +
NL3D::CWaveMakerShape::CWaveMakerShape ( )
+
+ + + + + +
+ + + +
+ctor. +
+ +
+Definition at line 646 of file water_shape.cpp.
+

+ + + + +
+ + + + + + + + + +
NL3D::CWaveMakerShape::~CWaveMakerShape ( )
+
+ + + + + +
+ + + +
+dtor. +
+ +
+Definition at line 656 of file water_shape.cpp.
+

Member Function Documentation

+ + + + +
+ + + + + + + + + + + + + + + + + + + +
bool NL3D::CWaveMakerShape::clip ( const std::vector< CPlane > & pyramid,
const CMatrix & worldMatrix
) [virtual]
+
+ + + + + +
+ + + +
+inherited from IShape. +
+ +
+Reimplemented from NL3D::IShape. +
+Definition at line 682 of file water_shape.cpp. +
+References _PoolID, and NL3D::GetWaterPoolManager.
+

+ + + + +
+ + + + + + + + + + +
CTransformShape * NL3D::CWaveMakerShape::createInstance ( CScene & scene ) [virtual]
+
+ + + + + +
+ + + +
+inherited from IShape. +
+ +
+Reimplemented from NL3D::IShape. +
+Definition at line 670 of file water_shape.cpp. +
+References _DefaultPos, NL3D::CAnimatedValueVector, and NL3D::WaveMakerModelClassId.
+

+ + + + +
+ + + + + + + + + + +
virtual void NL3D::CWaveMakerShape::flushTextures ( IDriver & driver ) [inline, virtual]
+
+ + + + + +
+ + + +
+inherited from ishape. +
+ +
+Implements NL3D::IShape. +
+Definition at line 285 of file water_shape.h.
+

+ + + + +
+ + + + + + + + + + +
void NL3D::CWaveMakerShape::getAABBox ( NLMISC::CAABBox & bbox ) const [virtual]
+
+ + + + + +
+ + + +
+inherited from IShape. +
+ +
+Reimplemented from NL3D::IShape. +
+Definition at line 697 of file water_shape.cpp. +
+References NLMISC::CVector::Null, NLMISC::CAABBox::setCenter, and NLMISC::CAABBox::setHalfSize.
+

+ + + + +
+ + + + + + + + + +
CTrackDefaultVector* NL3D::CWaveMakerShape::getDefaultPos ( ) [inline]
+
+ + + + + +
+ + + +
+ +
+Definition at line 308 of file water_shape.h. +
+References _DefaultPos.
+

+ + + + +
+ + + + + + + + + +
bool NL3D::CWaveMakerShape::getImpulsionMode ( ) const [inline]
+
+ + + + + +
+ + + +
+ +
+Definition at line 306 of file water_shape.h. +
+References _ImpulsionMode.
+

+ + + + +
+ + + + + + + + + + +
float NL3D::CWaveMakerShape::getIntensity ( void ) const [inline]
+
+ + + + + +
+ + + +
+ +
+Definition at line 294 of file water_shape.h. +
+References _Intensity.
+

+ + + + +
+ + + + + + + + + + +
virtual float NL3D::CWaveMakerShape::getNumTriangles ( float distance ) [inline, virtual]
+
+ + + + + +
+ + + +
+inherited from ishape. +
+ +
+Implements NL3D::IShape. +
+Definition at line 282 of file water_shape.h.
+

+ + + + +
+ + + + + + + + + + +
TAnimationTime NL3D::CWaveMakerShape::getPeriod ( void ) const [inline]
+
+ + + + + +
+ + + +
+ +
+Definition at line 290 of file water_shape.h. +
+References _Period, and NL3D::TAnimationTime.
+

+ + + + +
+ + + + + + + + + + +
float NL3D::CWaveMakerShape::getRadius ( void ) const [inline]
+
+ + + + + +
+ + + +
+ +
+Definition at line 298 of file water_shape.h. +
+References _Radius.
+

+ + + + +
+ + + + + + + + + +
uint32 NL3D::CWaveMakerShape::getWaterPoolID ( ) const [inline]
+
+ + + + + +
+ + + +
+ +
+Definition at line 302 of file water_shape.h. +
+References _PoolID.
+

+ + + + +
+ + + + + + + + + + +
NL3D::CWaveMakerShape::NLMISC_DECLARE_CLASS ( CWaveMakerShape )
+
+ + + + + +
+ + + +
+
+

+ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + +
virtual void NL3D::CWaveMakerShape::render ( IDriver * drv,
CTransformShape * trans,
bool opaquePass
) [inline, virtual]
+
+ + + + + +
+ + + +
+inherited from IShape. Does nothing. A new observer was set for that. +
+ +
+Implements NL3D::IShape. +
+Definition at line 276 of file water_shape.h.
+

+ + + + +
+ + + + + + + + + + +
void NL3D::CWaveMakerShape::serial ( NLMISC::IStream & f ) throw (NLMISC::EStream) [virtual]
+
+ + + + + +
+ + + +
+serial this shape. +
+ +
+Implements NLMISC::IStreamable. +
+Definition at line 662 of file water_shape.cpp.
+

+ + + + +
+ + + + + + + + + + +
void NL3D::CWaveMakerShape::setImpulsionMode ( bool on = true ) [inline]
+
+ + + + + +
+ + + +
+use a periodic impulsion rather than a sinus. +
+ +
+Definition at line 305 of file water_shape.h. +
+References _ImpulsionMode.
+

+ + + + +
+ + + + + + + + + + +
void NL3D::CWaveMakerShape::setIntensity ( float intensity ) [inline]
+
+ + + + + +
+ + + +
+set the intensity of the waves. +
+ +
+Definition at line 293 of file water_shape.h. +
+References _Intensity.
+

+ + + + +
+ + + + + + + + + + +
void NL3D::CWaveMakerShape::setPeriod ( TAnimationTime period ) [inline]
+
+ + + + + +
+ + + +
+set the period for this wave maker. +
+ +
+Definition at line 289 of file water_shape.h. +
+References _Period, and NL3D::TAnimationTime.
+

+ + + + +
+ + + + + + + + + + +
void NL3D::CWaveMakerShape::setRadius ( float radius ) [inline]
+
+ + + + + +
+ + + +
+radius of the impulsion. +
+ +
+Definition at line 297 of file water_shape.h. +
+References _Radius.
+

+ + + + +
+ + + + + + + + + + +
void NL3D::CWaveMakerShape::setWaterPoolID ( uint32 id ) [inline]
+
+ + + + + +
+ + + +
+set the water pool that's being modified. +
+ +
+Definition at line 301 of file water_shape.h. +
+References _PoolID, and id.
+

Friends And Related Function Documentation

+ + + + +
+ + +
friend class CWaveMakerDetailObs [friend] +
+
+ + + + + +
+ + + +
+ +
+Definition at line 310 of file water_shape.h.
+

Member Data Documentation

+ + + + +
+ + +
CTrackDefaultVector NL3D::CWaveMakerShape::_DefaultPos [private] +
+
+ + + + + +
+ + + +
+ +
+Definition at line 316 of file water_shape.h. +
+Referenced by createInstance, and getDefaultPos.
+

+ + + + +
+ + +
bool NL3D::CWaveMakerShape::_ImpulsionMode [private] +
+
+ + + + + +
+ + + +
+ +
+Definition at line 315 of file water_shape.h. +
+Referenced by getImpulsionMode, and setImpulsionMode.
+

+ + + + +
+ + +
float NL3D::CWaveMakerShape::_Intensity [private] +
+
+ + + + + +
+ + + +
+ +
+Definition at line 314 of file water_shape.h. +
+Referenced by getIntensity, and setIntensity.
+

+ + + + +
+ + +
TAnimationTime NL3D::CWaveMakerShape::_Period [private] +
+
+ + + + + +
+ + + +
+ +
+Definition at line 311 of file water_shape.h. +
+Referenced by getPeriod, and setPeriod.
+

+ + + + +
+ + +
uint32 NL3D::CWaveMakerShape::_PoolID [private] +
+
+ + + + + +
+ + + +
+ +
+Definition at line 313 of file water_shape.h. +
+Referenced by clip, getWaterPoolID, and setWaterPoolID.
+

+ + + + +
+ + +
float NL3D::CWaveMakerShape::_Radius [private] +
+
+ + + + + +
+ + + +
+ +
+Definition at line 312 of file water_shape.h. +
+Referenced by getRadius, and setRadius.
+

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

+ + + +
+

+ + -- cgit v1.2.1

NL3D::CWaveMakerShape Class Reference

Public Methods

Private Attributes

Friends

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Friends And Related Function Documentation

Member Data Documentation