commit 9351ad55b30fd0fa592a1ccb3127378a75f0331a Author: Leszek Koltunski Date: Wed Jun 15 12:23:30 2016 +0100 comment cleanup in DistortedObject. diff --git a/src/main/java/org/distorted/library/DistortedObject.java b/src/main/java/org/distorted/library/DistortedObject.java index f7329f6..45fe9a4 100644 --- a/src/main/java/org/distorted/library/DistortedObject.java +++ b/src/main/java/org/distorted/library/DistortedObject.java @@ -304,7 +304,7 @@ public abstract class DistortedObject /////////////////////////////////////////////////////////////////////////////////////////////////// /** * Adds the calling class to the list of Listeners that get notified each time some event happens - * to one of the Effects that are currently applied to the DistortedBitmap. + * to one of the Effects that are currently applied to the DistortedObject. * * @param el A class implementing the EffectListener interface that wants to get notifications. */ @@ -534,7 +534,7 @@ public abstract class DistortedObject * Scales the Object by a factor that smoothly changes from (1,1,1) at time 0 to (xscale,yscale,zscale) * after 'duration' milliseconds. * - * @param xscale After time 'duration' passes, Bitmap's width will get multiplied by xscale; e.g. if + * @param xscale After time 'duration' passes, Object's width will get multiplied by xscale; e.g. if * xscale=2, after 'duration' milliseconds the Object will become twice broader. * @param yscale Factor to scale Object's height with. * @param zscale Factor to scale Object's depth with. @@ -649,7 +649,7 @@ public abstract class DistortedObject * Axis of rotation is the vector (0,0,1), i.e. a vector normal to the screen surface. * * @param center Coordinates of the Point we are rotating around. - * @param angle Angle that we want to rotate the Bitmap to. Unit: degrees + * @param angle Angle that we want to rotate the Object to. Unit: degrees * @param duration Time, in milliseconds, it takes to complete one rotation from 0 to 'angle' degrees. * @return ID of the effect added, or -1 if we failed to add one. */ @@ -670,7 +670,7 @@ public abstract class DistortedObject * Axis of rotation is given by the last 3 floats. * * @param center Coordinates of the Point we are rotating around. - * @param angle Angle that we want to rotate the Bitmap to. Unit: degrees + * @param angle Angle that we want to rotate the Object to. Unit: degrees * @param axisX Axis of rotation: x-coordinate * @param axisY Axis of rotation: y-coordinate * @param axisZ Axis of rotation: z-coordinate @@ -686,7 +686,7 @@ public abstract class DistortedObject * Rotates the Object immediately by 'angle' degrees around point p. * * @param center Coordinates of the Point we are rotating around. - * @param angle The angle that we want to rotate the Bitmap to. Unit: degrees + * @param angle The angle that we want to rotate the Object to. Unit: degrees * @return ID of the effect added, or -1 if we failed to add one. */ public long rotate(Float3D center, int angle) @@ -784,7 +784,7 @@ public abstract class DistortedObject * * @param size 1-dimensional Interpolator which, at any given time, returns the size of the macroblocks. * @param region Region this Effect is limited to. - * Null here means 'apply the effect to the whole Bitmap'. + * Null here means 'apply the effect to the whole Object'. * @param center 2-dimensional Interpolator which, at any given time, returns a Float2D representing the * current center of the effect. * @return ID of the effect added, or -1 if we failed to add one. @@ -803,7 +803,7 @@ public abstract class DistortedObject * * @param size 1-dimensional Interpolator which, at any given time, returns the size of the macroblocks. * @param region Region this Effect is limited to. - * Null here means 'apply the effect to the whole Bitmap'. + * Null here means 'apply the effect to the whole Object'. * @param center Center of the Effect. * @return ID of the effect added, or -1 if we failed to add one. */ @@ -822,7 +822,7 @@ public abstract class DistortedObject * * @param pixels Maximum size, in pixels, of the Macroblocks we want to see. * @param region Region this Effect is limited to. - * Null here means 'apply the effect to the whole Bitmap'. + * Null here means 'apply the effect to the whole Object'. * @param center 2-dimensional Interpolator which, at any given time, returns a Float2D representing the * current center of the effect. * @param duration Time, in milliseconds, it takes to do one full interpolation. @@ -852,7 +852,7 @@ public abstract class DistortedObject * * @param pixels Maximum size, in pixels, of the Macroblocks we want to see. * @param region Region this Effect is limited to. - * Null here means 'apply the effect to the whole Bitmap'. + * Null here means 'apply the effect to the whole Object'. * @param center Center of the Effect. * @param duration Time, in milliseconds, it takes to do one full interpolation. * @param count Controls how many interpolations we want to do. See {@link Interpolator#setCount(float)} @@ -906,7 +906,7 @@ public abstract class DistortedObject * mixed with the next parameter 'color': pixel = (1-level)*pixel + level*color * @param color Color to mix. (1,0,0) is RED. * @param region Region this Effect is limited to. - * Null here means 'apply the Effect to the whole Bitmap'. + * Null here means 'apply the Effect to the whole Object'. * @param center 2-dimensional Interpolator which, at any given time, returns a Float2D representing * the current center of the effect. * @return ID of the effect added, or -1 if we failed to add one. @@ -926,7 +926,7 @@ public abstract class DistortedObject * mixed with the next parameter 'color': pixel = (1-level)*pixel + level*color * @param color Color to mix. (1,0,0) is RED. * @param region Region this Effect is limited to. - * Null here means 'apply the Effect to the whole Bitmap'. + * Null here means 'apply the Effect to the whole Object'. * @param center Center of the Effect. * @return ID of the effect added, or -1 if we failed to add one. */ @@ -943,7 +943,7 @@ public abstract class DistortedObject * pixel = (1-t)*pixel + t*color * @param color Color to mix. (1,0,0) is RED. * @param region Region this Effect is limited to. - * Null here means 'apply the Effect to the whole Bitmap'. + * Null here means 'apply the Effect to the whole Object'. * @param center 2-dimensional Interpolator which, at any given time, returns a Float2D representing the * current center of the effect. * @return ID of the effect added, or -1 if we failed to add one. @@ -963,7 +963,7 @@ public abstract class DistortedObject * pixel = (1-t)*pixel + t*color * @param color Color to mix. (1,0,0) is RED. * @param region The Region this Effect is limited to. - * Null here means 'apply the Effect to the whole Bitmap'. + * Null here means 'apply the Effect to the whole Object'. * @param center Center of the Effect. * @return ID of the effect added, or -1 if we failed to add one. */ @@ -976,7 +976,7 @@ public abstract class DistortedObject /** * Makes a certain sub-region of the Object smoothly change all three of its RGB components. *

- * Here the Effect applies to the whole bitmap. + * Here the Effect applies to the whole Object. * * @param blend Level of blend a given pixel will be mixed with the next parameter 'color': * pixel = (1-t)*pixel + t*color @@ -2144,10 +2144,10 @@ public abstract class DistortedObject // DEFORM /** * Deform the shape of the whole Object with a (possibly changing in time) vector of force applied to - * a (possibly changing in time) point on the Bitmap. + * a (possibly changing in time) point on the Object. * * @param vector Interpolator that, at any given time, returns a Float2D representing vector of - * force that deforms the shape of the whole Bitmap. + * force that deforms the shape of the whole Object. * @param center 2-dimensional Interpolator that, at any given time, returns a Point2D representing * the Center of the Effect. * @return ID of the effect added, or -1 if we failed to add one. @@ -2160,10 +2160,10 @@ public abstract class DistortedObject /////////////////////////////////////////////////////////////////////////////////////////////////// /** * Deform the shape of the whole Object with a (possibly changing in time) vector of force applied to - * a constant point on the Bitmap. + * a constant point on the Object. * * @param vector Interpolator that, at any given time, returns a Float2D representing - * vector of force that deforms the shape of the whole Bitmap. + * vector of force that deforms the shape of the whole Object. * @param center Center of the Effect. * @return ID of the effect added, or -1 if we failed to add one. */