NoiseDistort Class Reference

#include <distort.h>

Inheritance diagram for NoiseDistort:

synfig::Layer_Composite synfig::Layer synfig::Node

List of all members.

Public Member Functions

 NoiseDistort ()
virtual bool set_param (const synfig::String &param, const synfig::ValueBase &value)
 Sets the parameter described by param to value.
virtual synfig::ValueBase get_param (const synfig::String &param) const
 Get the value of the specified parameter.
virtual synfig::Color get_color (synfig::Context context, const synfig::Point &pos) const
 Gets the color of the Canvas at pos.
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 void set_time (synfig::Context context, synfig::Time time) const
 Sets the time for the selected Layer and those under it.
virtual void set_time (synfig::Context context, synfig::Time time, const synfig::Point &point) const
 Sets the time for the selected Layer and those under it for a specific point.
virtual synfig::Rect get_bounding_rect (synfig::Context context) const
virtual Vocab get_param_vocab () const
 Gets the parameter vocabulary.
virtual bool reads_context () const
 Returns true if the layer needs to be able to examine its context.


Constructor & Destructor Documentation

NoiseDistort::NoiseDistort (  ) 


Member Function Documentation

bool NoiseDistort::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_Composite.

References synfig::ValueBase::get(), IMPORT, synfig::ValueBase::same_type_as(), and RandomNoise::set_seed().

ValueBase NoiseDistort::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_Composite.

References EXPORT, EXPORT_NAME, EXPORT_VERSION, and RandomNoise::get_seed().

Color NoiseDistort::get_color ( synfig::Context  context,
const synfig::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::Layer_Composite::get_amount(), synfig::Layer_Composite::get_blend_method(), and synfig::Context::get_color().

synfig::Layer::Handle NoiseDistort::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::Layer_Composite::get_amount(), synfig::Layer_Composite::get_blend_method(), and synfig::Context::hit_check().

void NoiseDistort::set_time ( synfig::Context  context,
synfig::Time  time 
) const [virtual]

Sets the time for the selected Layer and those under it.

Parameters:
context Context iterator referring to next Layer.
time writeme
See also:
Handle::set_time()

Reimplemented from synfig::Layer.

References synfig::Context::set_time().

void NoiseDistort::set_time ( synfig::Context  context,
synfig::Time  time,
const synfig::Point point 
) const [virtual]

Sets the time for the selected Layer and those under it for a specific point.

Parameters:
context Context iterator referring to next Layer.
time writeme
point writeme
See also:
Handle::set_time()
Todo:
point should be of the type const Point &

Reimplemented from synfig::Layer.

References synfig::Context::set_time().

Rect NoiseDistort::get_bounding_rect ( synfig::Context  context  )  const [virtual]

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

virtual bool NoiseDistort::reads_context (  )  const [inline, virtual]

Returns true if the layer needs to be able to examine its context.

context to render itself, other than for simple blending. For example, the blur layer will return true - it can't do its job if it can't see its context, and the circle layer will return false - rendering a circle doesn't depend on the underlying context until the final blend operation.

Reimplemented from synfig::Layer.


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