RayGina::CORE::RimBase Class Reference

#include <RimBase.hxx>

Inheritance diagram for RayGina::CORE::RimBase:

List of all members.

Public Member Functions
	RimBase ()
	RimBase (int width, int height)
virtual	~RimBase ()
virtual const RStatus	create (const RUInt32 width, const RUInt32 height)=0
virtual const RStatus	create ()=0
virtual RColor	getPixel (const RUInt32 x, const RUInt32 y)=0
virtual RColor	getPixel (const RReal32 x, const RReal32 y)=0
virtual RColor	getPixelByUV (const RReal32 u, const RReal32 v)
virtual const RStatus	setPixel (const RUInt32 x, const RUInt32 y, const RColor)=0
virtual const RStatus	open (const RString)=0
virtual const RStatus	saveAs (const RString)=0
virtual const RString	save (RStatus *status=NULL)=0
virtual void	prepareNextFrame (int FrameNumber, RTime curTime)=0
	will be called before the frame is rendered to give the image handler a chance to prepare some stuff
virtual void	finishFrame (int FrameNumber, RTime curTime)
	will be called after all operations on the image are finished
virtual const RStatus	saveFrame (int FrameNumber, RTime curTime)
	save the current frame
virtual const RUInt32	getHeight () const =0
virtual const RUInt32	getWidth () const =0
virtual const RStatus	setNamingConditions (RString, int startFrame, int endFrame)
virtual const RStatus	setFileName (const RString filename)
	sets the filename
virtual const RString	getFileName ()
	sets the filename
Static Public Member Functions
RimBase *	load (const RString filename, RStatus *status=NULL)
const RStatus	registerFileEnding (const RString fileEnding, const RExtension *extension)
Protected Attributes
RString	_filename
Static Private Attributes
std::map< const RString, const RExtension * >	__fileEndings

---

Constructor & Destructor Documentation

RayGina::CORE::RimBase::RimBase (   )  [inline]

constructor Definition at line 20 of file RimBase.hxx.

RayGina::CORE::RimBase::RimBase (  int  width, int  height )  [inline]

Definition at line 21 of file RimBase.hxx.

virtual RayGina::CORE::RimBase::~RimBase (   )  [inline, virtual]

deconstructor Definition at line 23 of file RimBase.hxx.

---

Member Function Documentation

virtual const RStatus RayGina::CORE::RimBase::create (   )  [pure virtual]

Implemented in RayGina::HDRImagePlugin::RimHDR, RayGina::StandardImageHdl::RimFreeImage, and RayGina::StandardImageHdl::RimFreeImage96.

virtual const RStatus RayGina::CORE::RimBase::create (  const RUInt32  width, const RUInt32  height )  [pure virtual]

Implemented in RayGina::HDRImagePlugin::RimHDR, RayGina::StandardImageHdl::RimFreeImage, and RayGina::StandardImageHdl::RimFreeImage96.

virtual void RayGina::CORE::RimBase::finishFrame (  int  FrameNumber, RTime  curTime )  [inline, virtual]

will be called after all operations on the image are finished Definition at line 51 of file RimBase.hxx.

virtual const RString RayGina::CORE::RimBase::getFileName (   )  [inline, virtual]

sets the filename Definition at line 77 of file RimBase.hxx.

virtual const RUInt32 RayGina::CORE::RimBase::getHeight (   )  const [pure virtual]

Implemented in RayGina::HDRImagePlugin::RimHDR, RayGina::StandardImageHdl::RimFreeImage, and RayGina::StandardImageHdl::RimFreeImage96.

virtual RColor RayGina::CORE::RimBase::getPixel (  const RReal32  x, const RReal32  y )  [pure virtual]

virtual RColor RayGina::CORE::RimBase::getPixel (  const RUInt32  x, const RUInt32  y )  [pure virtual]

Implemented in RayGina::HDRImagePlugin::RimHDR, RayGina::StandardImageHdl::RimFreeImage, and RayGina::StandardImageHdl::RimFreeImage96.

virtual RColor RayGina::CORE::RimBase::getPixelByUV (  const RReal32  u, const RReal32  v )  [inline, virtual]

Definition at line 28 of file RimBase.hxx.

virtual const RUInt32 RayGina::CORE::RimBase::getWidth (   )  const [pure virtual]

Implemented in RayGina::HDRImagePlugin::RimHDR, RayGina::StandardImageHdl::RimFreeImage, and RayGina::StandardImageHdl::RimFreeImage96.

RimBase * RimBase::load (  const RString  filename, RStatus *  status = NULL )  [static]

Definition at line 21 of file RimBase.cxx.

virtual const RStatus RayGina::CORE::RimBase::open (  const   RString  )  [pure virtual]

Implemented in RayGina::HDRImagePlugin::RimHDR, RayGina::StandardImageHdl::RimFreeImage, and RayGina::StandardImageHdl::RimFreeImage96.

virtual void RayGina::CORE::RimBase::prepareNextFrame (  int  FrameNumber, RTime  curTime )  [pure virtual]

will be called before the frame is rendered to give the image handler a chance to prepare some stuff Implemented in RayGina::HDRImagePlugin::RimHDR, RayGina::StandardImageHdl::RimFreeImage, and RayGina::StandardImageHdl::RimFreeImage96.

const RStatus RimBase::registerFileEnding (  const RString  fileEnding, const RExtension *  extension )  [static]

Definition at line 11 of file RimBase.cxx.

virtual const RString RayGina::CORE::RimBase::save (  RStatus *  status = NULL  )  [pure virtual]

Implemented in RayGina::HDRImagePlugin::RimHDR, RayGina::StandardImageHdl::RimFreeImage, and RayGina::StandardImageHdl::RimFreeImage96.

virtual const RStatus RayGina::CORE::RimBase::saveAs (  const   RString  )  [pure virtual]

Implemented in RayGina::HDRImagePlugin::RimHDR, RayGina::StandardImageHdl::RimFreeImage, and RayGina::StandardImageHdl::RimFreeImage96.

virtual const RStatus RayGina::CORE::RimBase::saveFrame (  int  FrameNumber, RTime  curTime )  [inline, virtual]

save the current frame Definition at line 55 of file RimBase.hxx.

virtual const RStatus RayGina::CORE::RimBase::setFileName (  const RString  filename  )  [inline, virtual]

sets the filename Definition at line 72 of file RimBase.hxx.

virtual const RStatus RayGina::CORE::RimBase::setNamingConditions (  RString  , int  startFrame, int  endFrame )  [inline, virtual]

Sets the naming for frames in an animation returns true if frame will be saved as individual files returns false if all frames will be saved in one file (video-container) Definition at line 67 of file RimBase.hxx.

virtual const RStatus RayGina::CORE::RimBase::setPixel (  const RUInt32  x, const RUInt32  y, const   RColor )  [pure virtual]

Implemented in RayGina::HDRImagePlugin::RimHDR, RayGina::StandardImageHdl::RimFreeImage, and RayGina::StandardImageHdl::RimFreeImage96.

---

Member Data Documentation

std::map< const RString, const RExtension * > RimBase::__fileEndings [static, private]

Definition at line 9 of file RimBase.cxx.

RString RayGina::CORE::RimBase::_filename [protected]

Reimplemented in RayGina::HDRImagePlugin::RimHDR. Definition at line 85 of file RimBase.hxx.

---

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

• core/include/Rim/RimBase.hxx
• core/sources/Rim/RimBase.cxx

---