KeggCircle: A class for representing a circle.

KeggCircleR Documentation

A class for representing a circle.

Description

A class for representing a circle.

A class for representing a circle.

Details

This class represents a rectangle, used for graphical representation. It is used by KeggPathwayConn::extractPathwayMapShapes() method.

Arguments to the constructor are:

x: X coordinate of center.

y: Y coordinate of center.

r: Radius.

Super class

biodbKegg::KeggShape -> KeggCircle

Methods

Public methods

Inherited methods

Method new()

Initialize new instance.

Usage
KeggCircle$new(x, y, r, ...)
Arguments
x

Abscissa of the circle's center.

y

Ordinate of the circle's center.

r

Radius of the circle.

...

Additional parameters are passed to super class' initializer.

Returns

Nothing.


Method getX()

Get the X coordinate.

Usage
KeggCircle$getX()
Returns

The X coordinate.


Method getY()

Get the Y coordinate.

Usage
KeggCircle$getY()
Returns

The Y coordinate.


Method getRadius()

Get the radius.

Usage
KeggCircle$getRadius()
Returns

The radius.


Method clone()

The objects of this class are cloneable with this method.

Usage
KeggCircle$clone(deep = FALSE)
Arguments
deep

Whether to make a deep clone.

See Also

KeggShape, KeggRect.

Examples

# Create an instance
c1 <- KeggCircle$new(x=12, y=5, r=3)

# Since it inherits from KeggShape, a color and a label can be set
c2 <- KeggCircle$new(x=12, y=5, r=3, color='blue', label='Circle 2')

# Getting center
c1$getX()
c1$getY()

# Getting radius
c1#getRadius()

# Draw a circle on the current image

c1$draw()



pkrog/biodbKegg documentation built on Oct. 1, 2022, 6:27 p.m.