scbpoints.h

Go to the documentation of this file.

#ifndef SCBPOINTS_H_
#define SCBPOINTS_H_

/*
 * File Name  : scbpoints.h
 * 
 * Description: Scribble library points array definition
 */

/*
 * This file is part of liberscribble.
 *
 * liberscribble is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 2 of the License, or
 * (at your option) any later version.
 *
 * liberscribble is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program. If not, see <http://www.gnu.org/licenses/>.
 */

/**
 * Copyright (C) 2008 iRex Technologies B.V.
 * All rights reserved.
 */
 

//----------------------------------------------------------------------------
// Include Files
//----------------------------------------------------------------------------

// system include files, between < >
#include <glib.h>

// ereader include files, between < >

// local include files, between " "
#include "scbpoint.h"

G_BEGIN_DECLS


//----------------------------------------------------------------------------
// Definitions
//---------------------------------------------------------------------------- 


//----------------------------------------------------------------------------
// Forward Declarations
//----------------------------------------------------------------------------


//----------------------------------------------------------------------------
// Type Declarations
//----------------------------------------------------------------------------    
    
// Scribble points array
// Two arrays are used so that the points can be easily exported to GTK/GDK and X11
// without allocating any other memory
typedef struct _ScbPoints
{
    GArray* points;         /**< Array of the coordintate points */ 
    GArray* pressures;      /**< Array of the pressures corresponding to each point */
} ScbPoints;

typedef ScbPoints * ScbPointsPtr;


//----------------------------------------------------------------------------
// Global Constants
//----------------------------------------------------------------------------


//============================================================================
// Public Functions
//============================================================================

// Create a points array with given size
// @param points the pointer of the ScbPoints intance
// @param initSize the size used for allocating memory
// @return return TRUE if the points array is successfully created, otherwise return FALSE
gboolean erscribble_points_new(ScbPointsPtr points, const int initSize);

// Release the points array and all items in it
// @param points the array to be freed
void erscribble_points_free(ScbPointsPtr points);

// Append a new point to the rear of the array
// @param points the scribble points array
// @param point the point to be appended
void erscribble_points_append(ScbPointsPtr points, ScbDevPointPtr point);

// Get the number of points in the array
// @param ptr the scribble points array
// @return return the number of points
int erscribble_points_get_count(ScbPointsPtr ptr);

// Get the start address of the points array
// @param points the scribble points array
// @return return the pointer of the first item in the array
ScbPointPtr erscribble_points_get_data(ScbPointsPtr points);

// Dump the data of points
// This function can be used for debug
void erscribble_points_dump(ScbPointsPtr points);


G_END_DECLS

#endif