GraphicalObject_t Class Reference

Detailed Description

layout Base class of objects that store layouts.

All the more specific layout elements (CompartmentGlyph_t, GeneralGlyph_t, SpeciesGlyph_t, ReactionGlyph_t, ReferenceGlyph_t, TextGlyph_t, and SpeciesReferenceGlyph_t) are derived from the class GraphicalObject_t. Each object of class GraphicalObject_t has a mandatory BoundingBox_t, which specifies the position and the size of the object. While GraphicalObject_t is the base class for most elements in the “layout” package, it is not an abstract class. It can be instantiated when used in the listOfAdditionalGraphicalObjects to describe additional elements and relationships. Since it only describes a BoundingBox_t, programs are encouraged to add Annotation objects that describe program-specific graphical information.

Public Member Functions
GraphicalObject_t *	GraphicalObject_clone (const GraphicalObject_t *go)
GraphicalObject_t *	GraphicalObject_create (void)
	Creates a new GraphicalObject_t. More...
GraphicalObject_t *	GraphicalObject_createFrom (const GraphicalObject_t *temp)
	Creates a GraphicalObject_t from a template. More...
void	GraphicalObject_free (GraphicalObject_t *go)
	Frees all memory taken up by the GraphicalObject_t. More...
BoundingBox_t *	GraphicalObject_getBoundingBox (GraphicalObject_t *go)
	Returns the bounding box for the GraphicalObject_t. More...
const char *	GraphicalObject_getId (const GraphicalObject_t *go)
	Returns the id. More...
void	GraphicalObject_initDefaults (GraphicalObject_t *go)
	Does nothing. More...
int	GraphicalObject_isSetId (const GraphicalObject_t *go)
	Returns 1 (true) if the id is set. More...
void	GraphicalObject_setBoundingBox (GraphicalObject_t *go, const BoundingBox_t *bb)
	Sets the boundingbox for the GraphicalObject_t. More...
int	GraphicalObject_setId (GraphicalObject_t *go, const char *sid)
	Sets the id. More...
void	GraphicalObject_unsetId (GraphicalObject_t *go)
	Unsets the id. More...

Member Function Documentation

GraphicalObject_t * GraphicalObject_clone

(

const GraphicalObject_t *

go

)

Returns

a (deep) copy of this GraphicalObject_t.

Parameters

go	the GraphicalObject_t structure.

GraphicalObject_t * GraphicalObject_create

(

void

)

Creates a new GraphicalObject_t.

GraphicalObject_t * GraphicalObject_createFrom

(

const GraphicalObject_t *

temp

)

Creates a GraphicalObject_t from a template.

Parameters

temp	the GraphicalObject_t structure to copy.

void GraphicalObject_free

(

GraphicalObject_t *

go

)

Frees all memory taken up by the GraphicalObject_t.

Parameters

go	the GraphicalObject_t structure.

BoundingBox_t * GraphicalObject_getBoundingBox

(

GraphicalObject_t *

go

)

Returns the bounding box for the GraphicalObject_t.

Parameters

go	the GraphicalObject_t structure.

const char * GraphicalObject_getId

(

const GraphicalObject_t *

go

)

Returns the id.

Parameters

go	the GraphicalObject_t structure.

void GraphicalObject_initDefaults

(

GraphicalObject_t *

go

)

Does nothing.

No defaults are defined for GraphicalObject_t.

Parameters

go	the GraphicalObject_t structure.

int GraphicalObject_isSetId

(

const GraphicalObject_t *

go

)

Returns 1 (true) if the id is set.

Parameters

go	the GraphicalObject_t structure.

void GraphicalObject_setBoundingBox	(	GraphicalObject_t *	go,
		const BoundingBox_t *	bb
	)

Sets the boundingbox for the GraphicalObject_t.

Parameters

go	the GraphicalObject_t structure.
bb	the BoundingBox_t structure to use.

int GraphicalObject_setId	(	GraphicalObject_t *	go,
		const char *	sid
	)

Sets the id.

Parameters

go	the GraphicalObject_t structure.
sid	the string to use as the ID of the GraphicalObject_t.

void GraphicalObject_unsetId

(

GraphicalObject_t *

go

)

Unsets the id.

Parameters

go	the GraphicalObject_t structure.