就业培训     下载中心     Wiki     联络 登录   注册

---

// load image file into the given BaseBitmap if (bitmap-> Init (selectedImageFile) != IMAGERESULT::OK ) return maxon::IoError( MAXON_SOURCE_LOCATION , MaxonConvert (selectedImageFile, MAXONCONVERTMODE::NONE ), "Could not load image file." _s);

// show BaseBitmap in the Picture Viewer ShowBitmap (bitmap);

// This example creates a new BaseBitmap with Full HD resolution. // If the BaseBitmap could be created, it is filled with a color. AutoAlloc<BaseBitmap> bitmap; if (bitmap == nullptr ) return maxon::OutOfMemoryError( MAXON_SOURCE_LOCATION );

// initialize the BaseBitmap with the given dimensions const Int32 width = 1920; const Int32 height = 1080; const Int32 depth = 24; const IMAGERESULT res = bitmap-> Init (width, height, depth); if (res != IMAGERESULT::OK ) return maxon::OutOfMemoryError( MAXON_SOURCE_LOCATION );

// loop through all pixels Random randomGen; for ( Int32 x = 0; x < width; ++x) { for ( Int32 y = 0; y < height; ++y) { // set to a random color const Int32 red = Int32 (randomGen. Get01 () * COLORTOINT_MULTIPLIER ); const Int32 green = Int32 (randomGen. Get01 () * COLORTOINT_MULTIPLIER ); const Int32 blue = Int32 (randomGen. Get01 () * COLORTOINT_MULTIPLIER ); bitmap-> SetPixel (x, y, red, green, blue); } }

// show BaseBitmap in the Picture Viewer ShowBitmap (bitmap);

AutoBitmap can be used to create a BaseBitmap from an image file in the plugin resource path or a resource ID. This is typically used in a "Register" function, see 配准 .

// load a registered icon ("Cube") AutoBitmap cubeIcon(5159); BaseBitmap * const bitmap = cubeIcon; if (bitmap == nullptr ) return maxon::UnexpectedError( MAXON_SOURCE_LOCATION ); ShowBitmap (bitmap);

// load an image file in the plugin's "res" folder AutoBitmap localIcon( "icon.tif" _s); if (localIcon == nullptr ) return maxon::UnexpectedError( MAXON_SOURCE_LOCATION ); ShowBitmap (localIcon);

拷贝

The content of a BaseBitmap can be copied and with these functions:

• BaseBitmap::GetClone : Returns a clone of the BaseBitmap .
• BaseBitmap::GetClonePart : Returns a clone of the defined part of the BaseBitmap .
• BaseBitmap::CopyTo : Copies the image data into the given BaseBitmap .
• BaseBitmap::CopyPartTo : Copies the defined part of the image data into the given BaseBitmap .

// get original bitmap dimensions const Int32 width = sourceBitmap->GetBw(); const Int32 height = sourceBitmap->GetBh();

// calculate left half width const Int32 leftHalfWidth = width / 2;

// create clone with the left half of the bitmap BaseBitmap * leftBitmap = sourceBitmap-> GetClonePart (0, 0, leftHalfWidth, height); if (leftBitmap == nullptr ) return maxon::UnexpectedError( MAXON_SOURCE_LOCATION ); ShowBitmap (leftBitmap); BaseBitmap::Free (leftBitmap);

// create clone with the right half of the bitmap const Int32 rightHalfWidth = width - leftHalfWidth; BaseBitmap * rightBitmap = sourceBitmap-> GetClonePart (leftHalfWidth, 0, rightHalfWidth, height); if (rightBitmap == nullptr ) return maxon::UnexpectedError( MAXON_SOURCE_LOCATION ); ShowBitmap (rightBitmap); BaseBitmap::Free (rightBitmap);

Read-Only Properties

The basic properties of a BaseBitmap are accessed with:

• BaseBitmap::GetBw() : Returns the width of the BaseBitmap .
• BaseBitmap::GetBh() : Returns the height of the BaseBitmap .
• BaseBitmap::GetBt() : Returns the image depth in bits per pixel.
• BaseBitmap::GetBpz() : Returns the number of bytes per line.
• BaseBitmap::GetColorMode() : Returns the color mode, see ::COLORMODE. Do not confuse with COLORBYTES .
• BaseBitmap::GetMemoryInfo() : Returns the size of the memory used by the BaseBitmap .

// only handle 8-bit RGB bitmaps in this example const COLORMODE colorMode = bitmap-> GetColorMode (); if (colorMode != COLORMODE::RGB ) return maxon::IllegalArgumentError( MAXON_SOURCE_LOCATION );

// get bit depth and buffer size for one line const Int32 bitsPerPixel = bitmap-> GetBt (); const Int32 bytesPerPixel = bitsPerPixel / 8; const Int32 bufferSize = bitmap-> GetBpz ();

// allocate memory for one line PIX * lineBuffer = NewMemClear ( PIX , bufferSize) iferr_return ;

// get bitmap dimensions const Int32 width = bitmap-> GetBw (); const Int32 height = bitmap-> GetBh ();

// loop through all lines for ( Int32 y = 0; y <= height; ++y) { // read full line from the bitmap bitmap-> GetPixelCnt (0, y, width, lineBuffer, bytesPerPixel, COLORMODE::RGB , PIXELCNT::NONE );

// this is a custom function InvertLineRGB(lineBuffer, width);

// write full line back into the bitmap bitmap-> SetPixelCnt (0, y, width, lineBuffer, bytesPerPixel, COLORMODE::RGB , PIXELCNT::NONE ); }

// delete line memory DeleteMem (lineBuffer);

The used color profile is managed with:

• BaseBitmap::GetColorProfile() : Returns the used color profile.
• BaseBitmap::SetColorProfile() : Sets the used color profile.

另请参阅 ColorProfile and ColorProfileConvert .

// get linear workflow settings const BaseContainer & docData = doc-> GetDataInstanceRef (); const Bool linearWorkflow = docData. GetBool ( DOCUMENT_LINEARWORKFLOW );

// set profile if (linearWorkflow) _bitmap->SetColorProfile( ColorProfile::GetDefaultLinearRGB ()); else _bitmap->SetColorProfile( ColorProfile::GetDefaultSRGB ());

// draw bitmap using the profile const Int32 drawMode = BMP_APPLY_COLORPROFILE ; DrawBitmap(_bitmap, 0, 0, width, height, 0, 0, width, height, drawMode);

Functionality

Bitmap

The content of a BaseBitmap can be scaled into another BaseBitmap :

• BaseBitmap::ScaleIt() : Scales the image data and stores the result in the given BaseBitmap .
• BaseBitmap::ScaleBicubic() : Scales the image data using bicubic interpolation and stores the result in the given BaseBitmap .

警告

MultipassBitmap overwrites these functions. The overwritten functions will scale the layers but not the alpha channels.

// create new bitmap AutoAlloc<BaseBitmap> scaledBitmap; if (scaledBitmap == nullptr ) return maxon::OutOfMemoryError( MAXON_SOURCE_LOCATION );

// get source bitmap dimensions const Int32 originalWidth = sourceBitmap->GetBw(); const Int32 originalHeight = sourceBitmap->GetBh();

// initialize new bitmap with twice the size const Int32 scale = 2; const Int32 scaledWidth = originalWidth * scale; const Int32 scaledHeight = originalHeight * scale; const IMAGERESULT res = scaledBitmap-> Init (scaledWidth, scaledHeight); if (res != IMAGERESULT::OK ) return maxon::OutOfMemoryError( MAXON_SOURCE_LOCATION );

// fill new bitmap with scaled content of the source bitmap const Int32 defaultBrightness = 256; sourceBitmap->ScaleIt(scaledBitmap, defaultBrightness, true , false );

One can perform basic drawing operations with these functions:

• BaseBitmap::Clear() : Fills the BaseBitmap with the given color.
• BaseBitmap::SetPen() : Sets the color used with the following operations.
• BaseBitmap::Line() : Draws a line.
• BaseBitmap::Arc() : Draws an arc.

注意

For more advanced drawing operations use a GeClipMap ，见 GeClipMap Manual .

// fill the bitmap with white pixels bitmap-> 清零 (255, 255, 255);

// set the pen to black bitmap-> SetPen (0, 0, 0);

// draw lines bitmap-> Line (100, 100, 300, 100); bitmap-> Line (100, 200, 300, 200);

// draw arcs const Float quarterCircle = DegToRad (90.0); const Float threeQuarterCircle = DegToRad (270.0); bitmap-> Arc (300, 150, 50.0, quarterCircle, -quarterCircle, 20); bitmap-> Arc (100, 150, 50.0, quarterCircle, threeQuarterCircle, 20);

特性

A BaseBitmap is used as the target buffer of a rendering process. Details of that rendering process are stored with the bitmap itself and are displayed by the Picture Viewer. So these settings are mostly only relevant to the rendering pipeline were the given VPBuffer can be cast into a BaseBitmap / MultipassBitmap .

• BaseBitmap::GetData() : Returns the data for the given ID.
• BaseBitmap::SetData() : Sets the data for the given ID.

The settings are:

• BASEBITMAP_DATA_GUIPIXELRATIO : Pixel Ratio. Relevant for use with a BitmapButtonCustomGui ，见 GeDialog 手册 and GeUserArea Manual .
• BASEBITMAP_DATA_NAME
• BASEBITMAP_DATA_PROGRESS_TIME
• BASEBITMAP_DATA_PROGRESS_ACTION
• BASEBITMAP_DATA_PROGRESS_FRAME
• BASEBITMAP_DATA_PROGRESS_SEQ
• BASEBITMAP_DATA_PROGRESS_FNUM
• BASEBITMAP_DATA_DRAW_REGIONS
• BASEBITMAP_DATA_SPINMODE
• BASEBITMAP_DATA_HOLDTIME
• BASEBITMAP_DATA_STARTTIME
• BASEBITMAP_DATA_PROGRESS_PHASE : Rendering progress, see RENDERPROGRESSTYPE .
• BASEBITMAP_DATA_FRAMETIME
• BASEBITMAP_DATA_TEXTURE_ERROR

// get pixel ratio const Float pixelRatio = GetPixelRatio();

// check if Retina or not if (pixelRatio == 1.0) filename = "lowRes.png" ; else filename = "highRes.png" ;

// load bitmap (GetFullFilename() is just a custom utility function) const String fullFileName = GetFullFilename(filename); if (bitmap-> Init (fullFileName) == IMAGERESULT::OK ) { // store ratio bitmap-> SetData ( BASEBITMAP_DATA_GUIPIXELRATIO , pixelRatio);

// apply to BitmapButton bitmapButtonGUI-> SetImage (bitmap, true , false ); } } }

Dirty

A BaseBitmap stores an incremental dirty state that is used in some scenarios to indicate that the BaseBitmap has changed.

• BaseBitmap::GetDirty() : Returns the incremental dirty state.
• BaseBitmap::SetDirty() : Increments the dirty state.

// check dirty state UInt32 dirtyState = bitmap-> GetDirty (); ApplicationOutput ( "Dirty State: " + String::UIntToString (dirtyState));

// edit bitmap and make dirty bitmap-> 清零 (255, 255, 255); bitmap-> SetDirty ();

// check dirty state dirtyState = bitmap-> GetDirty (); ApplicationOutput ( "Dirty State: " + String::UIntToString (dirtyState));

Pixel Data

The internally stored bitmap data of a BaseBitmap can be accessed with:

• BaseBitmap::GetPixel() : Gets the RGB values for the given coordinates.
• BaseBitmap::SetPixel() : Sets the RGB values for the given coordinates.
• BaseBitmap::GetPixelCnt() : Copies the data of multiple pixel in a row into the given buffer.
• BaseBitmap::SetPixelCnt() : Copies the data of multiple pixels in a row from the given buffer into the BaseBitmap .

Typically used pixel formats can be defined with:

• PIX : 8-bit integer pixel type.
• PIX_C : 8-bit integer pixel type.
• PIX_W : 16-bit integer pixel type.
• PIX_F : 32-bit float pixel type.

另请参阅 COLORBYTES for macros defining bytes per pixel and ::COLORMODE for a definition of the color mode.

// define bitmap dimensions and bit depth const Int32 width = 1024; const Int32 height = 1024; const Int32 pixelBytes = COLORBYTES_RGBf ; // RGBf format const Int32 pixelBits = pixelBytes * 8;

// initialize the BaseBitmap with the given dimensions and bit depth const IMAGERESULT res = bitmap-> Init (width, height, pixelBits); if (res != IMAGERESULT::OK ) return maxon::OutOfMemoryError( MAXON_SOURCE_LOCATION );

// allocate memory for one line const Int32 bufferSize = width * 3; PIX_F * lineBuffer = NewMemClear ( PIX_F , bufferSize) iferr_return ;

// loop through all lines for ( Int32 y = 0; y <= height; ++y) { // shade of red based on the position const Float32 red = Float32 (y) / Float32 (height); Int32 offset = 0; for ( Int32 x = 0; x < width; ++x) { // shade of green based on the position const Float32 green = Float32 (x) / Float32 (width);

// fill buffer lineBuffer[offset] = red; lineBuffer[offset + 1] = green; lineBuffer[offset + 2] = 0.0; offset += 3; }

// write full line into the bitmap bitmap-> SetPixelCnt (0, y, width, ( UChar *)lineBuffer, pixelBytes, COLORMODE::RGBf , PIXELCNT::NONE ); }

// delete line memory DeleteMem (lineBuffer);

Alpha Channels

A BaseBitmap can contain up to four alpha channels. They are represented also with BaseBitmap instances:

• BaseBitmap::AddChannel() : Adds a new alpha channel.
• BaseBitmap::RemoveChannel() : Removes the given alpha channel.
• BaseBitmap::GetInternalChannel() : Returns the internal alpha channel.
• BaseBitmap::GetChannelCount() : Returns the number of alpha channels.
• BaseBitmap::GetChannelNum() : Returns the alpha channel with the given index.
• BaseBitmap::GetAlphaPixel() : Gets the alpha value from the given alpha channel and the given coordinates.
• BaseBitmap::SetAlphaPixel() : Sets the alpha value for the given alpha channel and the given coordinates.

// fill image bitmap-> 清零 (255, 255, 255);

// add alpha channel BaseBitmap * alphaChannel = bitmap-> AddChannel ( true , false ); if (alphaChannel) return maxon::OutOfMemoryError( MAXON_SOURCE_LOCATION );

// set alpha value for each pixel for ( Int32 x = 0; x < width; ++x) { for ( Int32 y = 0; y < height; ++y) { // create horizontal alpha gradient const Float alphaValueFloat = ( COLORTOINT_MULTIPLIER * Float (x)) / Float (width); const Int32 alphaValueInt = Int32 (alphaValueFloat); bitmap-> SetAlphaPixel (alphaChannel, x, y, alphaValueInt); } }

// save as PNG with alpha Filename saveImageFile; if (!saveImageFile. FileSelect ( FILESELECTTYPE::IMAGES , FILESELECT::SAVE , "Save as PNG" _s)) return maxon::OK ; const IMAGERESULT saveRes = bitmap-> Save (saveImageFile, FILTER_PNG , nullptr , SAVEBIT::ALPHA ); if (saveRes != IMAGERESULT::OK ) return maxon::IoError( MAXON_SOURCE_LOCATION , MaxonConvert (saveImageFile, MAXONCONVERTMODE::NONE ), "Could not save image file." _s);

转换

BaseBitmap is the base class of MultipassBitmap . If a pointer to a BaseBitmap is handed over one can check if it is actually a MultipassBitmap :

• BaseBitmap::IsMultipassBitmap() : Returns true if the BaseBitmap is a MultipassBitmap .

// select image file if (!selectedImageFile. FileSelect ( FILESELECTTYPE::IMAGES , FILESELECT::LOAD , "Select Image" _s)) return maxon::OK ;

// load image file BaseBitmap * bitmap = nullptr ; const IMAGERESULT result = BaseBitmap::Init (bitmap, selectedImageFile);

// check success if (result != IMAGERESULT::OK ) return maxon::IoError( MAXON_SOURCE_LOCATION , MaxonConvert (selectedImageFile, MAXONCONVERTMODE::NONE ), "Could not load image file." _s);

// check if it is a MultipassBitmap if (bitmap-> IsMultipassBitmap ()) { MultipassBitmap * const multipassBitmap = static_cast< MultipassBitmap * > (bitmap);

// get layer count const Int32 layerCount = multipassBitmap-> GetLayerCount (); ApplicationOutput ( "Layer Count: " + String::IntToString (layerCount)); } else { // no MultipassBitmap, no layers ApplicationOutput ( "No layers" ); } BaseBitmap::Free (bitmap);

A BaseBitmap also represents a maxon::ImageRef. This is obtained with:

• BaseBitmap::GetImageRef() : Returns the internally stored maxon::ImageRef. See Images Manual .

Disc I/O

A BaseBitmap can read the content of an image file and save its content to an image file.

• BaseBitmap::Init() : Loads the content of the given image file.
• BaseBitmap::Save() : Saves the bitmap data to the given image file.

// select an image file if (selectedImageFile. FileSelect ( FILESELECTTYPE::IMAGES , FILESELECT::LOAD , "Select Image File" _s)) return maxon::OK ; AutoAlloc<BaseBitmap> bitmap; if (bitmap == nullptr ) return maxon::OutOfMemoryError( MAXON_SOURCE_LOCATION );

// load image file into the given BaseBitmap if (bitmap-> Init (selectedImageFile) != IMAGERESULT::OK ) return maxon::IoError( MAXON_SOURCE_LOCATION , MaxonConvert (selectedImageFile, MAXONCONVERTMODE::NONE ), "Could not load image file." _s);

// save bitmap data in different formats

// if the original file is no JPEG, save as JPEG if (selectedImageFile. CheckSuffix ( "jpg" _s) == false ) { Filename jpgFileName = selectedImageFile; jpgFileName = GeFilterSetSuffix (jpgFileName, FILTER_JPG ); BaseContainer jpgSettings; jpgSettings. SetInt32 ( JPGSAVER_QUALITY , 80); if (bitmap-> Save (jpgFileName, FILTER_JPG , &jpgSettings, SAVEBIT::NONE ) != IMAGERESULT::OK ) return maxon::IoError( MAXON_SOURCE_LOCATION , maxon::Url (jpgFileName. GetString ()), "Could not save image file." _s); }

// if the original file is no PNG, save as PNG if (selectedImageFile. CheckSuffix ( "png" _s) == false ) { Filename pngFileName = selectedImageFile; pngFileName = GeFilterSetSuffix (pngFileName, FILTER_PNG ); if (bitmap-> Save (pngFileName, FILTER_PNG , nullptr , SAVEBIT::NONE ) != IMAGERESULT::OK ) return maxon::IoError( MAXON_SOURCE_LOCATION , MaxonConvert (pngFileName, MAXONCONVERTMODE::NONE ), "Could not save image file." _s); }

注意

An alternative way of loading image files is to use SendPainterCommand() with PAINTER_LOADTEXTURE .

A BaseBitmap can also be stored in a HyperFile using:

• HyperFile::ReadImage() : Gets the BaseBitma from the HyperFile .
• HyperFile::WriteImage() : Writes the BaseBitmpa into the HyperFile .

显示

A BaseBitmap or MultipassBitmap can easily displayed in the Picture Viewer:

• ShowBitmap() : Opens the Picture Viewer to display a copy of the given BaseBitmap .

// select image file if (!selectedImageFile. FileSelect ( FILESELECTTYPE::IMAGES , FILESELECT::LOAD , "Select Image" _s)) return maxon::OK ; AutoAlloc<BaseBitmap> bitmap; if (bitmap == nullptr ) return maxon::OutOfMemoryError( MAXON_SOURCE_LOCATION );

// load image file into the given BaseBitmap if (bitmap-> Init (selectedImageFile) != IMAGERESULT::OK ) return maxon::IoError( MAXON_SOURCE_LOCATION , MaxonConvert (selectedImageFile, MAXONCONVERTMODE::NONE ), "Could not load image file." _s);

// show BaseBitmap in the Picture Viewer ShowBitmap (bitmap);

延伸阅读

• 文件 & 媒体
• Classic API Files & Media
• MultipassBitmap Manual
• GeClipMap Manual