WT_XAML_Point_Set_Data Class Reference

#include <XamlPointset.h>

Inheritance diagram for WT_XAML_Point_Set_Data:

Inheritance graph
[legend]
List of all members.

Detailed Description

A base class for a set of WT_Point2D objects.

Definition at line 29 of file XamlPointset.h.

Public Member Functions

 WT_XAML_Point_Set_Data ()
 Constructs a WT_XAML_Point_Set_Data object.
 WT_XAML_Point_Set_Data (int count, WT_Logical_Point const *points)
 Constructs a WT_XAML_Point_Set_Data object from a given array of logical points.
 WT_XAML_Point_Set_Data (int count, WT_Point2D const *points, bool copy)
 Constructs a WT_XAML_Point_Set_Data object from a given array of points.
 WT_XAML_Point_Set_Data (vector< WT_Point2D > &points) throw (WT_Result)
 Constructrs a WT_XAML_Point_Set_Data from a vector of points.
virtual ~WT_XAML_Point_Set_Data ()
 Destroys a WT_XAML_Point_Set_Data object, and deletes the points if they had been copied in the constructor.
virtual WT_Point2D * points () const
 Returns a pointer to the array of points.
virtual int allocated () const
 Returns the number of allocated points (zero if the points were directly referenced in the constructor.).
virtual void clear ()
 Clears the list of points, and deletes the points if they had been copied in the constructor.
virtual int count () const
 Returns the number of points in the set.
virtual bool operator== (WT_XAML_Point_Set_Data const &set) const
 Equality operator. Returns WD_True if the given point set matches this one.
virtual void de_relativize (WT_File &file)
 Returns the points to absolute values based on their relative position to last materialized point.
virtual void relativize (WT_File &file)
 Relativizes the points in the set to the last serialized point.
virtual WT_XAML_Point_Set_Data
const & 
set (int count, WT_Logical_Point const *points)
 Sets the current point set with other contents (deletes the current set if allocated.).
virtual WT_XAML_Point_Set_Data
const & 
set (int count, WT_Point2D const *points, bool copy)
 Sets the current point set with other contents (deletes the current set if allocated.).

Protected Attributes

WT_Integer32 m_count
 The number of points in the set.
WT_Integer32 m_allocated
 The number of allocated points.
WT_Point2D * m_points
 The arrray of points.
bool m_relativized
 WD_True if the points have been relativized.


Constructor & Destructor Documentation

WT_XAML_Point_Set_Data::WT_XAML_Point_Set_Data int  count,
WT_Logical_Point const *  points
 

Constructs a WT_XAML_Point_Set_Data object from a given array of logical points.

Parameters:
count  The number of points in the array.

WT_XAML_Point_Set_Data::WT_XAML_Point_Set_Data int  count,
WT_Point2D const *  points,
bool  copy
 

Constructs a WT_XAML_Point_Set_Data object from a given array of points.

Warning:
Be careful when using the copy parameter. If the points are not copied, and they get deallocated, trouble will ensue. It's usually always safe to create copies of the points, but it may not always be a desirable choice due to performance. To help provide a means to mitigate the performance hit taken due to allocation and deallocation, the option is available to refer to the points directly.
Parameters:
count  The number of points in the array.
points  Pointer to the array of points.
copy  Whether the points should be copied or if their addresses should be used directly from the array.


Member Function Documentation

virtual WT_XAML_Point_Set_Data const& WT_XAML_Point_Set_Data::set int  count,
WT_Point2D const *  points,
bool  copy
[virtual]
 

Sets the current point set with other contents (deletes the current set if allocated.).

Parameters:
count  The number of points in the array.
points  Pointer to the array of points.
copy  Whether the points should be copied or if their addresses should be used directly from the array.

virtual WT_XAML_Point_Set_Data const& WT_XAML_Point_Set_Data::set int  count,
WT_Logical_Point const *  points
[virtual]
 

Sets the current point set with other contents (deletes the current set if allocated.).

Parameters:
count  The number of points in the array.
points  Pointer to the array of points.


The documentation for this class was generated from the following file:
Generated on Tue Jan 6 22:40:14 2009 for Autodesk DWF Toolkit by  doxygen 1.4.5