PMI::Frame Class Reference

#include <HUtilityPMI.h>

Public Member Functions

 Frame (Frame const &that)
 
unsigned int GetPolylineCount () const
 
void GetPolylines (unsigned int &out_count, Polyline out_polylines[]) const
 
Frame const & operator= (Frame const &that)
 
void Set (Frame const &that)
 
void SetPolylines (unsigned int in_count, Polyline const in_polylines[])
 

Detailed Description

This class represents a collection of polylines which constitute the frame of an Entity or ViewEntity.

Member Function Documentation

◆ GetPolylineCount()

unsigned int PMI::Frame::GetPolylineCount ( ) const
Returns
the number of Polylines in this Frame

◆ GetPolylines()

void PMI::Frame::GetPolylines ( unsigned int &  out_count,
Polyline  out_polylines[] 
) const

Gets the polylines for this Frame.

Parameters
out_countthe number of polylines in this Frame. Returned to the user.
out_polylinesthe array of polylines for this Frame. Returned to the user. Necessary space should be allocated prior to calling. If pointer is NULL no values will be put into the array.

◆ SetPolylines()

void PMI::Frame::SetPolylines ( unsigned int  in_count,
Polyline const  in_polylines[] 
)

Sets the polylines for this Frame. These will replace any existing polylines.

Parameters
in_countthe number of polylines in the array
in_polylinesthe array of polylines for this Frame

The documentation for this class was generated from the following file: