Support objects


Classes

class  WT_Compressed_Data_Moniker
 Indicates the start of a compressed block of data. For use by the compression classes. More...
class  WT_Embed
 Allows the source file from which the WHIP! data was created to be embedded (or referenced) inside the WHIP! data. More...
class  WT_Embedded_Font
 Contains an embedded font as defined and/or created by the Microsoft OpenType Font Embedding SDK. More...
class  WT_End_Of_DWF
 Indicates the end of the WHIP! data. More...
class  WT_Group_Begin
 Specifies the start of a group of objects. More...
class  WT_Group_End
 Specifies the end of a group of objects. More...
class  WT_Named_View
 An object which defines a rectangular view associated with a string name. More...
class  WT_Origin
 An absolute point in drawing coordinates used to reset the relative coordinate processing. More...
class  WT_Plot_Info
 Contains information relating the WHIP! drawing coordinate space to plotting (paper) space. More...
class  WT_SignData
 Holds raw digital signature data related to a collection of BlockRefs. More...
class  WT_Trusted_Font_List
 A linked list of WT_Trusted_Font_Item objects. More...
class  WT_Trusted_Font_Item
 A single trusted font contained in a WT_Trusted_Font_List object. More...
class  WT_Units
 Stores the transform between source (authoring tool) coordinate space and WHIP! drawing coordinate space. More...
class  WT_UserData
 An object containing user-defined data. More...
WT_String const & WT_Group_Begin::group_path ()
 Returns the group path name.
WT_Result WT_Group_Begin::materialize (WT_Opcode const &opcode, WT_File &file)
 Materializes the contents of the object from the file and the given opcode.
WT_ID WT_Group_Begin::object_id () const
 Returns the WT_ID for this object.
WT_Type WT_Group_Begin::object_type () const
 Returns the WT_Type for this object.
WT_Result WT_Group_Begin::process (WT_File &file)
 Calls the configured action handler for this object (passes in the file reference.).
WT_Result WT_Group_Begin::serialize (WT_File &file) const
 Causes the serialization of the object to the file.
WT_Result WT_Group_Begin::skip_operand (WT_Opcode const &opcode, WT_File &file)
 Causes the file reading to proceed to the end of this object.
WT_Result WT_Group_End::materialize (WT_Opcode const &opcode, WT_File &file)
 Materializes the contents of the object from the file and the given opcode.
WT_ID WT_Group_End::object_id () const
 Returns the WT_ID for this object.
WT_Type WT_Group_End::object_type () const
 Returns the WT_Type for this object.
WT_Result WT_Group_End::process (WT_File &file)
 Calls the configured action handler for this object (passes in the file reference.).
WT_Result WT_Group_End::serialize (WT_File &file) const
 Causes the serialization of the object to the file.
WT_Result WT_Group_End::skip_operand (WT_Opcode const &opcode, WT_File &file)
 Causes the file reading to proceed to the end of this object.
WT_Matrix const & WT_Units::application_to_dwf_transform () const
 Returns a transform which converts from source (authoring tool) coordinates to WHIP! coordinates.
WT_Matrix const & WT_Units::dwf_to_application_adjoint_transform ()
 Returns a transform which converts from WHIP! coordinates to source (authoring tool) coordinates.
void WT_Units::set_application_to_dwf_transform (WT_Matrix const &xform)
 Sets the transform which converts from source (authoring tool) coordinates to WHIP! coordinates.
void WT_Units::set_units (WT_String const &units)
 Sets the string describing the source unit of measure.
void WT_Units::set_units (int length, WT_Unsigned_Integer16 const *units)
 Sets the string describing the source unit of measure from the given string buffer.
WT_String const & WT_Units::units () const
 Returns the string describing the source unit of measure.
WT_Point3D WT_Units::transform (WT_Logical_Point const &in_pt)
 Transforms the given point from WHIP! coordinates to source (authoring tool) coordinates.
WT_Logical_Point WT_Units::transform (WT_Point3D const &in_pt) const
 Transforms the given point from source (authoring tool) coordinates to WHIP! coordinates.
WT_Point3D WT_Units::transform_from_DWF_to_application (WT_Point3D const &in_pt)
 Transforms the given point from WHIP! coordinates to source (authoring tool) coordinates.
WT_Point3D WT_Units::transform_from_application_to_DWF (WT_Point3D const &in_pt) const
 Transforms the given point from source (authoring tool) coordinates to WHIP! coordinates.
WT_Result WT_Units::materialize (WT_Opcode const &opcode, WT_File &file)
 Materializes the contents of the object from the file and the given opcode.
WT_Object::WT_ID WT_Units::object_id () const
 Returns the WT_ID for this object.
WT_Object::WT_Type WT_Units::object_type () const
 Returns the WT_Type for this object.
WT_Result WT_Units::process (WT_File &file)
 Calls the configured action handler for this object (passes in the file reference.).
WT_Result WT_Units::serialize (WT_File &file) const
 Causes the serialization of the object to the file.
WT_Result WT_Units::skip_operand (WT_Opcode const &opcode, WT_File &file)
 Causes the file reading to proceed to the end of this object.

Functions

 WT_Compressed_Data_Moniker::WT_Compressed_Data_Moniker (int format=REVISION_WHEN_ZLIB_COMPRESSION_IS_SUPPORTED)
 Constructs a WT_Compressed_Data_Moniker object.
virtual WT_Compressed_Data_Moniker::~WT_Compressed_Data_Moniker ()
 Destroys a WT_Compressed_Data_Moniker object.
 WT_Embed::WT_Embed ()
 Constructs a WT_Embed object.
 WT_Embed::WT_Embed (WT_Embed const &embed)
 Constructs a WT_Embed object. Copy constructor.
 WT_End_Of_DWF::WT_End_Of_DWF ()
 Constructs a WT_End_Of_DWF object.
 WT_Group_Begin::WT_Group_Begin ()
 Constructs a WT_Group_Begin object.
 WT_Group_Begin::WT_Group_Begin (WT_String path_name)
 Constructs a WT_Group_Begin object with the given group path name.
virtual WT_Group_Begin::~WT_Group_Begin ()
static WT_Result WT_Group_Begin::default_process (WT_Group_Begin &item, WT_File &file)
 Provides a default action handler for this object.
 WT_Group_End::WT_Group_End ()
 Constructs a WT_Group_End object.
virtual WT_Group_End::~WT_Group_End ()
static WT_Result WT_Group_End::default_process (WT_Group_End &item, WT_File &file)
 Provides a default action handler for this object.
 WT_Origin::WT_Origin ()
 Constructs a WT_Origin object.
 WT_Origin::WT_Origin (WT_Logical_Point const &point)
 Constructs a WT_Origin object with the given point.
virtual WT_Origin::~WT_Origin ()
 WT_Plot_Info::WT_Plot_Info ()
 Constructs a WT_Plot_Info object.
 WT_Units::WT_Units ()
 Constructs a WT_Units object.
 WT_Units::WT_Units (WT_Matrix const &xform, WT_String units)
 Constructs a WT_Units object with the given data.
 WT_Units::WT_Units (WT_Units const &units)
 Copy Constructor.
virtual WT_Units::~WT_Units ()
WT_Boolean WT_Units::operator== (WT_Units const &) const
 Returns WD_True if the unit objects are equal.
WT_Boolean WT_Units::operator!= (WT_Units const &u) const
 Returns WD_True if the unit objects are NOT equal.
static WT_Result WT_Units::default_process (WT_Units &item, WT_File &file)
 Provides a default action handler for this object.


Function Documentation

static WT_Result WT_Units::default_process WT_Units item,
WT_File file
[static, inherited]
 

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.

static WT_Result WT_Group_End::default_process WT_Group_End item,
WT_File file
[static, inherited]
 

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.

static WT_Result WT_Group_Begin::default_process WT_Group_Begin item,
WT_File file
[static, inherited]
 

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_Units::materialize WT_Opcode const &  opcode,
WT_File file
[virtual, inherited]
 

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_Group_End::materialize WT_Opcode const &  opcode,
WT_File file
[virtual, inherited]
 

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_Group_Begin::materialize WT_Opcode const &  opcode,
WT_File file
[virtual, inherited]
 

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_Units::process WT_File file  )  [virtual, inherited]
 

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_Group_End::process WT_File file  )  [virtual, inherited]
 

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_Group_Begin::process WT_File file  )  [virtual, inherited]
 

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_Units::serialize WT_File file  )  const [virtual, inherited]
 

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.

WT_Result WT_Group_End::serialize WT_File file  )  const [virtual, inherited]
 

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.

WT_Result WT_Group_Begin::serialize WT_File file  )  const [virtual, inherited]
 

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.

void WT_Units::set_units int  length,
WT_Unsigned_Integer16 const *  units
[inherited]
 

Sets the string describing the source unit of measure from the given string buffer.

Although optional, if applicable the units description should follow convention and be one of the following (non-localized) strings:

  • millimeters
  • centimeters
  • meters
  • kilometers
  • inches
  • feet
  • feet and inches
  • yards
  • miles

void WT_Units::set_units WT_String const &  units  )  [inline, inherited]
 

Sets the string describing the source unit of measure.

Although optional, if applicable the units description should follow convention and be one of the following (non-localized) strings:

  • millimeters
  • centimeters
  • meters
  • kilometers
  • inches
  • feet
  • feet and inches
  • yards
  • miles

Definition at line 105 of file units.h.

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

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_Group_End::skip_operand WT_Opcode const &  opcode,
WT_File file
[virtual, inherited]
 

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_Group_Begin::skip_operand WT_Opcode const &  opcode,
WT_File file
[virtual, inherited]
 

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_Units::WT_Units WT_Matrix const &  xform,
WT_String  units
[inline, inherited]
 

Constructs a WT_Units object with the given data.

Parameters:
xform  Transform from source (authoring tool) WHIP! coordinates.
units  A string describing the source unit of measure.

Definition at line 66 of file units.h.


Generated on Tue Jan 6 22:41:29 2009 for Autodesk DWF Whip 2D Toolkit by  doxygen 1.4.5