|
libSBML C API
5.18.0
|
|
libSBML C API
5.18.0
|
The ReferenceGlyph_t element describes the graphical connection between an arbitrary GraphicalObject_t (or derived element) and a GeneralGlyph_t (which would be an arrow or some curve in most cases). A ReferenceGlyph_t inherits from GraphicalObject_t. Additionally it has a mandatory attribute 'glyph' and two optional attributes 'reference' and 'role'. Optionally, the ReferenceGlyph_t also has an element 'curve'. The ReferenceGlyph_t should either contain a bounding box or a curve specification. If both are given, the bounding box should be ignored.
Public Member Functions | |
| ReferenceGlyph_t * | ReferenceGlyph_clone (const ReferenceGlyph_t *rg) |
| ReferenceGlyph_t * | ReferenceGlyph_create (void) |
| Creates a new ReferenceGlyph_t structure and returns a pointer to it. More... | |
| CubicBezier_t * | ReferenceGlyph_createCubicBezier (ReferenceGlyph_t *rg) |
| Creates a new CubicBezier_t structure, adds it to the end of the list of curve segment of the curve and returns a reference to the newly created structure. More... | |
| ReferenceGlyph_t * | ReferenceGlyph_createFrom (const ReferenceGlyph_t *temp) |
| Creates a new ReferenceGlyph_t from a template. More... | |
| LineSegment_t * | ReferenceGlyph_createLineSegment (ReferenceGlyph_t *rg) |
| Creates a new LineSegment_t structure, adds it to the end of the list of curve segments of the curve and returns a reference to the newly created structure. More... | |
| ReferenceGlyph_t * | ReferenceGlyph_createWith (const char *sid, const char *glyphId, const char *referenceId, const char *role) |
| Creates a new ReferenceGlyph_t. More... | |
| void | ReferenceGlyph_free (ReferenceGlyph_t *rg) |
| Frees the memory for the ReferenceGlyph_t. More... | |
| Curve_t * | ReferenceGlyph_getCurve (ReferenceGlyph_t *rg) |
| Gets the Curve_t for the given reference glyph. More... | |
| const char * | ReferenceGlyph_getGlyphId (const ReferenceGlyph_t *rg) |
| Gets the reference id for the given glyph. More... | |
| const char * | ReferenceGlyph_getId (const ReferenceGlyph_t *rg) |
| Returns the id. More... | |
| const char * | ReferenceGlyph_getReferenceId (const ReferenceGlyph_t *rg) |
| Gets the reference id for the given glyph. More... | |
| const char * | ReferenceGlyph_getRole (const ReferenceGlyph_t *rg) |
| Returns the role of the reference. More... | |
| void | ReferenceGlyph_initDefaults (ReferenceGlyph_t *rg) |
| Calls initDefaults on GraphicalObject_t. More... | |
| int | ReferenceGlyph_isSetCurve (ReferenceGlyph_t *rg) |
| Returns true if the Curve_t has one or more LineSegment_t. More... | |
| int | ReferenceGlyph_isSetGlyphId (const ReferenceGlyph_t *rg) |
Returns 0 (false) if the reference has not been set for this glyph and 1 (true) otherwise. More... | |
| int | ReferenceGlyph_isSetId (const ReferenceGlyph_t *rg) |
Returns 1 (true) if the id is set. More... | |
| int | ReferenceGlyph_isSetReferenceId (const ReferenceGlyph_t *rg) |
Returns 0 (false) if the reference reference has not been set for this glyph and 1 (true) otherwise. More... | |
| int | ReferenceGlyph_isSetRole (const ReferenceGlyph_t *rg) |
| Returns true if the role is not empty. More... | |
| void | ReferenceGlyph_setCurve (ReferenceGlyph_t *rg, Curve_t *c) |
| Sets the curve for the reference glyph. More... | |
| void | ReferenceGlyph_setGlyphId (ReferenceGlyph_t *rg, const char *id) |
| Sets the glyph reference for the glyph. More... | |
| int | ReferenceGlyph_setId (ReferenceGlyph_t *rg, const char *sid) |
| Sets the id. More... | |
| void | ReferenceGlyph_setReferenceId (ReferenceGlyph_t *rg, const char *id) |
| Sets the reference for the glyph. More... | |
| void | ReferenceGlyph_setRole (ReferenceGlyph_t *rg, const char *r) |
| Sets the role of the reference glyph based on the string. More... | |
| void | ReferenceGlyph_unsetId (ReferenceGlyph_t *rg) |
| Unsets the id. More... | |
| ReferenceGlyph_t * ReferenceGlyph_clone | ( | const ReferenceGlyph_t * | rg | ) |
| rg | the ReferenceGlyph_t structure. |
| ReferenceGlyph_t * ReferenceGlyph_create | ( | void | ) |
Creates a new ReferenceGlyph_t structure and returns a pointer to it.
| CubicBezier_t * ReferenceGlyph_createCubicBezier | ( | ReferenceGlyph_t * | rg | ) |
Creates a new CubicBezier_t structure, adds it to the end of the list of curve segment of the curve and returns a reference to the newly created structure.
| rg | the ReferenceGlyph_t structure. |
| ReferenceGlyph_t * ReferenceGlyph_createFrom | ( | const ReferenceGlyph_t * | temp | ) |
Creates a new ReferenceGlyph_t from a template.
| temp | the ReferenceGlyph_t structure to copy. |
| LineSegment_t * ReferenceGlyph_createLineSegment | ( | ReferenceGlyph_t * | rg | ) |
Creates a new LineSegment_t structure, adds it to the end of the list of curve segments of the curve and returns a reference to the newly created structure.
| rg | the ReferenceGlyph_t structure. |
| ReferenceGlyph_t * ReferenceGlyph_createWith | ( | const char * | sid, |
| const char * | glyphId, | ||
| const char * | referenceId, | ||
| const char * | role | ||
| ) |
Creates a new ReferenceGlyph_t.
The id is given as the first argument, the id of the associated reference is given as the second argument. The third argument is the id of the associated glyph and the fourth argument is the role.
| sid | the string to use as the ID of the SpeciesReferenceGlyph_t. |
| glyphId | the string to use as the glyph. |
| referenceId | the string to use as the reference. |
| role | the role of the created ReferenceGlyph_t. |
| void ReferenceGlyph_free | ( | ReferenceGlyph_t * | rg | ) |
Frees the memory for the ReferenceGlyph_t.
| rg | the ReferenceGlyph_t structure. |
| Curve_t * ReferenceGlyph_getCurve | ( | ReferenceGlyph_t * | rg | ) |
Gets the Curve_t for the given reference glyph.
| rg | the ReferenceGlyph_t structure. |
| const char * ReferenceGlyph_getGlyphId | ( | const ReferenceGlyph_t * | rg | ) |
Gets the reference id for the given glyph.
| rg | the ReferenceGlyph_t structure. |
| const char * ReferenceGlyph_getId | ( | const ReferenceGlyph_t * | rg | ) |
Returns the id.
| rg | the ReferenceGlyph_t structure. |
| const char * ReferenceGlyph_getReferenceId | ( | const ReferenceGlyph_t * | rg | ) |
Gets the reference id for the given glyph.
| rg | the ReferenceGlyph_t structure. |
| const char * ReferenceGlyph_getRole | ( | const ReferenceGlyph_t * | rg | ) |
Returns the role of the reference.
| rg | the ReferenceGlyph_t structure. |
| void ReferenceGlyph_initDefaults | ( | ReferenceGlyph_t * | rg | ) |
Calls initDefaults on GraphicalObject_t.
| rg | the ReferenceGlyph_t structure. |
| int ReferenceGlyph_isSetCurve | ( | ReferenceGlyph_t * | rg | ) |
Returns true if the Curve_t has one or more LineSegment_t.
| rg | the ReferenceGlyph_t structure. |
| int ReferenceGlyph_isSetGlyphId | ( | const ReferenceGlyph_t * | rg | ) |
Returns 0 (false) if the reference has not been set for this glyph and 1 (true) otherwise.
| rg | the ReferenceGlyph_t structure. |
| int ReferenceGlyph_isSetId | ( | const ReferenceGlyph_t * | rg | ) |
Returns 1 (true) if the id is set.
| rg | the ReferenceGlyph_t structure. |
| int ReferenceGlyph_isSetReferenceId | ( | const ReferenceGlyph_t * | rg | ) |
Returns 0 (false) if the reference reference has not been set for this glyph and 1 (true) otherwise.
| rg | the ReferenceGlyph_t structure. |
| int ReferenceGlyph_isSetRole | ( | const ReferenceGlyph_t * | rg | ) |
Returns true if the role is not empty.
| rg | the ReferenceGlyph_t structure. |
| void ReferenceGlyph_setCurve | ( | ReferenceGlyph_t * | rg, |
| Curve_t * | c | ||
| ) |
Sets the curve for the reference glyph.
| rg | the ReferenceGlyph_t structure. |
| c | the Curve_t to set for the ReferenceGlyph_t. |
| void ReferenceGlyph_setGlyphId | ( | ReferenceGlyph_t * | rg, |
| const char * | id | ||
| ) |
Sets the glyph reference for the glyph.
| rg | the ReferenceGlyph_t structure. |
| id | the string to use as the glyph. |
| int ReferenceGlyph_setId | ( | ReferenceGlyph_t * | rg, |
| const char * | sid | ||
| ) |
Sets the id.
| rg | the ReferenceGlyph_t structure. |
| sid | the string to use as the ID of the ReferenceGlyph_t. |
| void ReferenceGlyph_setReferenceId | ( | ReferenceGlyph_t * | rg, |
| const char * | id | ||
| ) |
Sets the reference for the glyph.
| rg | the ReferenceGlyph_t structure. |
| id | the string to use as the reference. |
| void ReferenceGlyph_setRole | ( | ReferenceGlyph_t * | rg, |
| const char * | r | ||
| ) |
Sets the role of the reference glyph based on the string.
| rg | the ReferenceGlyph_t structure. |
| r | the role to use for the ReferenceGlyph_t. |
| void ReferenceGlyph_unsetId | ( | ReferenceGlyph_t * | rg | ) |
Unsets the id.
| rg | the ReferenceGlyph_t structure. |
