pdftron::PDF::ColorPt Class Reference

ColorPt is an array of colorants (or tint values) representing a color point in an associated color space. More...

#include <ColorSpace.h>

List of all members.

Public Member Functions

 ColorPt (double x=0, double y=0, double z=0, double w=0)
 Constructors and destructor.
 ColorPt (const ColorPt &co)
 ~ColorPt ()
ColorPtoperator= (const ColorPt &co)
bool operator== (const ColorPt &co) const
void Set (double x=0, double y=0, double z=0, double w=0)
 A utility method to set the first 4 tint values.
void Set (int colorant_index, double colorant_value)
 Sets a tint value at a given colorant index.
double Get (int colorant_index) const
void SetColorantNum (int num)
 If a color point has more than 4 colorants, SetColorantNum(num_colorants) must be called before getting or setting tint values.


Detailed Description

ColorPt is an array of colorants (or tint values) representing a color point in an associated color space.

Constructor & Destructor Documentation

pdftron::PDF::ColorPt::ColorPt ( double  x = 0,
double  y = 0,
double  z = 0,
double  w = 0 
) [explicit]

Constructors and destructor.

pdftron::PDF::ColorPt::ColorPt ( const ColorPt co  ) 

pdftron::PDF::ColorPt::~ColorPt (  ) 


Member Function Documentation

ColorPt& pdftron::PDF::ColorPt::operator= ( const ColorPt co  ) 

bool pdftron::PDF::ColorPt::operator== ( const ColorPt co  )  const

void pdftron::PDF::ColorPt::Set ( double  x = 0,
double  y = 0,
double  z = 0,
double  w = 0 
)

A utility method to set the first 4 tint values.

For example, color.Set(red, green, blue) will initialize the ColorPt to given tint values.

Note:
All colorants should be in the range [0..1].

color.Set(gray) is equivalent to Set(0, gray);

void pdftron::PDF::ColorPt::Set ( int  colorant_index,
double  colorant_value 
)

Sets a tint value at a given colorant index.

Parameters:
colorant_index the color index. For example, for a color point associated with a Gray color space the only allowed value for index is 0. For a color point associated with a CMYK color space, the color_index can range from 0 (cyan) to 4 (black).
colorant_value The new tint value.
For example, the following snippet will initialize the color point to [red, green, blue]:
 color.SetColorantNum(3);
 color.Set(0, red);
 color.Set(1, green);
 color.Set(2, blue);

The above code snippet is equivalent to the following line: color.Set(red, green, blue)

Note:
If a color point has more than 4 colorants, SetColorantNum(num_colorants) must be called before getting or setting tint values.

double pdftron::PDF::ColorPt::Get ( int  colorant_index  )  const

Returns:
the tint value at a given colorant index.
The number of colorants depends on the associated color space. To find how many colorant are associated with a given color space use color_space.GetComponentNum().

For example, if you have a color point in the RGB color space you can extract its colorants as follows:

 UInt8 rgb[3] = { UInt8(c.Get(0)*255), UInt8(c.Get(1)*255), UInt8(c.Get(2)*255) }; 

void pdftron::PDF::ColorPt::SetColorantNum ( int  num  ) 

If a color point has more than 4 colorants, SetColorantNum(num_colorants) must be called before getting or setting tint values.

The number of colorants depends on the associated color space. To find how many colorant are associated with a given color space use color_space.GetComponentNum().


© 2002-2010 PDFTron Systems Inc.