User Tools

Site Tools


api:dk11:java:tatukgis.jdk.tgis_layerpixel.lockpixels_tgis_extent_tgis_cscoordinatesystem_double_integer_boolean

TGIS_LayerPixel.LockPixels(TGIS_Extent, TGIS_CSCoordinateSystem, double, int, bool) method

DK for Java | tatukgis.jdk.TGIS_LayerPixel.LockPixels | Overloads | Constructors | Fields | Methods | Properties | Events

Locks a fragment of the pixel layer for updating.

Available also on: Delphi | .NET | ActiveX | Python.

Syntax

// Java
public TGIS_LayerPixelLock LockPixels(
  TGIS_Extent _ext,
  TGIS_CSCoordinateSystem _cs,
  double _pixelsize,
  int _band,
  bool _writable
);
// Oxygene
public
  function LockPixels(
    _ext : TGIS_Extent;
    _cs : TGIS_CSCoordinateSystem;
    _pixelsize : Double;
    _band : Integer;
    _writable : Boolean
  ) : TGIS_LayerPixelLock; virtual;

Parameters

Name Type Description
_ext TGIS_Extent area to be locked; if bigger then layer extent then will be truncated to layer extent
_cs TGIS_CSCoordinateSystem coordinate system of _cs; if nil then same as layer CS
_pixelsize double
Double
minimum requested size of image pixel; by providing 0 a maximum possible resolution will be used, which is also a fastest method if a layer is full in-memory because in such situation a pointer to existing memory will be used
_band int
Integer
specific band to be locked
_writable bool
Boolean
if true than layer will post back any changes in locked area; if write is not possible then TGIS_LayerPixelLock.Writable will be set accordingly

Result

Type Description
TGIS_LayerPixelLock locked area

Remarks

Must be paired with UnlockPixels.

To speed-up operation, the function can return a larger area than requested. Use Bounds property of result value to obtain actual scope.

References

2025/01/31 01:16

Page Tools