WT_Plot_Optimized Class Reference
[Rendering attributes]

#include <plot_optimized.h>

Inheritance diagram for WT_Plot_Optimized:

Inheritance graph
[legend]
Collaboration diagram for WT_Plot_Optimized:

Collaboration graph
[legend]
List of all members.

Detailed Description

Indicates whether the output was intended for plotting or for viewing.

This gives the WHIP! authors the ability to specify whether the graphics have been optimized for display or plotting. Rendering applications should honor this setting and take full advantage of the nature of the WHIP! data while plotting or displaying the drawables. When the data is optimized for plotting, the WHIP! data author should store enough data to allow full fidelity plots at the selected resolution and color depth. When the data is optimized for display, allow for much deeper zooms.

See also:
WT_Rendering_Options

Definition at line 43 of file plot_optimized.h.

Public Member Functions

 WT_Plot_Optimized ()
 Constructs a WT_Plot_Optimized object.
 WT_Plot_Optimized (WT_Boolean plot_optimized)
 Constructs a WT_Plot_Optimized object with the given state.
 WT_Plot_Optimized (WT_Plot_Optimized const &other)
 Copy Constructor.
virtual ~WT_Plot_Optimized ()
WT_Boolean get_plot_optimized () const
 Returns true if the data has been optimized for plotting.
void set_plot_optimized (WT_Boolean const &plot_optimized)
 Sets whether the data has been optimized for plotting.
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_Plot_Optimized &item, WT_File &file)
 Provides a default action handler for this attribute (e.g. sets the current rendition's corresponding attribute.).

Friends

class WT_Rendering_Options
class WT_W2D_Class_Factory
class WT_Opcode


Member Function Documentation

static WT_Result WT_Plot_Optimized::default_process WT_Plot_Optimized 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_Plot_Optimized::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_Plot_Optimized::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_Plot_Optimized::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.

WT_Result WT_Plot_Optimized::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_Plot_Optimized::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.


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