WT_Ellipse Class Reference

#include <ellipse.h>

Inheritance diagram for WT_Ellipse:

Inheritance graph
[legend]
Collaboration diagram for WT_Ellipse:

Collaboration graph
[legend]
List of all members.

Detailed Description

A base class for filled and outline ellipse / elliptical arc / elliptical wedge objects.

Definition at line 31 of file ellipse.h.

Public Member Functions

void transform (WT_Transform const &transform)
 Applies the given transform to the point set.
const WT_Integer32major () const
 Returns the major axis radius.
WT_Integer32major ()
const WT_Integer32minor () const
 Returns the minor axis radius.
WT_Integer32minor ()
const WT_Logical_Pointposition () const
 Returns the center point of the ellipse.
WT_Logical_Pointposition ()
const WT_Unsigned_Integer16start () const
 Returns the start angle (in 360/65,536ths of a degree.).
WT_Unsigned_Integer16start ()
float start_degree () const
 Returns the start angle (in degrees.).
float start_radian () const
 Returns the start angle (in radians.).
const WT_Unsigned_Integer32end () const
 Returns the end angle (in 360/65,536ths of a degree.).
WT_Unsigned_Integer32end ()
float end_degree () const
 Returns the end angle (in degrees.).
float end_radian () const
 Returns the end angle (in radians.).
const WT_Unsigned_Integer16tilt () const
 Returns the rotation angle (in 360/65,536ths of a degree.).
WT_Unsigned_Integer16tilt ()
float tilt_degree () const
 Returns the rotation angle (in degrees.).
float tilt_radian () const
 Returns the rotation angle (in radians.).
WT_Boolean transformed () const
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 skip_operand (WT_Opcode const &opcode, WT_File &file)
 Causes the file reading to proceed to the end of this object.
virtual void update_bounds (WT_File *file)
 Forces the drawable bounds to be updated.

Protected Types

enum  WT_Materialize_Stage
 Materialization stage.

Protected Member Functions

 WT_Ellipse ()
 Constructs a WT_Ellipse object.
 WT_Ellipse (WT_Integer32 x, WT_Integer32 y, WT_Integer32 major, WT_Integer32 minor, WT_Unsigned_Integer16 start=0, WT_Unsigned_Integer16 end=0, WT_Unsigned_Integer16 tilt=0)
 Constructs a WT_Ellipse object with the given data.
 WT_Ellipse (WT_Logical_Point const &pos, WT_Integer32 major, WT_Integer32 minor, WT_Unsigned_Integer16 start=0, WT_Unsigned_Integer16 end=0, WT_Unsigned_Integer16 tilt=0)
 Constructs a WT_Ellipse object with the given data.
 WT_Ellipse (const WT_Ellipse &e)
virtual ~WT_Ellipse ()
 Destroys a WT_Ellipse object.
WT_Result serialize (WT_File &file, WT_Boolean filled) const
 Used by child classes to serialize the ellipse.

Protected Attributes

WT_Logical_Point m_position
 Center point of ellipse.
WT_Integer32 m_major
 Major axis radius.
WT_Integer32 m_minor
 Minor axis radius.
WT_Unsigned_Integer16 m_start
 Start angle (in 360/65,536ths of a degree.).
WT_Unsigned_Integer32 m_end
 End angle (in 360/65,536ths of a degree.).
WT_Unsigned_Integer16 m_tilt
 Rotation angle (in 360/65,536ths of a degree.).
enum WT_Ellipse::WT_Materialize_Stage m_stage
 Materialization stage.
WT_Boolean m_transformed
 WD_True if the ellipse has been transformed.


Constructor & Destructor Documentation

WT_Ellipse::WT_Ellipse WT_Integer32  x,
WT_Integer32  y,
WT_Integer32  major,
WT_Integer32  minor,
WT_Unsigned_Integer16  start = 0,
WT_Unsigned_Integer16  end = 0,
WT_Unsigned_Integer16  tilt = 0
[inline, protected]
 

Constructs a WT_Ellipse object with the given data.

Parameters:
x  Horizontal component of the center point of ellipse.
y  Vertical component of the center point of ellipse.
major  Major axis radius.
minor  Minor axis radius.
start  Optional start angle (in 360/65,536ths of a degree.)
end  End angle (in 360/65,536ths of a degree.)
tilt  Rotation angle (in 360/65,536ths of a degree.)

Definition at line 70 of file ellipse.h.

WT_Ellipse::WT_Ellipse WT_Logical_Point const &  pos,
WT_Integer32  major,
WT_Integer32  minor,
WT_Unsigned_Integer16  start = 0,
WT_Unsigned_Integer16  end = 0,
WT_Unsigned_Integer16  tilt = 0
[inline, protected]
 

Constructs a WT_Ellipse object with the given data.

Parameters:
pos  Center point of ellipse.
major  Major axis radius.
minor  Minor axis radius.
start  Optional start angle (in 360/65,536ths of a degree.)
end  End angle (in 360/65,536ths of a degree.)
tilt  Rotation angle (in 360/65,536ths of a degree.)

Definition at line 93 of file ellipse.h.


Member Function Documentation

WT_Result WT_Ellipse::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_Ellipse::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.


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