BoxCropEffect Class Reference

#include <effect.h>

Inheritance diagram for BoxCropEffect:

Collaboration diagram for BoxCropEffect:

Public Member Functions
	BoxCropEffect ()
virtual	~BoxCropEffect ()
Effect *	clone () const
void	enable (unsigned int pass) const
	Enable the clipping plane. Values must be set before calling. More...
void	disable () const
	DIsable the clipping plane. More...
bool	writeState (std::ofstream &f, unsigned int format, unsigned int depth) const
bool	readState (xmlNodePtr n)
bool	willDoSomething () const
	Returns true if the effect has any influence on the output. More...
void	setFractions (const float *fractionArray)
	Set the fractions of cube from margin. More...
void	useCamCoords (bool enable)
void	getCroppedBounds (BoundCube &b) const
	Alters the input box to generate cropping bounding box. More...
float	getCropValue (unsigned int pos) const
Public Member Functions inherited from Effect
	Effect ()
virtual	~Effect ()
std::string	getName () const
virtual bool	needCamUpdate () const
virtual unsigned int	numPassesNeeded () const
virtual unsigned int	getType () const

Additional Inherited Members
Static Public Member Functions inherited from Effect
static void	setCurCam (Camera *c)
static void	setBoundingCube (const BoundCube &c)
Protected Attributes inherited from Effect
unsigned int	effectType
Static Protected Attributes inherited from Effect
static Camera *	curCam =0
static BoundCube	bc

Constructor & Destructor Documentation

BoxCropEffect()

BoxCropEffect::BoxCropEffect

(

)

References EFFECT_BOX_CROP, and Effect::effectType.

Referenced by clone().

Here is the caller graph for this function:

~BoxCropEffect()

virtual BoxCropEffect::~BoxCropEffect ( )

inlinevirtual

References Effect::clone(), Effect::disable(), Effect::enable(), Effect::readState(), Effect::willDoSomething(), and Effect::writeState().

Member Function Documentation

clone()

Effect * BoxCropEffect::clone ( ) const

virtual

Implements Effect.

References BoxCropEffect().

disable()

void BoxCropEffect::disable ( ) const

virtual

DIsable the clipping plane.

Implements Effect.

References MIN_CROP_FRACTION.

enable()

void BoxCropEffect::enable ( unsigned int  pass ) const

virtual

Enable the clipping plane. Values must be set before calling.

Implements Effect.

References Point3D::angle(), ASSERT, Effect::bc, Point3D::crossProd(), Effect::curCam, Point3D::dotProd(), Point3f::fx, Point3f::fy, Point3f::fz, BoundCube::getBounds(), Camera::getUpDirection(), Camera::getViewDirection(), M_PI, MIN_CROP_FRACTION, Point3D::normalise(), quat_rot(), Point3D::setValue(), and Point3D::sqrMag().

getCroppedBounds()

void BoxCropEffect::getCroppedBounds

(

BoundCube &

b

)

const

Alters the input box to generate cropping bounding box.

References BoundCube::getBounds(), and BoundCube::setBounds().

Referenced by MainWindowFrame::OnUpdateTimer().

Here is the caller graph for this function:

getCropValue()

float BoxCropEffect::getCropValue

(

unsigned int

pos

)

const

References ASSERT.

Referenced by MainWindowFrame::OnUpdateTimer().

Here is the caller graph for this function:

readState()

bool BoxCropEffect::readState ( xmlNodePtr  n )

virtual

Implements Effect.

References XMLGetNextElemAttrib(), and XMLHelpFwdToElem().

setFractions()

void BoxCropEffect::setFractions

(

const float *

fractionArray

)

Set the fractions of cube from margin.

Referenced by MainWindowFrame::OnUpdateTimer().

Here is the caller graph for this function:

useCamCoords()

void BoxCropEffect::useCamCoords ( bool  enable )

inline

References Effect::enable().

Referenced by MainWindowFrame::OnUpdateTimer().

Here is the caller graph for this function:

willDoSomething()

bool BoxCropEffect::willDoSomething ( ) const

virtual

Returns true if the effect has any influence on the output.

Implements Effect.

References MIN_CROP_FRACTION.

Referenced by MainWindowFrame::OnUpdateTimer().

Here is the caller graph for this function:

writeState()

bool BoxCropEffect::writeState ( std::ofstream &  f, unsigned int  format, unsigned int  depth  ) const

virtual

Implements Effect.

References ASSERT, STATE_FORMAT_XML, and tabs().

---

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

• effect.h
• effect.cpp