Hot Door CORE  0.7.0
Adobe® Illustrator® Plug-in Library
Classes | Public Types | Public Member Functions | Friends | List of all members
hdi::core::RasterArt Class Reference

Allows for raster art manipulation, metadata access, etc. More...

#include <hdicoreRasterArt.h>

Classes

struct  Record
 Describes more detailed information about raster art. More...
 

Public Types

enum  Flags { UnknownFlag = 0, MaskImageFlag = 1 << 0, InvertBitsFlag = 1 << 1, GraySubtractiveFlag = 1 << 2 }
 Describes raster art options.
 
enum  ColorSpace {
  UnknownColorSpace = 0, GrayColorSpace = 1, RGBColorSpace = 2, CMYKColorSpace = 3,
  LabColorSpace = 4, SeparationColorSpace = 5, NChannelColorSpace = 6, IndexedColorSpace = 7,
  ColorSpaceHasAlpha = 0x10, AlphaGrayColorSpace = (GrayColorSpace | ColorSpaceHasAlpha), AlphaRGBColorSpace = (RGBColorSpace | ColorSpaceHasAlpha), AlphaCMYKColorSpace = (CMYKColorSpace | ColorSpaceHasAlpha),
  AlphaLabColorSpace = (LabColorSpace | ColorSpaceHasAlpha), AlphaSeparationColorSpace = (SeparationColorSpace | ColorSpaceHasAlpha), AlphaNChannelColorSpace = (NChannelColorSpace | ColorSpaceHasAlpha), AlphaIndexedColorSpace = (IndexedColorSpace | ColorSpaceHasAlpha),
  InvalidColorSpace = 0xFF
}
 Describes raster art color spaces.
 

Public Member Functions

 ~RasterArt ()
 Destructs a RasterArt object. More...
 
Record info () const
 Retrieves the raster record associated with a raster art object. More...
 
void setInfo (const Record &rec_)
 Associates a raster record with a raster art object. More...
 
std::string filePath () const
 Gets the file path for the raster art. More...
 
void setFilePath (const std::string &path_)
 Sets the file path for the raster art. More...
 
core::TransformMatrix matrix () const
 Retrieves the transformation matrix for a raster art object. This is the concatenation of all transforms applied to the image after it was created. It typically contains at least the initial translation and a scale. More...
 
void setMatrix (const core::TransformMatrix &matrix_)
 Sets the transformation matrix for a raster art object. More...
 
core::ArtboardRect bounds () const
 Retrieves the raster image bounding box of a raster art object. More...
 
void setBounds (const core::ArtboardRect &b_)
 Sets the raster image bounding box of a raster art object. More...
 
bool overprint () const
 Retrieves the overprint status for a raster object. More...
 
void setOverprint (const bool op_)
 Enables or disables overprinting for a raster object. More...
 
bool colorized (bool &additive__) const
 Gets whether a raster object is a colorized grayscale or bitmap image. More...
 
void clearColorization ()
 Clears the colorization on a colorized grayscale or bitmap image. More...
 

Friends

class Art
 

Detailed Description

Allows for raster art manipulation, metadata access, etc.

Constructor & Destructor Documentation

hdi::core::RasterArt::~RasterArt ( )

Destructs a RasterArt object.

Author
GW
Date
08/2014

Member Function Documentation

core::ArtboardRect hdi::core::RasterArt::bounds ( ) const

Retrieves the raster image bounding box of a raster art object.

Author
GW
Date
08/2014
Returns
The bounding rect
void hdi::core::RasterArt::clearColorization ( )

Clears the colorization on a colorized grayscale or bitmap image.

Author
GW
Date
08/2014
bool hdi::core::RasterArt::colorized ( bool &  additive__) const

Gets whether a raster object is a colorized grayscale or bitmap image.

Author
GW
Date
08/2014
Parameters
additive__Return-by-reference for whether the raster should be interpreted as additive
Returns
true if the raster is a colorized grayscale or bitmap image
std::string hdi::core::RasterArt::filePath ( ) const

Gets the file path for the raster art.

Author
GW
Date
08/2014
Returns
The file path as UTF-8, or "" for error
Record hdi::core::RasterArt::info ( ) const

Retrieves the raster record associated with a raster art object.

Author
GW
Date
08/2014
Returns
The raster record for the art
core::TransformMatrix hdi::core::RasterArt::matrix ( ) const

Retrieves the transformation matrix for a raster art object. This is the concatenation of all transforms applied to the image after it was created. It typically contains at least the initial translation and a scale.

Author
GW
Date
08/2014
Returns
The transformation matrix for the placed art
bool hdi::core::RasterArt::overprint ( ) const

Retrieves the overprint status for a raster object.

Author
GW
Date
08/2014
Returns
true if overprint is enabled, false if it is disabled
void hdi::core::RasterArt::setBounds ( const core::ArtboardRect b_)

Sets the raster image bounding box of a raster art object.

Author
GW
Date
08/2014
Parameters
b_The new bounding box
void hdi::core::RasterArt::setFilePath ( const std::string &  path_)

Sets the file path for the raster art.

Author
GW
Date
08/2014
Parameters
path_New file path, as UTF-8
void hdi::core::RasterArt::setInfo ( const Record rec_)

Associates a raster record with a raster art object.

Author
GW
Date
08/2014
Parameters
rec_The new raster record
void hdi::core::RasterArt::setMatrix ( const core::TransformMatrix matrix_)

Sets the transformation matrix for a raster art object.

Author
GW
Date
08/2014
Parameters
matrix_New transformation matrix
Note
All raster data is internally kept at 72 ppi and uses the object's scale to set a resolution.
void hdi::core::RasterArt::setOverprint ( const bool  op_)

Enables or disables overprinting for a raster object.

Author
GW
Date
08/2014
Parameters
op_True to enable overprint, false to disable it