slideshow::internal::ParametricPolyPolygon Class Reference

Interface defining a parametric poly-polygon. More...

#include <parametricpolypolygon.hxx>

Inheritance diagram for slideshow::internal::ParametricPolyPolygon:

Public Member Functions
virtual	~ParametricPolyPolygon ()
virtual ::basegfx::B2DPolyPolygon	operator() (double t)=0
	Retrieve the poly-polygon for value t. More...

Detailed Description

Interface defining a parametric poly-polygon.

This interface defines a poly-polygon, whose actual shape is parameterized by a floating point value. This is e.g. used to generically access the various clip polygon generators for transition effects.

Since for every parametric poly-polygon, there is a set of variations, which can easily be generated by simple transformations or change in parameter range sweep direction, objects implementing this interface only generate one prototypical instance of the parametric poly-polygon. Generally speaking, the main effect direction should be horizontal, it should make increasingly more area visible (transition 'in'), and when there is a designated direction given, that should be left-to-right.

Definition at line 49 of file parametricpolypolygon.hxx.

Constructor & Destructor Documentation

~ParametricPolyPolygon()

virtual slideshow::internal::ParametricPolyPolygon::~ParametricPolyPolygon ( )

inlinevirtual

Definition at line 52 of file parametricpolypolygon.hxx.

Member Function Documentation

operator()()

virtual ::basegfx::B2DPolyPolygon slideshow::internal::ParametricPolyPolygon::operator() ( double  t )

pure virtual

Retrieve the poly-polygon for value t.

Parameters

t	Current parameter value to retrieve the corresponding poly-polygon for. Permissible values for t must be in the range [0,1].

Returns

a poly-polygon corresponding to the given parameter value. The poly-polygon is interpreted as living in the unit rectangle (i.e. [0,1]x[0,1]), but is not necessarily constrained to completely lie in this area (this very much depends on the actual effect to be generated). Although, from a performance perspective, it currently is advantageous to try to keep the poly-polygon within these bounds (at least if there are no hard reasons not to do so), because then reversion or out transformations are potentially faster to compute (see the TransitionInfo::meReverseMethod member in transitionfactory.cxx). Furthermore, if one of the polygon modifications involve subtraction (also see TransitionInfo::meReverseMethod), all generated polygons should be oriented clock-wise (i.e. traversing the polygon vertices with increasing vertex index should generate a clock-wise movement).

Implemented in slideshow::internal::BarWipePolyPolygon, slideshow::internal::BoxWipe, slideshow::internal::ClockWipe, slideshow::internal::FanWipe, slideshow::internal::FigureWipe, slideshow::internal::FourBoxWipe, slideshow::internal::PinWheelWipe, slideshow::internal::RandomWipe, slideshow::internal::SnakeWipe, slideshow::internal::ParallelSnakesWipe, slideshow::internal::SpiralWipe, slideshow::internal::BoxSnakesWipe, slideshow::internal::SweepWipe, slideshow::internal::WaterfallWipe, slideshow::internal::ZigZagWipe, slideshow::internal::BarnZigZagWipe, slideshow::internal::BarnDoorWipe, slideshow::internal::CheckerBoardWipe, slideshow::internal::DoubleDiamondWipe, slideshow::internal::EllipseWipe, slideshow::internal::IrisWipe, and slideshow::internal::VeeWipe.

---

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

• parametricpolypolygon.hxx