fisica

Class FDrawable

java.lang.Object

fisica.FDrawable

Direct Known Subclasses:

FBody, FJoint

public abstract class FDrawable
extends Object

This is a class from which all drawable objects of a world inherit. It contains most helping methods that handles stroke and fill colors and styles, as well as image attachments, etc.

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	m_drawable
protected boolean	m_fill
protected int	m_fillColor
protected def.processing.core.PImage	m_image
protected float	m_imageAlpha
protected def.processing.core.PImage	m_mask
protected boolean	m_stroke
protected int	m_strokeColor
protected float	m_strokeWeight

Constructor Summary

Constructors

Constructor and Description
FDrawable()

Method Summary

Modifier and Type	Method and Description
protected void	appletFill(def.processing.core.PGraphics applet, int argb)
protected void	appletFillStroke(def.processing.core.PGraphics applet)
protected void	appletStroke(def.processing.core.PGraphics applet, int argb)
void	attachImage(def.processing.core.PImage img) Attach an image to the object.
void	dettachImage() Dettach any image that has been attached to the object.
void	draw(def.processing.core.PGraphics graphics) This method is called when calling world.draw().
void	drawDebug(def.processing.core.PGraphics graphics) This method is called when calling world.drawDebug().
protected void	drawImage(def.processing.core.PGraphics applet)
int	getFillColor() Returns the fill color of the object.
float	getImageAlpha() Get the opacity with which to draw the attached image.
boolean	isDrawable() Get whether the object must be drawn or not.
void	setDrawable(boolean drawable) Set whether the object must be drawn or not.
void	setFill(float g) Set the fill color of the object.
void	setFill(float g, float a) Set the fill color of the object.
void	setFill(float r, float g, float b) Set the fill color of the object.
void	setFill(float r, float g, float b, float a) Set the fill color of the object.
void	setFillColor(int col) Set the fill color of the object.
void	setImageAlpha(float alpha) Set the opacity with which to draw the attached image.
void	setNoFill() Set that the object must be drawn without fill.
void	setNoStroke() Set that the object must be drawn without stroke.
void	setStroke(float g) Set the stroke color of the object.
void	setStroke(float g, float a) Set the stroke color of the object.
void	setStroke(float r, float g, float b) Set the stroke color of the object.
void	setStroke(float r, float g, float b, float a) Set the stroke color of the object.
void	setStrokeColor(int col) Set the stroke color of the object.
void	setStrokeWeight(float weight) Set the stroke weight of the object.
protected void	updateStyle(FDrawable other)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

m_drawable

protected boolean m_drawable

m_fill

protected boolean m_fill

m_fillColor

protected int m_fillColor

m_stroke

protected boolean m_stroke

m_strokeColor

protected int m_strokeColor

m_strokeWeight

protected float m_strokeWeight

m_image

protected def.processing.core.PImage m_image

m_imageAlpha

protected float m_imageAlpha

m_mask

protected def.processing.core.PImage m_mask

Constructor Detail

FDrawable

public FDrawable()

Method Detail

updateStyle

protected void updateStyle(FDrawable other)

appletStroke

protected void appletStroke(def.processing.core.PGraphics applet,
                            int argb)

appletFill

protected void appletFill(def.processing.core.PGraphics applet,
                          int argb)

appletFillStroke

protected void appletFillStroke(def.processing.core.PGraphics applet)

drawImage

protected void drawImage(def.processing.core.PGraphics applet)

draw

public void draw(def.processing.core.PGraphics graphics)

This method is called when calling world.draw(). This method may be overriden to allow custom drawing of the object.

Parameters:

graphics - the graphics onto which the object must be drawn.

drawDebug

public void drawDebug(def.processing.core.PGraphics graphics)

This method is called when calling world.drawDebug(). This method may be overriden to allow custom debug drawing of the object.

Parameters:

graphics - the graphics onto which the object must be drawn.

attachImage

public void attachImage(def.processing.core.PImage img)

Attach an image to the object. This method allows to draw an image onto the screen instead of calling the #draw(PApplet) method.

Parameters:

img - the PImage to attach to the object.

dettachImage

public void dettachImage()

Dettach any image that has been attached to the object.

See Also:

attachImage(PImage)

getImageAlpha

public float getImageAlpha()

Get the opacity with which to draw the attached image.

Returns:

the opacity, a value from 0.0 to 1.0 with which to draw the attached image

See Also:

attachImage(PImage), setImageAlpha(float)

setImageAlpha

public void setImageAlpha(float alpha)

Set the opacity with which to draw the attached image.

Parameters:

alpha - the opacity, a value from 0.0 to 1.0 with which to draw the attached image

See Also:

attachImage(PImage), getImageAlpha()

setDrawable

public void setDrawable(boolean drawable)

Set whether the object must be drawn or not.

Parameters:

drawable - if true the object will be drawn, else it will not

See Also:

isDrawable()

isDrawable

public boolean isDrawable()

Get whether the object must be drawn or not.

Returns:

drawable if true the object will be drawn, else it will not

See Also:

setDrawable(boolean)

getFillColor

public int getFillColor()

Returns the fill color of the object.

Returns:

a Processing color type. e.g. myBody.setFillColor(color(20,100,30,90));

See Also:

setNoFill(), setFill(float), setFill(float,float), setFill(float,float,float), setFill(float,float,float,float)

setFillColor

public void setFillColor(int col)

Set the fill color of the object. This method must be used in conjunction with Processing's color(). In most cases users will find it more convenient to use the versions of setFill(float), setFill(float,float), setFill(float,float,float) or setFill(float,float,float,float)

Parameters:

col - a Processing color type. e.g. myBody.setFillColor(color(20,100,30,90));

See Also:

setNoFill(), setFill(float), setFill(float,float), setFill(float,float,float), setFill(float,float,float,float)

setNoFill

public void setNoFill()

Set that the object must be drawn without fill.

See Also:

setFill(float), setFill(float,float), setFill(float,float,float), setFill(float,float,float,float)

setFill

public void setFill(float g)

Set the fill color of the object.

Parameters:

g - gray value

See Also:

setFill(float), setFill(float,float), setFill(float,float,float), setFill(float,float,float,float)

setFill

public void setFill(float g,
                    float a)

Set the fill color of the object.

Parameters:

g - gray value

a - alpha (opacity) value

See Also:

setFill(float), setFill(float,float), setFill(float,float,float), setFill(float,float,float,float)

setFill

public void setFill(float r,
                    float g,
                    float b)

Set the fill color of the object.

Parameters:

r - red value

g - green value

b - blue value

See Also:

setFill(float), setFill(float,float), setFill(float,float,float), setFill(float,float,float,float)

setFill

public void setFill(float r,
                    float g,
                    float b,
                    float a)

Set the fill color of the object.

Parameters:

r - red value

g - green value

b - blue value

a - alpha (opacity) value

See Also:

setFill(float), setFill(float,float), setFill(float,float,float), setFill(float,float,float,float)

setStrokeColor

public void setStrokeColor(int col)

Set the stroke color of the object. This method must be used in conjunction with Processing's color(). In most cases users will find it more convenient to use the versions of setStroke(float), setStroke(float,float), setStroke(float,float,float) or setStroke(float,float,float,float)

Parameters:

col - a Processing color type. e.g. myBody.setStrokeColor(color(20,100,30,90));

See Also:

setNoStroke(), setStroke(float), setStroke(float,float), setStroke(float,float,float), setStroke(float,float,float,float)

setNoStroke

public void setNoStroke()

Set that the object must be drawn without stroke.

See Also:

setStroke(float), setStroke(float,float), setStroke(float,float,float), setStroke(float,float,float,float)

setStroke

public void setStroke(float g)

Set the stroke color of the object.

Parameters:

g - gray value

See Also:

setStroke(float), setStroke(float,float), setStroke(float,float,float), setStroke(float,float,float,float)

setStroke

public void setStroke(float g,
                      float a)

Set the stroke color of the object.

Parameters:

g - gray value

a - alpha (opacity) value

See Also:

setStroke(float), setStroke(float,float), setStroke(float,float,float), setStroke(float,float,float,float)

setStroke

public void setStroke(float r,
                      float g,
                      float b)

Set the stroke color of the object.

Parameters:

r - red value

g - green value

b - blue value

See Also:

setStroke(float), setStroke(float,float), setStroke(float,float,float), setStroke(float,float,float,float)

setStroke

public void setStroke(float r,
                      float g,
                      float b,
                      float a)

Set the stroke color of the object.

Parameters:

r - red value

g - green value

b - blue value

a - alpha (opacity) value

See Also:

setStroke(float), setStroke(float,float), setStroke(float,float,float), setStroke(float,float,float,float)

setStrokeWeight

public void setStrokeWeight(float weight)

Set the stroke weight of the object.

Parameters:

weight - weight value in pixels

See Also:

setStroke(float), setStroke(float,float), setStroke(float,float,float), setStroke(float,float,float,float)