ashatora/openlayers
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

Remove opt_ prefix

Browse Source
This commit is contained in:
Tim Schaub
2022-08-11 17:46:31 -06:00
committed by Tim Schaub
parent dd1edc37ca
commit 99612e7f9a
183 changed files with 1918 additions and 2079 deletions
Download Patch File Download Diff File Expand all files Collapse all files
src/ol/render/Event.js
+7 -7
View File
@@ -7,12 +7,12 @@ import Event from '../events/Event.js';
class RenderEvent extends Event {
/**
* @param {import("./EventType.js").default} type Type.
* @param {import("../transform.js").Transform} [opt_inversePixelTransform] Transform for
* @param {import("../transform.js").Transform} [inversePixelTransform] Transform for
* CSS pixels to rendered pixels.
* @param {import("../Map.js").FrameState} [opt_frameState] Frame state.
* @param {?(CanvasRenderingContext2D|WebGLRenderingContext)} [opt_context] Context.
* @param {import("../Map.js").FrameState} [frameState] Frame state.
* @param {?(CanvasRenderingContext2D|WebGLRenderingContext)} [context] Context.
*/
constructor(type, opt_inversePixelTransform, opt_frameState, opt_context) {
constructor(type, inversePixelTransform, frameState, context) {
super(type);
/**
@@ -21,14 +21,14 @@ class RenderEvent extends Event {
* @type {import("../transform.js").Transform|undefined}
* @api
*/
this.inversePixelTransform = opt_inversePixelTransform;
this.inversePixelTransform = inversePixelTransform;
/**
* An object representing the current render frame state.
* @type {import("../Map.js").FrameState|undefined}
* @api
*/
this.frameState = opt_frameState;
this.frameState = frameState;
/**
* Canvas context. Not available when the event is dispatched by the map. For Canvas 2D layers,
@@ -37,7 +37,7 @@ class RenderEvent extends Event {
* @type {CanvasRenderingContext2D|WebGLRenderingContext|undefined}
* @api
*/
this.context = opt_context;
this.context = context;
}
}
src/ol/render/Feature.js
+6 -6
View File
@@ -249,10 +249,10 @@ class RenderFeature {
* Get a transformed and simplified version of the geometry.
* @abstract
* @param {number} squaredTolerance Squared tolerance.
* @param {import("../proj.js").TransformFunction} [opt_transform] Optional transform function.
* @param {import("../proj.js").TransformFunction} [transform] Optional transform function.
* @return {RenderFeature} Simplified geometry.
*/
simplifyTransformed(squaredTolerance, opt_transform) {
simplifyTransformed(squaredTolerance, transform) {
return this;
}
@@ -373,19 +373,19 @@ export function toGeometry(renderFeature) {
/**
* Create an `ol/Feature` from an `ol/render/Feature`
* @param {RenderFeature} renderFeature RenderFeature
* @param {string} [opt_geometryName='geometry'] Geometry name to use
* @param {string} [geometryName='geometry'] Geometry name to use
* when creating the Feature.
* @return {Feature} Newly constructed `ol/Feature` with properties,
* geometry, and id copied over.
* @api
*/
export function toFeature(renderFeature, opt_geometryName) {
export function toFeature(renderFeature, geometryName) {
const id = renderFeature.getId();
const geometry = toGeometry(renderFeature);
const properties = renderFeature.getProperties();
const feature = new Feature();
if (opt_geometryName !== undefined) {
feature.setGeometryName(opt_geometryName);
if (geometryName !== undefined) {
feature.setGeometryName(geometryName);
}
feature.setGeometry(geometry);
if (id !== undefined) {
src/ol/render/VectorContext.js
+4 -4
View File
@@ -101,15 +101,15 @@ class VectorContext {
/**
* @param {import("../style/Image.js").default} imageStyle Image style.
* @param {import("../render/canvas.js").DeclutterImageWithText} [opt_declutterImageWithText] Shared data for combined decluttering with a text style.
* @param {import("../render/canvas.js").DeclutterImageWithText} [declutterImageWithText] Shared data for combined decluttering with a text style.
*/
setImageStyle(imageStyle, opt_declutterImageWithText) {}
setImageStyle(imageStyle, declutterImageWithText) {}
/**
* @param {import("../style/Text.js").default} textStyle Text style.
* @param {import("../render/canvas.js").DeclutterImageWithText} [opt_declutterImageWithText] Shared data for combined decluttering with an image style.
* @param {import("../render/canvas.js").DeclutterImageWithText} [declutterImageWithText] Shared data for combined decluttering with an image style.
*/
setTextStyle(textStyle, opt_declutterImageWithText) {}
setTextStyle(textStyle, declutterImageWithText) {}
}
export default VectorContext;
src/ol/render/canvas/Executor.js
+31 -33
View File
@@ -628,10 +628,10 @@ class Executor {
* @param {import("../../transform.js").Transform} transform Transform.
* @param {Array<*>} instructions Instructions array.
* @param {boolean} snapToPixel Snap point symbols and text to integer pixels.
* @param {FeatureCallback<T>} [opt_featureCallback] Feature callback.
* @param {import("../../extent.js").Extent} [opt_hitExtent] Only check
* @param {FeatureCallback<T>} [featureCallback] Feature callback.
* @param {import("../../extent.js").Extent} [hitExtent] Only check
* features that intersect this extent.
* @param {import("rbush").default} [opt_declutterTree] Declutter tree.
* @param {import("rbush").default} [declutterTree] Declutter tree.
* @return {T|undefined} Callback result.
* @template T
*/
@@ -641,9 +641,9 @@ class Executor {
transform,
instructions,
snapToPixel,
opt_featureCallback,
opt_hitExtent,
opt_declutterTree
featureCallback,
hitExtent,
declutterTree
) {
/** @type {Array<number>} */
let pixelCoordinates;
@@ -714,8 +714,8 @@ class Executor {
if (!feature.getGeometry()) {
i = /** @type {number} */ (instruction[2]);
} else if (
opt_hitExtent !== undefined &&
!intersects(opt_hitExtent, currentGeometry.getExtent())
hitExtent !== undefined &&
!intersects(hitExtent, currentGeometry.getExtent())
) {
i = /** @type {number} */ (instruction[2]) + 1;
} else {
@@ -899,13 +899,13 @@ class Executor {
? /** @type {Array<*>} */ (lastStrokeInstruction)
: null,
];
if (opt_declutterTree) {
if (declutterTree) {
if (declutterMode === 'none') {
// not rendered in declutter group
continue;
} else if (declutterMode === 'obstacle') {
// will always be drawn, thus no collision detection, but insert as obstacle
opt_declutterTree.insert(dimensions.declutterBox);
declutterTree.insert(dimensions.declutterBox);
continue;
} else {
let imageArgs;
@@ -921,20 +921,20 @@ class Executor {
imageArgs = declutterImageWithText[index];
delete declutterImageWithText[index];
imageDeclutterBox = getDeclutterBox(imageArgs);
if (opt_declutterTree.collides(imageDeclutterBox)) {
if (declutterTree.collides(imageDeclutterBox)) {
continue;
}
}
if (opt_declutterTree.collides(dimensions.declutterBox)) {
if (declutterTree.collides(dimensions.declutterBox)) {
continue;
}
if (imageArgs) {
// We now have image and text for an image+text combination.
opt_declutterTree.insert(imageDeclutterBox);
declutterTree.insert(imageDeclutterBox);
// Render the image before we render the text.
this.replayImageOrLabel_.apply(this, imageArgs);
}
opt_declutterTree.insert(dimensions.declutterBox);
declutterTree.insert(dimensions.declutterBox);
}
}
this.replayImageOrLabel_.apply(this, args);
@@ -1031,8 +1031,8 @@ class Executor {
feature
);
if (
opt_declutterTree &&
opt_declutterTree.collides(dimensions.declutterBox)
declutterTree &&
declutterTree.collides(dimensions.declutterBox)
) {
break drawChars;
}
@@ -1073,8 +1073,8 @@ class Executor {
feature
);
if (
opt_declutterTree &&
opt_declutterTree.collides(dimensions.declutterBox)
declutterTree &&
declutterTree.collides(dimensions.declutterBox)
) {
break drawChars;
}
@@ -1089,10 +1089,8 @@ class Executor {
]);
}
}
if (opt_declutterTree) {
opt_declutterTree.load(
replayImageOrLabelArgs.map(getDeclutterBox)
);
if (declutterTree) {
declutterTree.load(replayImageOrLabelArgs.map(getDeclutterBox));
}
for (let i = 0, ii = replayImageOrLabelArgs.length; i < ii; ++i) {
this.replayImageOrLabel_.apply(this, replayImageOrLabelArgs[i]);
@@ -1102,11 +1100,11 @@ class Executor {
++i;
break;
case CanvasInstruction.END_GEOMETRY:
if (opt_featureCallback !== undefined) {
if (featureCallback !== undefined) {
feature = /** @type {import("../../Feature.js").FeatureLike} */ (
instruction[1]
);
const result = opt_featureCallback(feature, currentGeometry);
const result = featureCallback(feature, currentGeometry);
if (result) {
return result;
}
@@ -1202,7 +1200,7 @@ class Executor {
* @param {import("../../transform.js").Transform} transform Transform.
* @param {number} viewRotation View rotation.
* @param {boolean} snapToPixel Snap point symbols and text to integer pixels.
* @param {import("rbush").default} [opt_declutterTree] Declutter tree.
* @param {import("rbush").default} [declutterTree] Declutter tree.
*/
execute(
context,
@@ -1210,7 +1208,7 @@ class Executor {
transform,
viewRotation,
snapToPixel,
opt_declutterTree
declutterTree
) {
this.viewRotation_ = viewRotation;
this.execute_(
@@ -1221,7 +1219,7 @@ class Executor {
snapToPixel,
undefined,
undefined,
opt_declutterTree
declutterTree
);
}
@@ -1229,8 +1227,8 @@ class Executor {
* @param {CanvasRenderingContext2D} context Context.
* @param {import("../../transform.js").Transform} transform Transform.
* @param {number} viewRotation View rotation.
* @param {FeatureCallback<T>} [opt_featureCallback] Feature callback.
* @param {import("../../extent.js").Extent} [opt_hitExtent] Only check
* @param {FeatureCallback<T>} [featureCallback] Feature callback.
* @param {import("../../extent.js").Extent} [hitExtent] Only check
* features that intersect this extent.
* @return {T|undefined} Callback result.
* @template T
@@ -1239,8 +1237,8 @@ class Executor {
context,
transform,
viewRotation,
opt_featureCallback,
opt_hitExtent
featureCallback,
hitExtent
) {
this.viewRotation_ = viewRotation;
return this.execute_(
@@ -1249,8 +1247,8 @@ class Executor {
transform,
this.hitDetectionInstructions,
true,
opt_featureCallback,
opt_hitExtent
featureCallback,
hitExtent
);
}
}
src/ol/render/canvas/ExecutorGroup.js
+10 -10
View File
@@ -30,7 +30,7 @@ class ExecutorGroup {
* @param {boolean} overlaps The executor group can have overlapping geometries.
* @param {!Object<string, !Object<import("../canvas.js").BuilderType, import("../canvas.js").SerializableInstructions>>} allInstructions
* The serializable instructions.
* @param {number} [opt_renderBuffer] Optional rendering buffer.
* @param {number} [renderBuffer] Optional rendering buffer.
*/
constructor(
maxExtent,
@@ -38,7 +38,7 @@ class ExecutorGroup {
pixelRatio,
overlaps,
allInstructions,
opt_renderBuffer
renderBuffer
) {
/**
* @private
@@ -68,7 +68,7 @@ class ExecutorGroup {
* @private
* @type {number|undefined}
*/
this.renderBuffer_ = opt_renderBuffer;
this.renderBuffer_ = renderBuffer;
/**
* @private
@@ -307,9 +307,9 @@ class ExecutorGroup {
* @param {import("../../transform.js").Transform} transform Transform.
* @param {number} viewRotation View rotation.
* @param {boolean} snapToPixel Snap point symbols and test to integer pixel.
* @param {Array<import("../canvas.js").BuilderType>} [opt_builderTypes] Ordered replay types to replay.
* @param {Array<import("../canvas.js").BuilderType>} [builderTypes] Ordered replay types to replay.
* Default is {@link module:ol/render/replay~ORDER}
* @param {import("rbush").default} [opt_declutterTree] Declutter tree.
* @param {import("rbush").default} [declutterTree] Declutter tree.
*/
execute(
context,
@@ -317,8 +317,8 @@ class ExecutorGroup {
transform,
viewRotation,
snapToPixel,
opt_builderTypes,
opt_declutterTree
builderTypes,
declutterTree
) {
/** @type {Array<number>} */
const zs = Object.keys(this.executorsByZIndex_).map(Number);
@@ -331,9 +331,9 @@ class ExecutorGroup {
this.clip(context, transform);
}
const builderTypes = opt_builderTypes ? opt_builderTypes : ORDER;
builderTypes = builderTypes ? builderTypes : ORDER;
let i, ii, j, jj, replays, replay;
if (opt_declutterTree) {
if (declutterTree) {
zs.reverse();
}
for (i = 0, ii = zs.length; i < ii; ++i) {
@@ -349,7 +349,7 @@ class ExecutorGroup {
transform,
viewRotation,
snapToPixel,
opt_declutterTree
declutterTree
);
}
}
src/ol/render/canvas/ImageBuilder.js
+3 -3
View File
@@ -244,9 +244,9 @@ class CanvasImageBuilder extends CanvasBuilder {
/**
* @param {import("../../style/Image.js").default} imageStyle Image style.
* @param {Object} [opt_sharedData] Shared data.
* @param {Object} [sharedData] Shared data.
*/
setImageStyle(imageStyle, opt_sharedData) {
setImageStyle(imageStyle, sharedData) {
const anchor = imageStyle.getAnchor();
const size = imageStyle.getSize();
const origin = imageStyle.getOrigin();
@@ -264,7 +264,7 @@ class CanvasImageBuilder extends CanvasBuilder {
this.scale_ = imageStyle.getScaleArray();
this.width_ = size[0];
this.declutterMode_ = imageStyle.getDeclutterMode();
this.declutterImageWithText_ = opt_sharedData;
this.declutterImageWithText_ = sharedData;
}
}
src/ol/render/canvas/Immediate.js
+6 -6
View File
@@ -45,8 +45,8 @@ class CanvasImmediateRenderer extends VectorContext {
* @param {import("../../extent.js").Extent} extent Extent.
* @param {import("../../transform.js").Transform} transform Transform.
* @param {number} viewRotation View rotation.
* @param {number} [opt_squaredTolerance] Optional squared tolerance for simplification.
* @param {import("../../proj.js").TransformFunction} [opt_userTransform] Transform from user to view projection.
* @param {number} [squaredTolerance] Optional squared tolerance for simplification.
* @param {import("../../proj.js").TransformFunction} [userTransform] Transform from user to view projection.
*/
constructor(
context,
@@ -54,8 +54,8 @@ class CanvasImmediateRenderer extends VectorContext {
extent,
transform,
viewRotation,
opt_squaredTolerance,
opt_userTransform
squaredTolerance,
userTransform
) {
super();
@@ -93,13 +93,13 @@ class CanvasImmediateRenderer extends VectorContext {
* @private
* @type {number}
*/
this.squaredTolerance_ = opt_squaredTolerance;
this.squaredTolerance_ = squaredTolerance;
/**
* @private
* @type {import("../../proj.js").TransformFunction}
*/
this.userTransform_ = opt_userTransform;
this.userTransform_ = userTransform;
/**
* @private
src/ol/render/canvas/TextBuilder.js
+3 -3
View File
@@ -524,9 +524,9 @@ class CanvasTextBuilder extends CanvasBuilder {
/**
* @param {import("../../style/Text.js").default} textStyle Text style.
* @param {Object} [opt_sharedData] Shared data.
* @param {Object} [sharedData] Shared data.
*/
setTextStyle(textStyle, opt_sharedData) {
setTextStyle(textStyle, sharedData) {
let textState, fillState, strokeState;
if (!textStyle) {
this.text_ = '';
@@ -628,7 +628,7 @@ class CanvasTextBuilder extends CanvasBuilder {
: '|' + getUid(fillState.fillStyle)
: '';
}
this.declutterImageWithText_ = opt_sharedData;
this.declutterImageWithText_ = sharedData;
}
}
src/ol/render/webgl/utils.js
+3 -3
View File
@@ -319,11 +319,11 @@ export function getBlankImageData() {
* Generates a color array based on a numerical id
* Note: the range for each component is 0 to 1 with 256 steps
* @param {number} id Id
* @param {Array<number>} [opt_array] Reusable array
* @param {Array<number>} [array] Reusable array
* @return {Array<number>} Color array containing the encoded id
*/
export function colorEncodeId(id, opt_array) {
const array = opt_array || [];
export function colorEncodeId(id, array) {
array = array || [];
const radix = 256;
const divide = radix - 1;
array[0] = Math.floor(id / radix / radix / radix) / divide;