Warp Class Reference

#include <warp.h>

Inheritance diagram for Warp:

synfig::Layer synfig::Node

List of all members.

Public Member Functions

void sync ()
 Warp ()
 ~Warp ()
virtual synfig::Rect get_full_bounding_rect (synfig::Context context) const
virtual synfig::Rect get_bounding_rect () const
virtual bool set_param (const synfig::String &param, const synfig::ValueBase &value)
 Sets the parameter described by param to value.
virtual ValueBase get_param (const synfig::String &param) const
 Get the value of the specified parameter.
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.
virtual etl::handle
< synfig::Transform
get_transform () const

Friends

class Warp_Trans


Constructor & Destructor Documentation

Warp::Warp (  ) 

References sync().

Warp::~Warp (  ) 


Member Function Documentation

void Warp::sync (  ) 

References mat3_invert().

Referenced by set_param(), and Warp().

synfig::Rect Warp::get_full_bounding_rect ( synfig::Context  context  )  const [virtual]

synfig::Rect Warp::get_bounding_rect (  )  const [virtual]

Reimplemented from synfig::Layer.

bool Warp::set_param ( const synfig::String param,
const synfig::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 IMPORT, IMPORT_PLUS, and sync().

ValueBase Warp::get_param ( const synfig::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.

Color Warp::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 synfig::Rect::is_inside().

bool Warp::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 synfig::Context::accelerated_render(), synfig::SuperCallback::amount_complete(), synfig::ProgressCallback::amount_complete(), synfig::Surface::clear(), synfig::RendDesc::clear_flags(), synfig::Rect::expand(), f, synfig::RendDesc::get_br(), synfig::Context::get_color(), synfig::Context::get_full_bounding_rect(), synfig::RendDesc::get_h(), synfig::Rect::get_max(), synfig::Rect::get_min(), synfig::RendDesc::get_tl(), synfig::RendDesc::get_w(), intersect(), synfig::Rect::is_inside(), synfig::RendDesc::set_br(), synfig::RendDesc::set_tl(), and synfig::RendDesc::set_wh().

synfig::Layer::Handle Warp::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 synfig::Rect::is_inside().

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

Gets the parameter vocabulary.

Reimplemented from synfig::Layer.

References _.

etl::handle< Transform > Warp::get_transform (  )  const [virtual]

Todo:
This needs to be documented further.

Reimplemented from synfig::Layer.

References Warp_Trans.

Referenced by get_full_bounding_rect().


Friends And Related Function Documentation

friend class Warp_Trans [friend]

Referenced by get_transform().


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