WT_Plot_Info Class Reference
[Support objects]

#include <plotinfo.h>

Inheritance diagram for WT_Plot_Info:

Inheritance graph
[legend]
Collaboration diagram for WT_Plot_Info:

Collaboration graph
[legend]
List of all members.

Detailed Description

Contains information relating the WHIP! drawing coordinate space to plotting (paper) space.

Deprecated:
The information contained in the WT_Plot_Info object should be specified instead in the DWF 06.00 (and greater) DWFEPlot::EPlotPaper and DWFEPlot::EPlotGraphicResource objects. This remains in the toolkit only for backward compatability with previous DWF versions.
Note:
The serialization of this opcode should be deferred until just prior to the first drawable.

Definition at line 38 of file plotinfo.h.

Public Types

enum  WT_Paper_Units { , Count, Undefined = -1 }
 Indicates the units in which the paper (or virtual paper) is described. More...

Public Member Functions

 WT_Plot_Info ()
 Constructs a WT_Plot_Info object.
virtual ~WT_Plot_Info ()
WT_Booleanfor_display ()
 Returns a writable accessor to the flag specifying if the paper graphic should be shown by a viewing application.
const WT_Booleanfor_display () const
 Returns WD_True if the paper graphic should be shown by a viewing application.
WT_Point2Dlower_left ()
 Returns a writable accessor to the vector, in in paper units, from the lower-left corner of the paper to the lower-left boundary of the printable area.
const WT_Point2Dlower_left () const
 Returns a vector, in in paper units, from the lower-left corner of the paper to the lower-left boundary of the printable area.
double & paper_height ()
 Returns a writable accessor to the paper height (in paper units.).
const double & paper_height () const
 Returns the paper height (in paper units.).
WT_Paper_Unitspaper_units ()
 Returns a writable accessor to the paper units (one of enum WT_Paper_Units.).
const WT_Paper_Unitspaper_units () const
 Returns the paper units (one of enum WT_Paper_Units.).
double & paper_width ()
 Returns a writable accessor to the paper width (in paper units.).
const double & paper_width () const
 Returns the paper width (in paper units.).
const long & rotation () const
 Returns a writable accessor to the rotation angle (in degrees, one of 0, 90, 180, 270.).
long & rotation ()
 Returns a the pre-applied rotation angle (in degrees, one of 0, 90, 180, 270, typically portrait==0 or landscape==90.).
WT_Matrix2Dto_paper ()
 Returns a writable accessor to the 3x3 matrix which facilitates transforming DWF coordinate space to paper coordinate space.
const WT_Matrix2Dto_paper () const
 Returns the 3x3 matrix which facilitates transforming DWF coordinate space to paper coordinate space.
WT_Point2Dupper_right ()
 Returns a writable accessor to the vector, in in paper units, from the upper-right corner of the paper to the upper-right boundary of the printable area.
const WT_Point2Dupper_right () const
 Returns the vector, in in paper units, from the upper-right corner of the paper to the upper-right boundary of the printable area.
WT_Result materialize (const WT_Opcode &opcode, WT_File &file)
 Materializes the contents of the object from the file and the given opcode.
WT_ID object_id () const
 Returns the WT_ID for this object.
WT_Type object_type () const
 Returns the WT_Type for this object.
WT_Result process (WT_File &file)
 Calls the configured action handler for this object (passes in the file reference.).
virtual WT_Result serialize (WT_File &file) const
 Causes the serialization of the object to the file.

Static Public Member Functions

static WT_Result default_process (WT_Plot_Info &item, WT_File &file)
 Provides a default action handler for this object.

Protected Types

enum  WT_Materialize_Stage

Protected Attributes

double m_height
double m_width
WT_Point2D m_ll
WT_Point2D m_ur
WT_Matrix2D m_dwf2paper
WT_Paper_Units m_units
WT_Boolean m_show
WT_String m_temp_string
long m_rotation


Member Enumeration Documentation

enum WT_Plot_Info::WT_Paper_Units
 

Indicates the units in which the paper (or virtual paper) is described.

Enumerator:
Count  Not a unit. Should be the number of unit types + 1.
Undefined  Not a unit.

Definition at line 43 of file plotinfo.h.


Member Function Documentation

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

Provides a default action handler for this object.

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

WT_Result WT_Plot_Info::materialize const WT_Opcode 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_Plot_Info::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.

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

Causes the serialization of the object to the file.

If this is a WT_Drawable derived object, this method may cause the object to be delayed (in case a coincident like-object follows) and/or merged (in case a coincident like-object preceeded) so as to optimize the output.

Return values:
WT_Result::Success The operation was successful.

Implements WT_Object.


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