2017-04-17 06:17:10 -06:00

142 lines
4.2 KiB
C++
Executable File

#ifndef _MImage
#define _MImage
//
//-
// ==========================================================================
// Copyright (C) 1995 - 2005 Alias Systems Corp. and/or its licensors. All
// rights reserved.
//
// The coded instructions, statements, computer programs, and/or related
// material (collectively the "Data") in these files contain unpublished
// information proprietary to Alias Systems Corp. ("Alias") and/or its
// licensors, which is protected by Canadian and US federal copyright law and
// by international treaties.
//
// The Data may not be disclosed or distributed to third parties or be copied
// or duplicated, in whole or in part, without the prior written consent of
// Alias.
//
// THE DATA IS PROVIDED "AS IS". ALIAS HEREBY DISCLAIMS ALL WARRANTIES RELATING
// TO THE DATA, INCLUDING, WITHOUT LIMITATION, ANY AND ALL EXPRESS OR IMPLIED
// WARRANTIES OF NON-INFRINGEMENT, MERCHANTABILITY AND/OR FITNESS FOR A
// PARTICULAR PURPOSE. IN NO EVENT SHALL ALIAS BE LIABLE FOR ANY DAMAGES
// WHATSOEVER, WHETHER DIRECT, INDIRECT, SPECIAL, OR PUNITIVE, WHETHER IN AN
// ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, OR IN EQUITY,
// ARISING OUT OF ACCESS TO, USE OF, OR RELIANCE UPON THE DATA.
// ==========================================================================
//+
//
// CLASS: MImage
//
// *****************************************************************************
//
// CLASS DESCRIPTION (MImage)
//
// MImage is a class which provides access to some of Maya's image manipulation
// functionality.
//
// MImage provides methods for loading and resizing image files in any
// Maya-supported format, including but not limited to IFF, SGI, Softimage,
// TIFF, Alias PIX, GIF, RLA, JPEG, EPS.
//
// MImage stores the image as an uncompressed array of pixels, that can be read
// and manipulate directly. That format is either RGBA (depth=4), RGB (depth=3),
// or Luminance (depth=1).
//
// (NOTE: At the moment, all files are directly converted to RGBA regardless
// of their original format. This restriction might get lifted in the future if
// there is enough interest.)
//
// *****************************************************************************
#if defined __cplusplus
// *****************************************************************************
// INCLUDED HEADER FILES
#include <maya/MObject.h>
#include <maya/MString.h>
#include <maya/MTypes.h>
// *****************************************************************************
// CLASS DECLARATION (MImage)
/// Image manipulation
/**
This class provides methods for reading file images stored on disk.
*/
#ifdef _WIN32
#pragma warning(disable: 4522)
#endif // _WIN32
class OPENMAYA_EXPORT MImage
{
public:
// Possible source or target filter formats.
///
enum MImageFilterFormat {
///
kNoFormat,
///
kHeightFieldBumpFormat,
///
kNormalMapBumpFormat,
///
kUnknownFormat
};
///
MImage();
///
~MImage();
///
MStatus create(unsigned int width, unsigned int height);
///
MStatus readFromFile(MString pathname);
///
MStatus readFromTextureNode(const MObject& fileTextureObject);
///
MStatus getSize(unsigned int &width, unsigned int &height) const;
///
unsigned char* pixels() const;
///
void setPixels(unsigned char* pixels, unsigned int width, unsigned int height);
///
unsigned int depth();
///
MStatus resize(int width, int height, bool preserveAspectRatio = true);
///
static bool filterExists(MImageFilterFormat sourceFormat, MImageFilterFormat targetFormat);
///
MStatus filter(MImageFilterFormat sourceFormat, MImageFilterFormat targetFormat,
double scale = 1.0, double offset = 0.0);
///
MStatus writeToFile(MString pathname, MString outputFormat = MString("iff"));
///
MStatus release();
///
void verticalFlip();
///
void setRGBA(bool rgbaFormat);
protected:
// No protected members
private:
void set( void * );
void *_pPixelMap;
};
#ifdef _WIN32
#pragma warning(default: 4522)
#endif // _WIN32
// *****************************************************************************
#endif /* __cplusplus */
#endif /* _MImage */