synfig::RendDesc Class Reference

#include <renddesc.h>

List of all members.

Public Types

enum  Lock {
  PX_ASPECT = (1<<0), PX_AREA = (1<<1), PX_W = (1<<2), PX_H = (1<<3),
  IM_ASPECT = (1<<4), IM_SPAN = (1<<5), IM_W = (1<<6), IM_H = (1<<7),
  IM_ZOOMIN = (1<<8), IM_ZOOMOUT = (1<<9), LINK_PX_ASPECT = (1<<10), LINK_PX_AREA = (1<<11),
  LINK_IM_ASPECT = (1<<12), LINK_IM_SPAN = (1<<13), LINK_IM_CENTER = (1<<14)
}
enum  {
  ANTIALIAS_UNIFORM, ANTIALIAS_MONTE_CARLO, ANTIALIAS_JITTERED, ANTIALIAS_ADAPTIVE,
  ANTIALIAS_QUINTCUNX
}

Public Member Functions

 RendDesc ()
 Default Constructor.
RendDescapply (const RendDesc &x)
const Colorget_bg_color () const
RendDescset_bg_color (const Color &bg)
int get_w () const
 Return the width of the composition in pixels.
RendDescset_w (int x)
 Set the width of the composition in pixels.
int get_h () const
 Return the height of the composition in pixels.
RendDescset_h (int y)
 Set the height of the composition in pixels.
RendDescset_wh (int x, int y)
 Sets the width and height of the composition in pixels.
Real get_x_res () const
 Returns the horizontal resolution (in dots per meter).
RendDescset_x_res (Real x)
 Sets the horizontal resolution (in dots per meter).
Real get_y_res () const
 Returns the vertical resolution (in dots per meter).
RendDescset_y_res (Real y)
 Sets the vertical resolution (in dots per meter).
Real get_physical_w () const
 Return the physical width of the composition in meters.
Real get_physical_h () const
 Return the physical height of the composition in meters.
RendDescset_physical_w (Real w)
 Set the physical width of the composition in meters.
RendDescset_physical_h (Real h)
 Set the physical height of the composition in meters.
int get_frame_start () const
 Return the index of the first frame.
RendDescset_frame_start (int x)
 Set the index of the first frame.
int get_frame_end () const
 Return the index of the last frame.
RendDescset_frame_end (int x)
 Set the index of the last frame.
const Time get_time_start () const
 Return the starting time of the animation.
RendDescset_time_start (Time x)
 Set the time that the animation will start.
const Time get_time_end () const
 Return the end time of the animation.
RendDescset_time_end (Time x)
 Set the time that the animation will end.
RendDescset_time (Time x)
 Setup for one frame at the given time.
RendDescset_frame (int x)
 Setup for one frame.
const float & get_frame_rate () const
 Return the frame rate (frames-per-second).
RendDescset_frame_rate (float x)
 Set the frame rate (frames-per-second).
const bool & get_interlaced () const
 Return the status of the interlaced flag.
RendDescset_interlaced (bool x)
 Set the interlace flag.
const bool & get_clamp () const
 Return the status of the clamp flag.
RendDescset_clamp (bool x)
 Set the clamp flag.
RendDescset_flags (const int &x)
 Set constraint flags.
RendDescclear_flags ()
 Clear constraint flags.
int get_flags () const
 Get constraint flags.
Point::value_type get_pixel_aspect () const
 Return the aspect ratio of a single pixel.
Point::value_type get_image_aspect () const
 Return the aspect ratio of the entire image.
const int & get_antialias () const
 Return the antialias amount.
RendDescset_antialias (const int &x)
 Set the antilaias amount.
Real get_span () const
 Return the distance from the bottom-right to the top-left.
RendDescset_span (const Real &x)
 Set the span distance.
const Pointget_focus () const
RendDescset_focus (const Point &x)
const Pointget_tl () const
RendDescset_tl (const Point &x)
const Pointget_br () const
RendDescset_br (const Point &x)
Rect get_rect () const
RendDescset_viewport (const Point &__tl, const Point &__br)
RendDescset_viewport (Vector::value_type a, Vector::value_type b, Vector::value_type c, Vector::value_type d)
Real get_pw () const
 Returns the width of one pixel.
Real get_ph () const
 Returns the height of one pixel.
RendDescset_subwindow (int x, int y, int w, int h)
 Sets viewport to represent the screen at the give pixel coordinates.

Public Attributes

enum synfig::RendDesc:: { ... }  AntialiasFilter


Detailed Description

Todo:
writeme


Member Enumeration Documentation

enum synfig::RendDesc::Lock
 

Enumerator:
PX_ASPECT 
PX_AREA 
PX_W 
PX_H 
IM_ASPECT 
IM_SPAN 
IM_W 
IM_H 
IM_ZOOMIN 
IM_ZOOMOUT 
LINK_PX_ASPECT 
LINK_PX_AREA 
LINK_IM_ASPECT 
LINK_IM_SPAN 
LINK_IM_CENTER 

anonymous enum
 

Enumerator:
ANTIALIAS_UNIFORM 
ANTIALIAS_MONTE_CARLO 
ANTIALIAS_JITTERED 
ANTIALIAS_ADAPTIVE 
ANTIALIAS_QUINTCUNX 


Constructor & Destructor Documentation

synfig::RendDesc::RendDesc  )  [inline]
 

Default Constructor.


Member Function Documentation

RendDesc & RendDesc::apply const RendDesc x  ) 
 

Todo:
This needs to be documented further.

const Color & RendDesc::get_bg_color  )  const
 

Todo:
This needs to be documented further.

RendDesc & RendDesc::set_bg_color const Color bg  ) 
 

Todo:
This needs to be documented further.

int RendDesc::get_w  )  const
 

Return the width of the composition in pixels.

RendDesc & RendDesc::set_w int  x  ) 
 

Set the width of the composition in pixels.

The other parameters are adjusted according to the constraints placed on the flags.

int RendDesc::get_h  )  const
 

Return the height of the composition in pixels.

RendDesc & RendDesc::set_h int  y  ) 
 

Set the height of the composition in pixels.

The other parameters are adjusted according to the constraints placed on the flags.

RendDesc & RendDesc::set_wh int  x,
int  y
 

Sets the width and height of the composition in pixels.

Real RendDesc::get_x_res  )  const
 

Returns the horizontal resolution (in dots per meter).

RendDesc & RendDesc::set_x_res Real  x  ) 
 

Sets the horizontal resolution (in dots per meter).

Real RendDesc::get_y_res  )  const
 

Returns the vertical resolution (in dots per meter).

RendDesc & RendDesc::set_y_res Real  y  ) 
 

Sets the vertical resolution (in dots per meter).

Real RendDesc::get_physical_w  )  const
 

Return the physical width of the composition in meters.

Real RendDesc::get_physical_h  )  const
 

Return the physical height of the composition in meters.

RendDesc & RendDesc::set_physical_w Real  w  ) 
 

Set the physical width of the composition in meters.

RendDesc & RendDesc::set_physical_h Real  h  ) 
 

Set the physical height of the composition in meters.

int RendDesc::get_frame_start  )  const
 

Return the index of the first frame.

RendDesc & RendDesc::set_frame_start int  x  ) 
 

Set the index of the first frame.

int RendDesc::get_frame_end  )  const
 

Return the index of the last frame.

RendDesc & RendDesc::set_frame_end int  x  ) 
 

Set the index of the last frame.

const Time RendDesc::get_time_start  )  const
 

Return the starting time of the animation.

RendDesc & RendDesc::set_time_start Time  x  ) 
 

Set the time that the animation will start.

const Time RendDesc::get_time_end  )  const
 

Return the end time of the animation.

RendDesc & RendDesc::set_time_end Time  x  ) 
 

Set the time that the animation will end.

RendDesc & RendDesc::set_time Time  x  ) 
 

Setup for one frame at the given time.

RendDesc & RendDesc::set_frame int  x  ) 
 

Setup for one frame.

const float & RendDesc::get_frame_rate  )  const
 

Return the frame rate (frames-per-second).

RendDesc & RendDesc::set_frame_rate float  x  ) 
 

Set the frame rate (frames-per-second).

const bool & RendDesc::get_interlaced  )  const
 

Return the status of the interlaced flag.

RendDesc & RendDesc::set_interlaced bool  x  ) 
 

Set the interlace flag.

const bool & RendDesc::get_clamp  )  const
 

Return the status of the clamp flag.

RendDesc & RendDesc::set_clamp bool  x  ) 
 

Set the clamp flag.

RendDesc & RendDesc::set_flags const int &  x  ) 
 

Set constraint flags.

RendDesc & RendDesc::clear_flags  ) 
 

Clear constraint flags.

int RendDesc::get_flags  )  const
 

Get constraint flags.

Real RendDesc::get_pixel_aspect  )  const
 

Return the aspect ratio of a single pixel.

Real RendDesc::get_image_aspect  )  const
 

Return the aspect ratio of the entire image.

const int & RendDesc::get_antialias  )  const
 

Return the antialias amount.

RendDesc & RendDesc::set_antialias const int &  x  ) 
 

Set the antilaias amount.

Real RendDesc::get_span  )  const
 

Return the distance from the bottom-right to the top-left.

RendDesc & RendDesc::set_span const Real x  ) 
 

Set the span distance.

Todo:
This needs to be documented further. or fix me
Todo:
This needs to be documented further. or fix me

const Point & RendDesc::get_focus  )  const
 

RendDesc & RendDesc::set_focus const Point x  ) 
 

const Point & RendDesc::get_tl  )  const
 

RendDesc & RendDesc::set_tl const Point x  ) 
 

const Point & RendDesc::get_br  )  const
 

RendDesc & RendDesc::set_br const Point x  ) 
 

Rect synfig::RendDesc::get_rect  )  const [inline]
 

RendDesc & RendDesc::set_viewport const Point __tl,
const Point __br
 

RendDesc& synfig::RendDesc::set_viewport Vector::value_type  a,
Vector::value_type  b,
Vector::value_type  c,
Vector::value_type  d
 

Real RendDesc::get_pw  )  const
 

Returns the width of one pixel.

Real RendDesc::get_ph  )  const
 

Returns the height of one pixel.

RendDesc & RendDesc::set_subwindow int  x,
int  y,
int  w,
int  h
 

Sets viewport to represent the screen at the give pixel coordinates.


Member Data Documentation

enum { ... } synfig::RendDesc::AntialiasFilter
 


The documentation for this class was generated from the following files:
Generated on Fri Jun 23 15:20:51 2006 for synfig by  doxygen 1.4.6