LightWrap++
AC++wrapperfortheLightWave3DSDK
lwpp::Image Class Reference

#include <image.h>

+ Inheritance diagram for lwpp::Image:
+ Collaboration diagram for lwpp::Image:

List of all members.

Public Member Functions

 Image (LWImageID _id=0)
LWBufferValue alpha (int x, int y) const
void clear (void)
LWPixmapID evaluate (LWTime t)
const char * filename (LWFrame frame=0) const
void first (void)
double GetAlphaSpot (double x, double y, double spotSize, bool blend)
int getHeight (void) const
LWImageID getID () const
int getImageNum (LWImageID i)
double GetLumaSpot (double x, double y, double spotSize, bool blend)
LWImageID getNumImage (int n)
void GetPopUp (int i)
 Get the value returned from a pop-up.
void GetRGBSpot (double x, double y, double spotSize, bool blend, double rgb[3])
const char * GetSelectedName ()
int getWidth (void) const
bool hasAlpha (void) const
bool isColor (void) const
bool isValid ()
void load (const char *filename)
virtual LWError Load (const LoadState &ls)
 Load data from a LWLoadState.
LWBufferValue luma (int x, int y) const
const char * name () const
void needAA ()
void next (void)
Imageoperator= (const Image &from)
virtual size_t popCount (void)
 Actual worker function to be supplied by the deriving class.
virtual const char * popName (int n)
 Actual worker function to be supplied by the deriving class.
bool replace (const std::string &newFile)
void RGB (int x, int y, LWBufferValue val[3]) const
virtual LWError Save (const SaveState &ss)
 Save data to a LWSaveState.
void SetID (LWImageID _id)
int SetPopUp ()
 Set the value for a pop-up.
void size (int &w, int &h) const

Static Public Member Functions

static int PopCount (void *inst)
 PopCount callback for LightWave.
static const char * PopName (void *inst, int n)
 PopUpName name callback for LightWave.

Protected Member Functions

bool _acquireGlobal ()
virtual bool available () const
 Check if the global is available.
virtual LWImageList * getGlobal ()
 Get the pointer to the global.
LWImageList * operator-> ()
 Get the pointer to the global.

Protected Attributes

int index

Static Protected Attributes

static LWImageList * globPtr
 Pointer to the global functions.

Detailed Description

Wrapper for LWImageList


Constructor & Destructor Documentation

lwpp::Image::Image ( LWImageID  _id = 0)
inline

Member Function Documentation

bool lwpp::GlobalBase< LWImageList >::_acquireGlobal ( )
inlineprotectedinherited
LWBufferValue lwpp::Image::alpha ( int  x,
int  y 
) const
inline
virtual bool lwpp::GlobalBase< LWImageList >::available ( ) const
inlinevirtualinherited

Check if the global is available.

void lwpp::Image::clear ( void  )
inline
LWPixmapID lwpp::Image::evaluate ( LWTime  t)
inline
const char* lwpp::Image::filename ( LWFrame  frame = 0) const
inline
void lwpp::Image::first ( void  )
inline
double lwpp::Image::GetAlphaSpot ( double  x,
double  y,
double  spotSize,
bool  blend 
)
inline
virtual LWImageList * lwpp::GlobalBase< LWImageList >::getGlobal ( )
inlinevirtualinherited

Get the pointer to the global.

int lwpp::Image::getHeight ( void  ) const
inline
LWImageID lwpp::Image::getID ( void  ) const
inline
int lwpp::Image::getImageNum ( LWImageID  i)
double lwpp::Image::GetLumaSpot ( double  x,
double  y,
double  spotSize,
bool  blend 
)
inline
LWImageID lwpp::Image::getNumImage ( int  n)
void lwpp::Image::GetPopUp ( int  i)

Get the value returned from a pop-up.

void lwpp::Image::GetRGBSpot ( double  x,
double  y,
double  spotSize,
bool  blend,
double  rgb[3] 
)
inline
const char* lwpp::PopUpCallback::GetSelectedName ( )
inlineinherited
int lwpp::Image::getWidth ( void  ) const
inline
bool lwpp::Image::hasAlpha ( void  ) const
inline
bool lwpp::Image::isColor ( void  ) const
inline
bool lwpp::Image::isValid ( )
inline
void lwpp::Image::load ( const char *  filename)
inline
virtual LWError lwpp::Image::Load ( const LoadState ls)
inlinevirtual

Load data from a LWLoadState.

Parameters:
*lsLWLoadState to load from
Returns:
An error string if an error occured, 0 otherwise

Reimplemented from lwpp::Storeable.

LWBufferValue lwpp::Image::luma ( int  x,
int  y 
) const
inline
const char* lwpp::Image::name ( ) const
inline
void lwpp::Image::needAA ( )
inline
void lwpp::Image::next ( void  )
inline
LWImageList * lwpp::GlobalBase< LWImageList >::operator-> ( )
inlineinherited

Get the pointer to the global.

Image& lwpp::Image::operator= ( const Image from)
inline
static int lwpp::PopUpCallback::PopCount ( void *  inst)
inlinestaticinherited

PopCount callback for LightWave.

size_t lwpp::Image::popCount ( void  )
virtual

Actual worker function to be supplied by the deriving class.

Returns:
The number of items

Implements lwpp::PopUpCallback.

static const char* lwpp::PopUpCallback::PopName ( void *  inst,
int  n 
)
inlinestaticinherited

PopUpName name callback for LightWave.

const char * lwpp::Image::popName ( int  n)
virtual

Actual worker function to be supplied by the deriving class.

Parameters:
nA item index
Returns:
The name of the item

Implements lwpp::PopUpCallback.

bool lwpp::Image::replace ( const std::string &  newFile)
inline
void lwpp::Image::RGB ( int  x,
int  y,
LWBufferValue  val[3] 
) const
inline
virtual LWError lwpp::Image::Save ( const SaveState ss)
inlinevirtual

Save data to a LWSaveState.

Parameters:
*ssLWSaveState to save to
Returns:
An error string if an error occured, 0 otherwise

Reimplemented from lwpp::Storeable.

void lwpp::Image::SetID ( LWImageID  _id)
inline
int lwpp::Image::SetPopUp ( void  )

Set the value for a pop-up.

void lwpp::Image::size ( int &  w,
int &  h 
) const
inline

Member Data Documentation

LWImageList * lwpp::GlobalBase< LWImageList >::globPtr
staticprotectedinherited

Pointer to the global functions.

int lwpp::PopUpCallback::index
protectedinherited

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