writRecognFullCharacter

writRecognFullCharacter — Full character that hold all information about the character.

Stability Level

Stable, unless otherwise indicated

Synopsis




void                rawWriting_reset                    (RawWriting *rW);
#define             WRITRECOGN_FULLCHARACTER_CONST      (obj)
                    writRecognFullCharacter;
FullCharacter*      writrecogn_fullcharacter_new        (void);
void                writrecogn_fullcharacter_reset_fullCharacter_part
                                                        (writRecognFullCharacter *self);
RawWriting*         writrecogn_fullcharacter_new_rawWriting
                                                        (writRecognFullCharacter *self);
guint               writrecogn_fullcharacter_count_rawWritings
                                                        (writRecognFullCharacter *self);
RawWriting*         writrecogn_fullcharacter_get_rawWriting
                                                        (writRecognFullCharacter *self,
                                                         guint index);
void                writrecogn_fullcharacter_remove_rawWriting
                                                        (writRecognFullCharacter *self,
                                                         guint index);
void                writrecogn_fullcharacter_reset_rawWriting
                                                        (writRecognFullCharacter *self,
                                                         guint index);
guint               writrecogn_fullcharacter_count_rawStrokes
                                                        (writRecognFullCharacter *self,
                                                         gint rawWritingIndex);
RawStroke*          writrecogn_fullcharacter_get_rawStroke
                                                        (writRecognFullCharacter *self,
                                                         gint rawWritingIndex,
                                                         guint index);
void                writrecogn_fullcharacter_add_rawStroke
                                                        (writRecognFullCharacter *self,
                                                         gint rawWritingIndex,
                                                         RawStroke *rStroke);
guint               writrecogn_fullcharacter_count_geometryModels
                                                        (writRecognFullCharacter *self);
RadicalGM*          writrecogn_fullcharacter_new_geometryModel
                                                        (writRecognFullCharacter *self);
void                writrecogn_fullcharacter_append_geometryModel
                                                        (writRecognFullCharacter *self,
                                                         RadicalGM *gm);
RadicalGM*          writrecogn_fullcharacter_get_geometryModel
                                                        (writRecognFullCharacter *self,
                                                         guint index);
RadicalGM*          writrecogn_fullcharacter_get_geometryModel_by_modelId
                                                        (writRecognFullCharacter *self,
                                                         gint modelId);
void                writrecogn_fullcharacter_remove_geometryModel
                                                        (writRecognFullCharacter *self,
                                                         guint index);
void                writrecogn_fullcharacter_append_subRadical
                                                        (writRecognFullCharacter *self,
                                                         Radical *subRadical,
                                                         guint index);
void                writrecogn_fullcharacter_recompute_relativeBoundingBoxes
                                                        (writRecognFullCharacter *self);
#define             WRITRECOGN_FULLCHARACTER_PROP_RAWWRITINGARRAY(arg)
#define             WRITRECOGN_FULLCHARACTER_GET_PROP_RAWWRITINGARRAY(arg)
#define             WRITRECOGN_FULLCHARACTER_PROP_RADICALGMARRAY(arg)
#define             WRITRECOGN_FULLCHARACTER_GET_PROP_RADICALGMARRAY(arg)

Object Hierarchy


  GObject
   +----writRecognRadical
         +----writRecognAbsCharacter
               +----writRecognFullCharacter

Properties


  "radicalGMArray"           gpointer              : Read / Write
  "rawWritingArray"          gpointer              : Read / Write

Description

Full character hold all information about the character. Specifically, raw strokes(RawStroke) and radical geometry models(RadicalGM).

writRecognFullCharacter is GOB long notation, for convenience, use FullCharacter for declaring and FULLCHARACTER() for casting.

Details

rawWriting_reset ()

void                rawWriting_reset                    (RawWriting *rW);

Reset the raw writing by removing its contents.

rW :

the raw writing.

WRITRECOGN_FULLCHARACTER_CONST()

#define WRITRECOGN_FULLCHARACTER_CONST(obj)	G_TYPE_CHECK_INSTANCE_CAST((obj), writrecogn_fullcharacter_get_type(), writRecognFullCharacter const)

obj :


writRecognFullCharacter

typedef struct _writRecognFullCharacter writRecognFullCharacter;


writrecogn_fullcharacter_new ()

FullCharacter*      writrecogn_fullcharacter_new        (void);

Allocate a new instance of this object.

Returns :

new instance of this object.

writrecogn_fullcharacter_reset_fullCharacter_part ()

void                writrecogn_fullcharacter_reset_fullCharacter_part
                                                        (writRecognFullCharacter *self);

Reset the full character part only.

self :

the full character.

writrecogn_fullcharacter_new_rawWriting ()

RawWriting*         writrecogn_fullcharacter_new_rawWriting
                                                        (writRecognFullCharacter *self);

New a raw writing.

self :

the full character.

Returns :


writrecogn_fullcharacter_count_rawWritings ()

guint               writrecogn_fullcharacter_count_rawWritings
                                                        (writRecognFullCharacter *self);

Count the number of raw writing of this full character.

self :

the full character.

Returns :


writrecogn_fullcharacter_get_rawWriting ()

RawWriting*         writrecogn_fullcharacter_get_rawWriting
                                                        (writRecognFullCharacter *self,
                                                         guint index);

Get the raw writing at the given index of full character.

self :

the full character.

index :

the index of the raw writing.

Returns :

the raw writing at the given index of full character.

writrecogn_fullcharacter_remove_rawWriting ()

void                writrecogn_fullcharacter_remove_rawWriting
                                                        (writRecognFullCharacter *self,
                                                         guint index);

Get the raw writing at the given index of full character.

self :

the full character.

index :

the index of the raw writing.

writrecogn_fullcharacter_reset_rawWriting ()

void                writrecogn_fullcharacter_reset_rawWriting
                                                        (writRecognFullCharacter *self,
                                                         guint index);

Reset the raw writing by removing its all elements.

self :

the full character.

index :

the index of the raw writing.

writrecogn_fullcharacter_count_rawStrokes ()

guint               writrecogn_fullcharacter_count_rawStrokes
                                                        (writRecognFullCharacter *self,
                                                         gint rawWritingIndex);

self :

rawWritingIndex :

Returns :


writrecogn_fullcharacter_get_rawStroke ()

RawStroke*          writrecogn_fullcharacter_get_rawStroke
                                                        (writRecognFullCharacter *self,
                                                         gint rawWritingIndex,
                                                         guint index);

Get a RawStroke by its index.

self :

the full character

rawWritingIndex :

index of RawWriting

index :

index of RawStroke

Returns :

the RawStorke at the index given by index.

writrecogn_fullcharacter_add_rawStroke ()

void                writrecogn_fullcharacter_add_rawStroke
                                                        (writRecognFullCharacter *self,
                                                         gint rawWritingIndex,
                                                         RawStroke *rStroke);

Add a RawStroke to RawWriting

self :

the full character.

rawWritingIndex :

index of RawWriting.

rStroke :


writrecogn_fullcharacter_count_geometryModels ()

guint               writrecogn_fullcharacter_count_geometryModels
                                                        (writRecognFullCharacter *self);

Count the number of radical geometry models of the full character.

self :

the full character.

Returns :

the number of radical geometry models of the full character.

writrecogn_fullcharacter_new_geometryModel ()

RadicalGM*          writrecogn_fullcharacter_new_geometryModel
                                                        (writRecognFullCharacter *self);

Allocate a new instance of radical geometry model for the full character.

self :

the full character.

Returns :

a new instance of radical geometry model for the full character.

writrecogn_fullcharacter_append_geometryModel ()

void                writrecogn_fullcharacter_append_geometryModel
                                                        (writRecognFullCharacter *self,
                                                         RadicalGM *gm);

Append the radical geometry model to the full character.

self :

the full character.

gm :

the radical geometry model.

writrecogn_fullcharacter_get_geometryModel ()

RadicalGM*          writrecogn_fullcharacter_get_geometryModel
                                                        (writRecognFullCharacter *self,
                                                         guint index);

Get the radical geometry model at given index.

self :

the full character.

index :

the index of radical geometry model.

Returns :

the radical geometry model at given index.

writrecogn_fullcharacter_get_geometryModel_by_modelId ()

RadicalGM*          writrecogn_fullcharacter_get_geometryModel_by_modelId
                                                        (writRecognFullCharacter *self,
                                                         gint modelId);

Get the radical geometry model with given id.

self :

the full character.

modelId :

the radical geometry model id.

Returns :

the radical geometry model with given id.

writrecogn_fullcharacter_remove_geometryModel ()

void                writrecogn_fullcharacter_remove_geometryModel
                                                        (writRecognFullCharacter *self,
                                                         guint index);

Remove the radical geometry model at given index.

self :

the full character.

index :

the index of radical geometry model.

writrecogn_fullcharacter_append_subRadical ()

void                writrecogn_fullcharacter_append_subRadical
                                                        (writRecognFullCharacter *self,
                                                         Radical *subRadical,
                                                         guint index);

Append a sub radical to the full character.

Note that this function updates the absolute bounding boxes but not relative ones.

Call writrecogn_fullcharacter_recompute_relativeBoundingBoxes() to generate relative bounding boxes.

self :

the full character.

subRadical :

the sub radical to be added to the character.

index :

the index of the geometry model.

writrecogn_fullcharacter_recompute_relativeBoundingBoxes ()

void                writrecogn_fullcharacter_recompute_relativeBoundingBoxes
                                                        (writRecognFullCharacter *self);

Recompute the relative bounding boxes in the radical geometry models.

It is a convenient wrap of writrecogn_radical_geometry_model_recompute_relativeBoundingBoxes().

self :

the radical geometry model.

WRITRECOGN_FULLCHARACTER_PROP_RAWWRITINGARRAY()

#define             WRITRECOGN_FULLCHARACTER_PROP_RAWWRITINGARRAY(arg)

arg :


WRITRECOGN_FULLCHARACTER_GET_PROP_RAWWRITINGARRAY()

#define             WRITRECOGN_FULLCHARACTER_GET_PROP_RAWWRITINGARRAY(arg)

arg :


WRITRECOGN_FULLCHARACTER_PROP_RADICALGMARRAY()

#define             WRITRECOGN_FULLCHARACTER_PROP_RADICALGMARRAY(arg)

arg :


WRITRECOGN_FULLCHARACTER_GET_PROP_RADICALGMARRAY()

#define             WRITRECOGN_FULLCHARACTER_GET_PROP_RADICALGMARRAY(arg)

arg :

Property Details

The "radicalGMArray" property

  "radicalGMArray"           gpointer              : Read / Write

An array of radical geometry models.


The "rawWritingArray" property

  "rawWritingArray"          gpointer              : Read / Write

An array of raw writings.

See Also

writRecognRadical, writRecognAbsCharacter, writRecognRawStroke, writRecognRadical_Geometry_Model.