WT_PenPat_Options Class Reference
[Rendering attributes]

#include <penpat_options.h>

Inheritance diagram for WT_PenPat_Options:

Inheritance graph
[legend]
Collaboration diagram for WT_PenPat_Options:

Collaboration graph
[legend]
List of all members.

Detailed Description

Options for use with WT_Pen_Pattern object.

See also:
WT_Rendering_Options

Definition at line 32 of file penpat_options.h.

Public Member Functions

 WT_PenPat_Options ()
 Constructs a WT_PenPat_Options object.
 WT_PenPat_Options (WT_Boolean const scale_pen_width, WT_Boolean const map_colors_to_gray_scale, WT_Boolean const use_alternate_fill_rule, WT_Boolean const use_error_diffusion_for_DWF_Rasters)
 Constructs a WT_PenPat_Options object with the given data.
 WT_PenPat_Options (WT_PenPat_Options const &other)
 Constructs a WT_PenPat_Options object. Copy constructor.
virtual ~WT_PenPat_Options ()
WT_Boolean const get_map_colors_to_gray_scale () const
 Returns the state of the map_colors_to_gray_scale setting.
WT_Boolean const get_scale_pen_width () const
 Returns the state of the scale_pen_width setting.
WT_Boolean const get_use_alternate_fill_rule () const
 Returns the state of the use_alternate_fill_rule setting.
WT_Boolean const get_use_error_diffusion_for_DWF_Rasters () const
 Returns the state of the use_error_diffusion_for_DWF_Rasters setting.
void set_map_colors_to_gray_scale (WT_Boolean map_colors_to_gray_scale)
 Sets the map_colors_to_gray_scale setting.
void set_scale_pen_width (WT_Boolean scale_pen_width)
 Sets the scale_pen_width setting.
void set_use_alternate_fill_rule (WT_Boolean use_alternate_fill_rule)
 Sets the use_alternate_fill_rule setting.
void use_error_diffusion_for_DWF_Rasters (WT_Boolean use_error_diffusion_for_DWF_Rasters)
 Sets the use_error_diffusion_for_DWF_Rasters setting.
virtual WT_PenPat_Options
const & 
operator= (WT_PenPat_Options const &options)
 Assignment operator. Assigns the given options object's contents to this one.
WT_ID object_id () const
 Returns the WT_ID for this object.
WT_Result materialize (WT_Opcode const &opcode, WT_File &file)
 Materializes the contents of the object from the file and the given opcode.
WT_Result process (WT_File &file)
 Calls the configured action handler for this object (passes in the file reference.).
WT_Result skip_operand (WT_Opcode const &opcode, WT_File &file)
 Causes the file reading to proceed to the end of this object.
WT_Result serialize (WT_File &file) const
 Forces the serialization of the object to the file.
WT_Result sync (WT_File &file) const
 Serializes the attribute out to the file, if necessary.
WT_Boolean operator== (WT_Attribute const &attrib) const
 Returns WD_True if the attributes are equal.

Static Public Member Functions

static WT_Result default_process (WT_PenPat_Options &item, WT_File &file)
 Provides a default action handler for this attribute (e.g. sets the current rendition's corresponding attribute.).

Protected Types

enum  

Protected Attributes

WT_Boolean m_scale_pen_width
WT_Boolean m_map_colors_to_gray_scale
WT_Boolean m_use_alternate_fill_rule
WT_Boolean m_use_error_diffusion_for_DWF_Rasters

Friends

class WT_Rendering_Options
class WT_W2D_Class_Factory
class WT_Opcode


Member Function Documentation

static WT_Result WT_PenPat_Options::default_process WT_PenPat_Options item,
WT_File file
[static]
 

Provides a default action handler for this attribute (e.g. sets the current rendition's corresponding attribute.).

Warning:
This is used by the framework and should not be called by client code.
Parameters:
item  The attribute to process.
file  The file being read.

WT_Result WT_PenPat_Options::materialize WT_Opcode const &  opcode,
WT_File file
[virtual]
 

Materializes the contents of the object from the file and the given opcode.

Reads in the object data and causes the file reading to proceed to the end of this object.

Warning:
This is used by the framework and should not be called by client code.
Return values:
WT_Result::Success The operation was successful.
WT_Result::Opcode_Not_Valid_For_This_Object The object does not support the opcode type.
WT_Result::Internal_Error Something went very wrong.

Implements WT_Object.

WT_Result WT_PenPat_Options::process WT_File file  )  [virtual]
 

Calls the configured action handler for this object (passes in the file reference.).

Warning:
This is used by the framework and should not be called by client code.

Implements WT_Object.

WT_Result WT_PenPat_Options::serialize WT_File file  )  const [virtual]
 

Forces the serialization of the object to the file.

Warning:
This is used by the framework and should not be called by client code.
Return values:
WT_Result::Success The operation was successful.

Implements WT_Attribute.

void WT_PenPat_Options::set_map_colors_to_gray_scale WT_Boolean  map_colors_to_gray_scale  )  [inline]
 

Sets the map_colors_to_gray_scale setting.

If true, this will cause colors to be rendered as gray scale, using the configured screening patterns.

Definition at line 103 of file penpat_options.h.

void WT_PenPat_Options::set_scale_pen_width WT_Boolean  scale_pen_width  )  [inline]
 

Sets the scale_pen_width setting.

If true, and if the WHIP! data is plotted on a paper size other than that for which it was originally created for, then pen widths will be enlarged or reduced in proportion to the two paper sizes.

Definition at line 107 of file penpat_options.h.

WT_Result WT_PenPat_Options::skip_operand WT_Opcode const &  opcode,
WT_File file
[virtual]
 

Causes the file reading to proceed to the end of this object.

Warning:
This is used by the framework and should not be called by client code.
Bug:
Not all objects perform skip_operand() correctly; this is a known problem. For best results, if client code must use WT_File::get_next_object_shell() manually, it should also call the corresponding WT_Object::materialize() method to avoid this problem.
See also:
WT_File::get_next_object_shell(), WT_File_Heuristics::set_deferred_delete().

Reimplemented from WT_Object.

WT_Result WT_PenPat_Options::sync WT_File file  )  const [virtual]
 

Serializes the attribute out to the file, if necessary.

Only outputs relevant desired rendition changes to the file.

Warning:
This is used by the framework and should not be called by client code.
Return values:
WT_Result::Success The operation was successful.
See also:
WT_File::desired_rendition().

Implements WT_Attribute.

void WT_PenPat_Options::use_error_diffusion_for_DWF_Rasters WT_Boolean  use_error_diffusion_for_DWF_Rasters  )  [inline]
 

Sets the use_error_diffusion_for_DWF_Rasters setting.

If true, error diffusion will be used instead of ordered dithering (if dithering is necessary to render any rasters embedded in the WHIP! data.)

Definition at line 113 of file penpat_options.h.


The documentation for this class was generated from the following file:
Generated on Tue Jan 6 22:41:24 2009 for Autodesk DWF Whip 2D Toolkit by  doxygen 1.4.5