pCon.planner Plugin SDK  Version 8.8.1
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Properties Events
Public Member Functions | Properties | List of all members
X3g::Plugin::IImage Class Reference

Wraps an object of class Image. More...

Public Member Functions

virtual bool Equals (System::Object^ pOther) override
 Returns only true if the given Object is of Image type and delivers the same hash. More...
 
virtual int GetHashCode () override
 Returns the 32 bit hash of the image. More...
 
System::Int64 GetHashCode64 ()
 Returns the 64 bit hash of the image. More...
 
bool IsTransparent ()
 Returns true if the image has transparent pixels. More...
 
bool WriteToFile (System::String^ pFileName)
 Writes the image to file. More...
 
Bitmap^ ToBitmap ()
 Converts image to a GDI+ bitmap. More...
 
array< unsigned char >^ GetData ()
 Returns raw image data. More...
 

Properties

String^  FileName [get]
 Returns the source filename of the image. More...
 
int Width [get]
 Width of the image in pixels. More...
 
int Height [get]
 Height of the image in pixels. More...
 
PixelFormat Format [get]
 Pixel format of the image. More...
 
int BitsPerPixel [get]
 Number of bits per pixel. More...
 
Image^  ActualImage [get]
 Returns the actual image which is wrapped by this. More...
 

Detailed Description

Wraps an object of class Image.

Needed for legacy reasons.

Member Function Documentation

bool X3g::Plugin::IImage::Equals ( System::Object^  pOther)
overridevirtual

Returns only true if the given Object is of Image type and delivers the same hash.

Otherwise the result is false.

array< unsigned char > X3g::Plugin::IImage::GetData ( )

Returns raw image data.

int X3g::Plugin::IImage::GetHashCode ( )
overridevirtual

Returns the 32 bit hash of the image.

System::Int64 X3g::Plugin::IImage::GetHashCode64 ( )

Returns the 64 bit hash of the image.

bool X3g::Plugin::IImage::IsTransparent ( )

Returns true if the image has transparent pixels.

System::Drawing::Bitmap X3g::Plugin::IImage::ToBitmap ( )

Converts image to a GDI+ bitmap.

bool X3g::Plugin::IImage::WriteToFile ( System::String^  pFileName)

Writes the image to file.

Property Documentation

Image^ X3g::Plugin::IImage::ActualImage
get

Returns the actual image which is wrapped by this.

int X3g::Plugin::IImage::BitsPerPixel
get

Number of bits per pixel.

String^ X3g::Plugin::IImage::FileName
get

Returns the source filename of the image.

PixelFormat X3g::Plugin::IImage::Format
get

Pixel format of the image.

int X3g::Plugin::IImage::Height
get

Height of the image in pixels.

int X3g::Plugin::IImage::Width
get

Width of the image in pixels.