test::ScribbleMgr Class Reference

#include <scribble_manager.h>

Collaboration diagram for test::ScribbleMgr:

[legend]

Public Member Functions
	ScribbleMgr (void)
	~ScribbleMgr (void)
bool	open (const char *doc_path)
void	close (bool bSave=true)
void	save ()
	Save scribble document directly.
ScbDocPtr	get_erscribble_doc ()
	Retrieve raw scribble document pointer.
void	clear_page (const ScbPageId &pageId)
void	on_scribble_begin (const ScbPageId &pageId, ScribbleGC &sgc, const int absoluteX, const int absoluteY, const int offsetX, const int offsetY, const int pageX, const int pageY)
	Scribble stylus press event handler. This function will draw the new added scribbles both on e-ink screen and on gdk window.
void	on_scribble_move (const ScbPageId &pageId, ScribbleGC &sgc, const int absoluteX, const int absoluteY, const int offsetX, const int offsetY, const int pageX, const int pageY)
	Scribble stylus move event handler. This function will draw the new added scribbles both on e-ink screen and on gdk window.
void	on_scribble_end (const ScbPageId &pageId, ScribbleGC &sgc, const int absoluteX, const int absoluteY, const int offsetX, const int offsetY, const int pageX, const int pageY)
	Scribble stylus release event handler. This function will draw the new added scribbles both on e-ink screen and on gdk window.
void	on_erase_begin (const ScbPageId &pageId, ScribbleGC &sgc, const int absoluteX, const int absoluteY, const int offsetX, const int offsetY, const int pageX, const int pageY)
	Scribble stylus erase press event handler. This function will draw the strokes to be removed both on e-ink screen and on gdk window with color different from normal strokes.
void	on_erase_move (const ScbPageId &pageId, ScribbleGC &sgc, const int absoluteX, const int absoluteY, const int offsetX, const int offsetY, const int pageX, const int pageY)
	Scribble stylus erase move event handler. This function will draw the strokes to be removed both on e-ink screen and on gdk window with color different from normal strokes.
void	on_erase_end (const ScbPageId &pageId, ScribbleGC &sgc, const int absoluteX, const int absoluteY, const int offsetX, const int offsetY, const int pageX, const int pageY)
	Scribble stylus erase release event handler. This function will draw the strokes to be removed both on e-ink screen and on gdk window with color different from normal strokes.
bool	is_active () const
	Is the scribble manager active?
void	draw_scribble_page (const ScbPageId &pageId, ScribbleGC &sgc, const int pageX, const int pageY)
	Draw strokes belong to the specified page.
void	generate_page_id (ScbPageId &pid, const std::string &anchor, const int pos)
	Generate page id from anchor.
Static Public Member Functions
static void	copy_page_id (ScbPageId &dst, const ScbPageId &src)
	Duplicate page id.
static void	clear_page_id (ScbPageId &pageId)
	Clear page id.
static bool	is_page_id_empty (const ScbPageId &pageId)
	Check page id is empty.
static bool	cmp_page_id (const ScbPageId &src, const ScbPageId &dst)
	Compare two anchor objects.

---

Detailed Description

Scribble manager.

• Drawing scribble new added.
• Drawing scribble just removed.
• Redraw the scribbles with different zoom factor.
• Redraw the scribbles in portrait and landscape.
• Maintain scribble data by using erscribble library.

Definition at line 127 of file scribble_manager.h.

---

Constructor & Destructor Documentation

test::ScribbleMgr::ScribbleMgr

(

void

)

Definition at line 44 of file scribble_manager.cpp.

References erscribble_init().

: doc(0)
, page(0)
, stroke(0)
, last_absolute_point()
, last_page_point()
, last_page_position()
, dirty_pages()
{
    erscribble_init();
}

Here is the call graph for this function:

test::ScribbleMgr::~ScribbleMgr

(

void

)

Definition at line 56 of file scribble_manager.cpp.

References erscribble_uninit().

{
    erscribble_uninit();
}

Here is the call graph for this function:

---

Member Function Documentation

void test::ScribbleMgr::clear_page

(

const ScbPageId &

pageId

)

Definition at line 509 of file scribble_manager.cpp.

References erscribble_doc_get_page(), and erscribble_page_clear_strokes().

{
    ScbPagePtr page;
    page = erscribble_doc_get_page(doc, (const ScbPageIdPtr)(&pageId));
    if (page == 0)
    {
        printf("no page to erase\n");
        return;
    }
    erscribble_page_clear_strokes(page);
}

Here is the call graph for this function:

void test::ScribbleMgr::clear_page_id

(

ScbPageId &

pageId

)

[static]

Clear page id.

Definition at line 154 of file scribble_manager.cpp.

References erscribble_page_reset_id().

{
    erscribble_page_reset_id(&pageId);
}

Here is the call graph for this function:

void test::ScribbleMgr::close

(

bool

bSave = true

)

Close scribble document. This function will check the scribble data is dirty or not. bSave Whether or not to save current scribble data into persistent document.

Definition at line 88 of file scribble_manager.cpp.

References erscribble_doc_free(), and save().

Referenced by open().

{
    // TODO. need save the data of current page
    if (bSave)
    {
        save();
    }

    erscribble_doc_free(doc);
    doc = 0;
    memset(&path, 0, sizeof(path));
    page = 0;
    stroke = 0;
}

Here is the call graph for this function:

Here is the caller graph for this function:

bool test::ScribbleMgr::cmp_page_id	(	const ScbPageId &	src,
		const ScbPageId &	dst
	)			[static]

Compare two anchor objects.

Definition at line 164 of file scribble_manager.cpp.

References ERSCRIBBLE_MAX_PAGEID_LEN, and _ScbPageId::id.

Referenced by on_erase_move(), and on_scribble_move().

{
    return 0 == strncmp(src.id, dst.id, ERSCRIBBLE_MAX_PAGEID_LEN);
}

Here is the caller graph for this function:

void test::ScribbleMgr::copy_page_id	(	ScbPageId &	dst,
		const ScbPageId &	src
	)			[static]

Duplicate page id.

Definition at line 149 of file scribble_manager.cpp.

References erscribble_page_copy_id().

Referenced by on_erase_begin(), and on_erase_move().

{
    erscribble_page_copy_id(&dst, (const ScbPageIdPtr)(&src));
}

Here is the call graph for this function:

Here is the caller graph for this function:

void test::ScribbleMgr::draw_scribble_page	(	const ScbPageId &	pageId,
		ScribbleGC &	sgc,
		const int	pageX,
		const int	pageY
	)

Draw strokes belong to the specified page.

Parameters:

	pageId	The page id provided by caller.
	sgc	The scribble graphics context.
	pageX	The page screen coordinate x.
	pageY	The page screen coordinate y.
	page_width	width of the page, useful when in landscape mode
	page_height	height of the page, useful when in landscape mode

Definition at line 567 of file scribble_manager.cpp.

References erscribble_doc_get_page(), _ScbPageId::id, and test::ScribbleGC::rotation.

{

    // page from page id
    ScbPagePtr ptr = erscribble_doc_get_page(doc, (const ScbPageIdPtr)(&pageId));
    if (ptr == 0)
    {
        printf("page %s not found!", pageId.id);
        return;
    }

    if (sgc.rotation == 270)
    {
        draw_scribble_page_landscape(ptr, sgc, pageX, pageY);
    }
    else
    {
        draw_scribble_page_portrait(ptr, sgc, pageX, pageY);
    }
}

Here is the call graph for this function:

void test::ScribbleMgr::generate_page_id	(	ScbPageId &	pid,
		const std::string &	anchor,
		const int	pos
	)

Generate page id from anchor.

TODO: This function should be provided by caller now.

Parameters:

	pid	The erscribble page id which will store the result.
	anchor	The input anchor.
	pos	The page number

Removed should be provded by caller. Should compare PLUGIN_MAX_ANCHOR_LENGTH and erscribble_MAX_PAGEID_LEN. erscribble_MAX_PAGEID_LEN 256 PLUGIN_MAX_ANCHOR_LENGTH 1024. It may cause some problem when anchors' first 256 bytes are equal. Quite impossible.

Definition at line 144 of file scribble_manager.cpp.

References erscribble_page_set_id().

{
    erscribble_page_set_id(&pid, pos, anchor.c_str(), -1);
}

Here is the call graph for this function:

ScbDocPtr test::ScribbleMgr::get_erscribble_doc

(

)

[inline]

Retrieve raw scribble document pointer.

Definition at line 150 of file scribble_manager.h.

{ return doc; }

bool test::ScribbleMgr::is_active

(

)

const [inline]

Is the scribble manager active?

Definition at line 275 of file scribble_manager.h.

{return doc != 0;}

bool test::ScribbleMgr::is_page_id_empty

(

const ScbPageId &

pageId

)

[static]

Check page id is empty.

Definition at line 159 of file scribble_manager.cpp.

References _ScbPageId::id.

Referenced by on_erase_begin(), on_erase_end(), on_erase_move(), on_scribble_begin(), on_scribble_end(), and on_scribble_move().

{
    return pageId.id[0] == '\0';
}

Here is the caller graph for this function:

void test::ScribbleMgr::on_erase_begin	(	const ScbPageId &	pageId,
		ScribbleGC &	sgc,
		const int	absoluteX,
		const int	absoluteY,
		const int	offsetX,
		const int	offsetY,
		const int	pageX,
		const int	pageY
	)

Scribble stylus erase press event handler. This function will draw the strokes to be removed both on e-ink screen and on gdk window with color different from normal strokes.

When erasing, no need to check whether or not go into another page.

Parameters:

	pageId	The page id provided by caller.
	sgc	The scribble graphics context.
	absoluteX	The point screen coordinate x.
	absoluteY	The point screen coordinate y.
	offsetX	The x offset value within the page.
	offsetY	The y offset value within the page.
	pageX	The x offset of the page display position.
	pageY	The y offset of the page display position.

Definition at line 413 of file scribble_manager.cpp.

References copy_page_id(), erscribble_doc_get_page(), erscribble_page_erase_hit_test(), erscribble_page_erase_init(), erscribble_strokes_free(), is_page_id_empty(), _ScbDevPoint::point, test::ScribbleGC::realZoom, test::ScribbleGC::rotation, _ScbPoint::x, _ScbPoint::y, and _ScbPageEraseCtx::zoom.

{
    if (is_page_id_empty(pageId))
    {
        return;
    }

    // prepare for erasing.
    erscribble_page_erase_init(&erase_context);
    page = erscribble_doc_get_page(doc, (const ScbPageIdPtr)(&pageId));
    if (page == 0)
    {
        return;
    }

    // record
    copy_page_id(last_page_id, pageId);

    ScbDevPoint point;
    point.point.x = offsetX, point.point.y = offsetY;
    erase_context.zoom = sgc.realZoom;
    ScbStrokesPtr strokes = erscribble_page_erase_hit_test(page, &point, &erase_context);
    if (strokes)
    {
        printf("Erase strokes!");

        // draw and free
        if (sgc.rotation == 270)
        {
            draw_erased_strokes_landscape(strokes, sgc, pageX, pageY);
        }
        else
        {
            draw_erased_strokes_portrait(strokes, sgc, pageX, pageY);
        }

        // free
        erscribble_strokes_free(strokes);
    }
}

Here is the call graph for this function:

void test::ScribbleMgr::on_erase_end	(	const ScbPageId &	pageId,
		ScribbleGC &	sgc,
		const int	absoluteX,
		const int	absoluteY,
		const int	offsetX,
		const int	offsetY,
		const int	pageX,
		const int	pageY
	)

Scribble stylus erase release event handler. This function will draw the strokes to be removed both on e-ink screen and on gdk window with color different from normal strokes.

Parameters:

	pageId	The page id provided by caller.
	sgc	The scribble graphics context.
	absoluteX	The point screen coordinate x.
	absoluteY	The point screen coordinate y.
	offsetX	The x offset value within the page.
	offsetY	The y offset value within the page.
	pageX	The x offset of the page display position.
	pageY	The y offset of the page display position.

Definition at line 521 of file scribble_manager.cpp.

References erscribble_page_erase_hit_test(), erscribble_strokes_free(), is_page_id_empty(), _ScbDevPoint::point, test::ScribbleGC::rotation, _ScbPoint::x, and _ScbPoint::y.

{
    if (is_page_id_empty(pageId) || page == 0)
    {
        return;
    }

    ScbDevPoint point;
    point.point.x = offsetX;
    point.point.y = offsetY;
    ScbStrokesPtr strokes = erscribble_page_erase_hit_test(page, &point, &erase_context);

    if (!is_page_dirty(page))
    {
        // add page into dirty list
        set_page_dirty(page);
    }

    // reset
    page = 0;
    if (strokes) 
    {
        printf("Erase strokes!");
        if (sgc.rotation == 270)
        {
            draw_erased_strokes_landscape(strokes, sgc, pageX, pageY);
        }
        else
        {
            draw_erased_strokes_portrait(strokes, sgc, pageX, pageY);
        }

        // draw and free
        erscribble_strokes_free(strokes);
    }
}

Here is the call graph for this function:

void test::ScribbleMgr::on_erase_move	(	const ScbPageId &	pageId,
		ScribbleGC &	sgc,
		const int	absoluteX,
		const int	absoluteY,
		const int	offsetX,
		const int	offsetY,
		const int	pageX,
		const int	pageY
	)

Scribble stylus erase move event handler. This function will draw the strokes to be removed both on e-ink screen and on gdk window with color different from normal strokes.

Parameters:

	pageId	The page id provided by caller.
	sgc	The scribble graphics context.
	absoluteX	The point screen coordinate x.
	absoluteY	The point screen coordinate y.
	offsetX	The x offset value within the page.
	offsetY	The y offset value within the page.
	pageX	The x offset of the page display position.
	pageY	The y offset of the page display position.

Definition at line 461 of file scribble_manager.cpp.

References cmp_page_id(), copy_page_id(), erscribble_doc_get_page(), erscribble_page_erase_hit_test(), erscribble_page_erase_init(), erscribble_strokes_free(), is_page_id_empty(), _ScbDevPoint::point, test::ScribbleGC::realZoom, test::ScribbleGC::rotation, _ScbPoint::x, _ScbPoint::y, and _ScbPageEraseCtx::zoom.

{
    if (is_page_id_empty(pageId))
    {
        return;
    }

    if (!cmp_page_id(last_page_id, pageId))
    {
        copy_page_id(last_page_id, pageId);
        erscribble_page_erase_init(&erase_context);
        erase_context.zoom = sgc.realZoom;
    }

    page = erscribble_doc_get_page(doc, (const ScbPageIdPtr)(&pageId));
    if (page == 0)
    {
        return;
    }

    ScbDevPoint point;
    point.point.x = offsetX; point.point.y = offsetY;

    ScbStrokesPtr strokes = erscribble_page_erase_hit_test(page, &point, &erase_context);
    if (strokes)
    {
        printf("Erase strokes!");
        if (sgc.rotation == 270)
        {
            draw_erased_strokes_landscape(strokes, sgc, pageX, pageY);
        }
        else
        {
            draw_erased_strokes_portrait(strokes, sgc, pageX, pageY);
        }

        // free 
        erscribble_strokes_free(strokes);
    }
}

Here is the call graph for this function:

void test::ScribbleMgr::on_scribble_begin	(	const ScbPageId &	pageId,
		ScribbleGC &	sgc,
		const int	absoluteX,
		const int	absoluteY,
		const int	offsetX,
		const int	offsetY,
		const int	pageX,
		const int	pageY
	)

Scribble stylus press event handler. This function will draw the new added scribbles both on e-ink screen and on gdk window.

Parameters:

	pageId	The page id provided by caller.
	sgc	The scribble graphics context.
	absoluteX	The point screen coordinate x.
	absoluteY	The point screen coordinate y.
	offsetX	The x offset value within the page.
	offsetY	The y offset value within the page.
	pageX	The x offset of the page display position.
	pageY	The y offset of the page display position.

Definition at line 304 of file scribble_manager.cpp.

References _ScbPageId::id, is_page_id_empty(), test::Point::x, and test::Point::y.

{
    printf("PageId %s page %p stroke %p!", pageId.id, page, stroke);
    if (!is_page_id_empty(pageId))
    {
        if (page && stroke)
        {
            add_point(pageId, sgc, absoluteX, absoluteY, offsetX, offsetY);
        }
        else if (page == 0 && stroke == 0)
        {
            begin_stroke(pageId, sgc, absoluteX, absoluteY, offsetX, offsetY);
        }

        // record the last point
        last_absolute_point.x = absoluteX;
        last_absolute_point.y = absoluteY;
        last_page_point.x = offsetX;
        last_page_point.y = offsetY;
        last_page_position.x = pageX;
        last_page_position.y = pageY;
    }
}

Here is the call graph for this function:

void test::ScribbleMgr::on_scribble_end	(	const ScbPageId &	pageId,
		ScribbleGC &	sgc,
		const int	absoluteX,
		const int	absoluteY,
		const int	offsetX,
		const int	offsetY,
		const int	pageX,
		const int	pageY
	)

Scribble stylus release event handler. This function will draw the new added scribbles both on e-ink screen and on gdk window.

Parameters:

	pageId	The page id provided by caller.
	sgc	The scribble graphics context.
	absoluteX	The point screen coordinate x.
	absoluteY	The point screen coordinate y.
	offsetX	The x offset value within the page.
	offsetY	The y offset value within the page.
	pageX	The x offset of the page display position.
	pageY	The y offset of the page display position.

Definition at line 390 of file scribble_manager.cpp.

References is_page_id_empty(), test::Point::x, and test::Point::y.

{
    if (!is_page_id_empty(pageId) && stroke && doc && page)
    {
        end_stroke(pageId, sgc, absoluteX, absoluteY, offsetX, offsetY, pageX, pageY);
        // record the last point
        last_absolute_point.x = absoluteX;
        last_absolute_point.y = absoluteY;
        last_page_point.x = offsetX;
        last_page_point.y = offsetY;
        last_page_position.x = pageX;
        last_page_position.y = pageY;
    }
}

Here is the call graph for this function:

void test::ScribbleMgr::on_scribble_move	(	const ScbPageId &	pageId,
		ScribbleGC &	sgc,
		const int	absoluteX,
		const int	absoluteY,
		const int	offsetX,
		const int	offsetY,
		const int	pageX,
		const int	pageY
	)

Scribble stylus move event handler. This function will draw the new added scribbles both on e-ink screen and on gdk window.

Should consider following situations:

• Move from page to window(out of page).
• Move from window(out of page) to page.
• Move from one page to the other.

Parameters:

	pageId	The page id provided by caller.
	sgc	The scribble graphics context.
	absoluteX	The point screen coordinate x.
	absoluteY	The point screen coordinate y.
	offsetX	The x offset value within the page.
	offsetY	The y offset value within the page.
	pageX	The x offset of the page display position.
	pageY	The y offset of the page display position.

Definition at line 339 of file scribble_manager.cpp.

References cmp_page_id(), is_page_id_empty(), test::Point::x, and test::Point::y.

{
    // out of page, end stroke now.
    if (is_page_id_empty(pageId) && stroke && page)
    {
        // end without adding it
        end_stroke(sgc, absoluteX, absoluteY, pageX, pageY);
        return;
    }

    bool ret = false;
    // re-enter page bound
    if (!ret && !is_page_id_empty(pageId) && stroke == 0 && page == 0)
    {
        begin_stroke(pageId, sgc, absoluteX, absoluteY, offsetX, offsetY);
        ret = true;
    }

    // from one page to the other, should use old pagex and pagey
    if (!ret && !is_page_id_empty(last_page_id) && 
        !is_page_id_empty(pageId) && 
        !cmp_page_id(pageId, last_page_id) && stroke && page)
    {
        end_stroke(last_page_id, sgc, last_absolute_point.x, last_absolute_point.y
            , last_page_point.x, last_page_point.y, last_page_position.x, last_page_position.y);
        begin_stroke(pageId, sgc, absoluteX, absoluteY, offsetX, offsetY);
        ret = true;
    }

    // scribble mode
    if (!ret && stroke)
    {
        add_point(pageId, sgc, absoluteX, absoluteY, offsetX, offsetY);
        // record the last point
        last_absolute_point.x = absoluteX;
        last_absolute_point.y = absoluteY;
        last_page_point.x = offsetX;
        last_page_point.y = offsetY;
        last_page_position.x = pageX;
        last_page_position.y = pageY;
        ret = true;
    }
}

Here is the call graph for this function:

bool test::ScribbleMgr::open

(

const char *

doc_path

)

Open scribble document.

Parameters:

path

The document absolute path.

Returns:

It returns true if the document has been successfully opened. Otherwise this function returns false.

Definition at line 61 of file scribble_manager.cpp.

References close(), erscribble_doc_new(), erscribble_doc_open(), and ERSCRIBBLE_MAX_PATH.

{
    close();
    
    // check
    if (doc_path == 0)
    {
        printf("Invalid path name pointer!\n");
        return false;
    }

    // keep the path name.
    strncpy(path.document_path, doc_path, ERSCRIBBLE_MAX_PATH);

    // open file
    doc = erscribble_doc_open(&path);

    // if there is no scribble data stored in the data base
    // create a new scribble document
    if (doc == 0)
    {
        doc = erscribble_doc_new(&path);
    }

    return (doc != 0);
}

Here is the call graph for this function:

void test::ScribbleMgr::save

(

)

Save scribble document directly.

Definition at line 123 of file scribble_manager.cpp.

References erscribble_doc_save_page().

Referenced by close().

{
    if (doc)
    {
        DirtyPagesIter idx = dirty_pages.begin();
        for (; idx != dirty_pages.end(); ++idx)
        {
            ScbPagePtr ptr = *idx;
            erscribble_doc_save_page(doc, ptr);
        }
        // clear all dirty pages
        dirty_pages.clear();
    }
}

Here is the call graph for this function:

Here is the caller graph for this function:

---

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

• scribble_manager.h
• scribble_manager.cpp