User Tools

Site Tools


api:dk11:net:tatukgis.ndk.tgis_layer

TGIS_Layer class

DK11 for .NET | TatukGIS.NDK.TGIS_Layer | Classes | Constructors | Fields | Methods | Properties | Events

General layer class. Must be derived to provide file access.

Available also on: Delphi | Java | ActiveX.

Syntax

// C#
public class TGIS_Layer : TGIS_LayerAbstract
{
}
' VisualBasic
Public Class TGIS_Layer
  Inherits TGIS_LayerAbstract
End Class
// Oxygene
type
  TGIS_Layer = public class( TGIS_LayerAbstract )
  end;

Inheritance

→ TGIS_BaseObjectDisposable → TGIS_LayerAbstract

Constructors

Inherited Overrides Protected
Name Visibility Description
TGIS_Layer() public Create a layer with default parameters.

Fields

Inherited Protected
Name Visibility Description
FActive protected Is layer active?
FAddition protected Addition value.
FAge protected Age of the layer.
FBasemap protected True if layer will be interpreted as basemap.
FCachedPaint protected False if layer must be painted directly (bypassing cache).
FCaption protected Layer caption.
FCodePage protected Code Page in which text has been stored.
FCodePageForced protected Code Page forced by project file or property setting.
FCollapsed protected Is layer collapsed?
FComments protected Additional comments.
FConfigFile protected Configuration file handle.
FConfigFile2 protected Configuration file handle.
FConfigName protected Configuration file name.
FCS protected Projection object.
FCustomData protected List of custom data.
FDormantMode protected Dormant mode for the layer.
FDriver protected Layer driver.
FExtent protected Layer extent.
FExtent3D protected Layer extent 3D.
FFileCopyright protected Additional textual information about layer copyright.
FFileInfo protected Additional textual information about the layer such as compression, number of pixels, copyright etc.
FHideFromLegend protected True, if layer should not be visible in a legend.
FIsLocked protected True, if layer is in locked state Lock.
FIsModified protected True, if structure (field, geometry etc).
FIsOpened protected True, if layer was opened.
FIsPrepared protected True, if layer was opened.
FIsReadOnly protected Read only flag.
FMaxTileSize protected Maximum allowed tile size for the layer.
FMultiUserMode protected Multiuser mode.
FName protected Layer name.
FOnBusy protected Busy event.
FOnPaintLayer protected PaintLayer event.
FOnPassword protected Will be fired upon opening layer to resolve any username/password
FOnRead protected Will be fired upon each file Read request.
FOnWrite protected Will be fired upon each file Write request.
forceCachedMode protected Set tor True to force cached (bitmap) type of drawing.
FParamsList protected List of parameters set (sections).
FParentLayer protected Parent layer.
FPath protected Layer path.
FProjectedExtent protected Precalculated projected extent.
FProjectedExtentBase protected Precalculated projected extent - Base extent (unprojected).
FProjectedExtentEPSG protected Precalculated projected extent - Layer CS Context.
FProjectedExtentRotationAngle protected Precalculated projected extent - Rotation context.
FProjectedExtentRotationPoint protected Precalculated projected extent - Rotation context.
FProjectedExtentViewerEPSG protected Precalculated projected extent - Viewer CS Context.
FRenderer protected Handle to a renderer used for drawing shapes.
FStatistics protected Statistics engine.
FStream protected Reference to a potential layer underlying stream.
FSubLayers protected Sub layers list.
FSubType protected Layer Type.
FTag protected Tag value.
FTagInternal protected Internal Tag value.
FTagPointer protected Pointer Tag value
FTransform protected Custom transformation.
FTransparency protected Transparency value.
FUnSupportedOperations protected Set of operations not supported by a layer.
FUseConfig protected Is config file active?
FUserObject protected User object.
FViewer protected Reference to viewer object.
inDraw protected True, if layer paint procedure not yet complete.
paramsCache protected List of prepared parameters.
View3D public 3D Representation properties.

Methods

Inherited Overrides Protected
Name Visibility Description
Alive public Makes a layer non-dormant.
applyConfigOptions protected Read config option parameters.
applyConfigProjection protected Read config projection parameters.
ApplyCuttingPolygon public Set cutting polygon for a layer.
ChangeHash public Change hash.
ClearModified public Set IsModified flag to false for a layer and its sublayers.
Dormant public Makes a layer dormant.
DormantGain public Calculate approximate gain (in Megabytes) which can be achieved by releasing memory by calling Dormant method.
Draw public Draws a layer.
DrawEx public Draws only selected item(s) on a layer with a given extent.
drawExtent protected Calculates the drawing area /clipping area of device/.
drawExtentEx protected Calculates the drawing area /clipping area of device/.
DrawFlash public Draws a flash.
DrawSelected public Draws only selected item(s) on a layer.
DrawSelectedEx public Draws a layer with given extent.
ForEachSubLayer public Return in callback event a layer and all sublayers that belong to it.
GetAvailableLayers public Get a list of layers available in storage.
HourglassShake public Notify using an hourglass of busy state.
IsGrid public Is layer a grid type.
IsPixel public Is layer a pixel type.
isSublayer protected Gives us information if layer is sublayer.
IsSupported public Is operation supported by the layer.
IsVector public Is layer a vector type.
IsVector3D public Is layer a 3Dvector type.
IsVisible public Check if layer is visible in given extent and current params.
Lock public Lock layer in burst-mode operation.
lockThread protected Lock thread.
Move public Move a layer up or down in the viewer zorder list.
MoveEx public Move a layer up or down in the viewer zorder list.
MustCalculateStatistics public Verify if all statistics required to properly render layer are available.
MustReproject public Check if layer must be reprojected.
MustSave public Check if the layer was modified by editing.
Open public Open the layer.
optimizeParamsCache(int) protected Move section specified by _idx to the top of the cached list.
optimizeParamsCache(int, bool) protected Move section specified by _idx to the top of the cached list.
Paint public Draws the layer or fires PaintLayer event ( if defined ).
Prepare public Open the layer.
prepareParamsCache protected Prepare cached section list meeting the _style name.
prepareParamsCache(string) protected Prepare cached section list meeting the _style name.
PreRecognize public Check if layer can read the file.
Project public Apply a projection on the single point.
Project3D public Apply a projection on the single point in 3D.
Project3D_Ref public Apply a projection on the single point in 3D.
projectExtent protected Project a given extent.
Project_Ref public Apply a projection on the single point.
RaiseBusyEvent public Fire Busy event of the layer.
RaiseBusyPrepare public Fire BusyPrepare method of viewer.
RaiseBusyRelease public Fire BusyRelease method of viewer.
RaiseBusyShake public Fire BusyShake method of viewer.
ReadConfig public Read layer configuration files.
ReadConfigParam public Read layer configuration parameters.
RecalcExtent public Recalculate extent based on real shapes.
RecalcProjectedExtent public Recalculate a projected extent.
ReOpen public Reopen the layer.
RereadConfig public Reread layer configuration files.
resetMustReproject protected Reset MustReporoject state.
RevertAll public Revert layer to its original content.
RootLayer public Return absolute parent layer.
SaveAll public Save layer and destroy mirrored items.
SaveData public Save layer and destroy mirrored items.
SetCSByEPSG public Setup Coordinate System to a coordinate system provided by EPSG code.
SetCSByWKT public Setup Coordinate System to a coordinate system provided by WKT string (GEOGCS or PROJCS).
SetCSByWKTFile public Setup Coordinate System to a coordinate system provided by file which contains WKT string (GEOGCS or PROJCS).
setUp protected Makes a general layer setup first step.
setUp2 protected Makes a general layer setup second step.
setUp3 protected Makes a general layer setup third step.
storeConfigOptions protected Store layer options in a configuration file.
transformExtent protected Custom transformation of the extent.
Unlock public Unlock layer from burst-mode operation.
unlockThread protected Unlock thread.
Unproject public Apply reverse projection (recover from projection) on the single point.
Unproject3D public Apply reverse projection (recover from projection) on the single point in 3D.
Unproject3D_Ref public Apply reverse projection (recover from projection) on the single point in 3D.
unprojectExtent protected Unproject a given extent.
Unproject_Ref public Apply reverse projection (recover from projection) on the single point.
WriteConfig public Write layer configuration files.

Properties

Inherited Protected
Name Visibility Description
Active public Is the Layer active? Active means that it can be visible, and that an object can be localized on the layer.
Addition public Additional value.
Age public Age of the layer.
Basemap public True if layer must be interpreted as basemap (for background painting).
CachedPaint public False if layer must be painted directly (bypassing cache).
Caption public Caption of layer; if not filed directly then will be filed with Name when adding to the Viewer.
CodePage public Code Page in which text has been stored.
Collapsed public Is the Layer collapsed? Collapsed means that inside the legend only the layer's title will be visible.
Comments public Additional user comments.
ConfigFile public Configuration file handle.
ConfigName public Configuration file name.
CS public Coordinate System assigned to the layer.
CustomData public List of custom, user-defined data.
DirectMode public True if the layer is direct-mode (bypassing cache).
DormantMode public Dormant mode for the layer.
Driver public Layer driver name.
Extent public Extent of the layer.
Extent3D public Extent 3D of the layer.
FileCopyrights public Copyright information about the layer.
FileInfo public Additional textual information about the layer such as compression, number of pixels, copyright, etc.
HideFromLegend public False if layer should not be visible in legend.
IsExportable public True if layer is exportable.
IsLocked public True if layer is in Locked state.
IsOpened public True if layer is opened and is ready for operations.
IsPersistent public True if layer is persistent.
IsReadOnly public Is layer read only.
IsTopmost public True if layer can be interpreted as the topmost (trackable).
MaxTileSize public Maximum allowed tile size for the layer.
MultiUserMode public Multiuser mode.
Name public Name of layer; if not filled directly then will be filled with Path when adding to the Viewer.
Params public Parameters (colors, fills, etc) object.
ParamsList public List of all parameter sections attached to the current layer.
ParentLayer public Parent layer of sub layer.
Path public Path to file with layer data.
PathWithDriver public Path to file with layer data extended with driver name.
ProjectedExtent public Extent of the layer in projected units.
Renderer public Handle to a renderer used for drawing shapes.
Statistics public Layer statistics engine
Stream public Reference to a potential layer underlying stream.
SubLayers public Sub layers list.
SubType public Sub layer type.
Tag public Tag has no predefined meaning.
TagInternal public TagInternal has no predefined meaning.
TagPointer public TagPointer has no predefined meaning.
Transform public Custom transformation.
Transparency public Transparency value.
UnSupportedOperations public Set of operations not supported by the layer.
UseConfig public Is config file active?
UserObject public UserObject can be used to associate with the layer a user defined object.
Viewer public Reference to viewer object.
ZOrder public Layer position relative to other layers.
ZOrderEx public Layer position relative to other layers.

Events

Inherited Protected
Name Visibility Description
BusyEvent public Busy event.
PaintLayerEvent public PaintLayer event.
PasswordEvent public Password event.
ReadEvent public Read event.
WriteEvent public Write event.

References

2019/09/27 01:16