synfig::Layer_SphereDistort Class Reference

#include <sphere_distort.h>

Inheritance diagram for synfig::Layer_SphereDistort:

synfig::Layer synfig::Node

List of all members.

Public Member Functions

 Layer_SphereDistort ()
virtual bool set_param (const String &param, const synfig::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 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 Rect get_bounding_rect () const
virtual Vocab get_param_vocab () const
 Gets the parameter vocabulary.
virtual etl::handle
< synfig::Transform
get_transform () const

Friends

class Spherize_Trans


Constructor & Destructor Documentation

Layer_SphereDistort::Layer_SphereDistort (  ) 


Member Function Documentation

bool Layer_SphereDistort::set_param ( const 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 synfig::Layer::connect_dynamic_param(), synfig::Layer::disconnect_dynamic_param(), synfig::Layer::dynamic_param_list(), IMPORT, IMPORT_AS, IMPORT_PLUS, and synfig::warning().

ValueBase Layer_SphereDistort::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_AS, EXPORT_NAME, and EXPORT_VERSION.

Color Layer_SphereDistort::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::Color::alpha(), synfig::Context::get_color(), and sphtrans().

bool Layer_SphereDistort::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::Color::alpha(), synfig::Surface::clear(), synfig::Rect::expand(), 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(), synfig::intersect(), synfig::Rect::set_point(), synfig::RendDesc::set_subwindow(), sphtrans(), TYPE_DISTH, TYPE_DISTV, TYPE_NORMAL, and synfig::warning().

synfig::Layer::Handle Layer_SphereDistort::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 sphtrans().

Rect Layer_SphereDistort::get_bounding_rect (  )  const [virtual]

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

Gets the parameter vocabulary.

Reimplemented from synfig::Layer.

References _, synfig::Layer::set_description(), TYPE_DISTH, TYPE_DISTV, and TYPE_NORMAL.

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

Todo:
This needs to be documented further.

Reimplemented from synfig::Layer.

References Spherize_Trans.


Friends And Related Function Documentation

friend class Spherize_Trans [friend]

Referenced by get_transform().


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

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