CurveWarp Class Reference

#include <curvewarp.h>

Inheritance diagram for CurveWarp:

synfig::Layer synfig::Node

List of all members.

Public Member Functions

 CurveWarp ()
virtual bool set_param (const String &param, const ValueBase &value)
 Sets the parameter described by param to value.
virtual ValueBase get_param (const String &param) const
 Get the value of the specified parameter.
virtual Point transform (const Point &point_, Real *dist=NULL, Real *along=0, int quality=10) const
virtual Color get_color (Context context, const Point &pos) const
 Gets the color of the Canvas at pos.
virtual bool accelerated_render (Context context, Surface *surface, int quality, const RendDesc &renddesc, ProgressCallback *cb) const
 Renders the Canvas to the given Surface in an accelerated manner.
synfig::Layer::Handle hit_check (synfig::Context context, const synfig::Point &point) const
 Checks to see if a part of the layer is directly under point.
virtual Vocab get_param_vocab () const
 Gets the parameter vocabulary.


Constructor & Destructor Documentation

CurveWarp::CurveWarp (  ) 

References f.


Member Function Documentation

bool CurveWarp::set_param ( const String &  param,
const ValueBase value 
) [virtual]

Sets the parameter described by param to value.

Parameters:
param The name of the parameter to set
value What the parameter is to be set to.
Returns:
true on success, false upon rejection or failure. If it returns false, then the Layer is assumed to remain unchanged.
See also:
get_param()
Todo:
param should be of the type const String &param

Reimplemented from synfig::Layer.

References synfig::ValueBase::get_type(), IMPORT, and IMPORT_AS.

ValueBase CurveWarp::get_param ( const String &  param  )  const [virtual]

Get the value of the specified parameter.

Returns:
The requested parameter value, or (upon failure) a NIL ValueBase.
See also:
set_param()
Todo:
param should be of the type const String &

Reimplemented from synfig::Layer.

References EXPORT, EXPORT_NAME, and EXPORT_VERSION.

Point CurveWarp::transform ( const Point point_,
Real *  dist = NULL,
Real *  along = 0,
int  quality = 10 
) const [inline, virtual]

Color CurveWarp::get_color ( Context  context,
const Point pos 
) const [virtual]

Gets the color of the Canvas at pos.

Parameters:
context Context iterator referring to next Layer.
pos Point which indicates where the Color should come from
See also:
Handle::get_color()

Reimplemented from synfig::Layer.

References synfig::Context::get_color(), and transform().

bool CurveWarp::accelerated_render ( Context  context,
Surface surface,
int  quality,
const RendDesc renddesc,
ProgressCallback cb 
) const [virtual]

Renders the Canvas to the given Surface in an accelerated manner.

Parameters:
context Context iterator referring to next Layer.
surface Pointer to Surface to render to.
quality The requested quality-level to render at.
renddesc The associated RendDesc.
cb Pointer to callback object. May be NULL if there is no callback.
Returns:
true on success, false on failure
See also:
Handle::accelerated_render()

Reimplemented from synfig::Layer.

References std::abs(), synfig::Context::accelerated_render(), synfig::ProgressCallback::amount_complete(), synfig::SuperCallback::amount_complete(), synfig::Surface::clear(), synfig::RendDesc::clear_flags(), synfig::RendDesc::get_br(), synfig::Context::get_color(), synfig::RendDesc::get_h(), synfig::RendDesc::get_ph(), synfig::RendDesc::get_pw(), synfig::RendDesc::get_tl(), synfig::RendDesc::get_w(), MAXPIX, synfig::RendDesc::set_br(), synfig::RendDesc::set_tl(), synfig::RendDesc::set_wh(), transform(), and UPDATE_DIST.

synfig::Layer::Handle CurveWarp::hit_check ( synfig::Context  context,
const synfig::Point point 
) const [virtual]

Checks to see if a part of the layer is directly under point.

Parameters:
context Context iterator referring to next Layer.
point The point to check
Returns:
The handle of the layer under point. If there is not a layer under point, then returns an empty handle.

Reimplemented from synfig::Layer.

References synfig::Context::hit_check(), and transform().

Layer::Vocab CurveWarp::get_param_vocab ( void   )  const [virtual]

Gets the parameter vocabulary.

Reimplemented from synfig::Layer.

References _, and synfig::Layer::set_description().


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

Generated on Fri Jul 31 00:01:57 2009 for synfig-core by  doxygen 1.5.6