GeoTransCreation namespace

Declared in: GeoTransformers.h

Describes the creational flags specifying how a GeoTransformer instance will be used.

[C++]

namespace GeoTransCreation {

typedef HANDLE HGeoTrans; // GeoTransformer handle

typedef DWORD GeoTrans_CreationFlags; // creational flags (bits 2-31 are reserved)

DWORD const trans_both =0x00// enable both FromGlobal & ToGlobal transformations

DWORD const trans_fromGlobal_only =1<<1// enable ONLY FromGlobal transformation

DWORD const trans_toGlobal_only =1<<2// enable ONLY ToGlobal transformation

};

using namespace GeoTransCreation;

Type Definitions

HGeoTrans

Instance handle of a valid custom GeoTransformer. It can be a pointer to a C data structure, an address of a C++ class instance, or anything else that your implementation understands and is being obtained by calling either Instance_Create, Instance_TryReuseCached or Instance_UnSerialize.

Will be passed as an argument to GeoTrans_FromGlobalDirection, GeoTrans_ToGlobalDirection and Instance_Serialize to identify the instance to be used in their implementation. It may point to any type of GeoTransformer supported by your implementation.

Any resources used by the GeoTransformer instance should be released by Instance_Discard function, including an associated serialization buffer, when generated.

GeoTrans_CreationFlags

A flag combination used as a hint when initializing GeoTransformers. Currently, only the first two least significant bits are used to specify in which directions are transformations required. Thus, expensive initialization for supporting both directions may be avoided. Constants for all its possible values are defined below.

Constants

Following table defines all possible values for type GeoTrans_CreationFlags:

Constant

Value

Description

trans_both

0x00

Enable both FromGlobal & ToGlobal transformations.

trans_fromGlobal_only

1<<1

Enable ONLY FromGlobal transformation.

trans_toGlobal_only

1<<2

Enable ONLY ToGlobal transformation.

Requirements

Platform

32 bit Windows OS

Environment

ANSI C / C++ Standard compliant

Dependency

kernel32.dll

Reference

kernel32.lib

Include

windows.h

Example

For a detailed example using this namespace, please see Custom GeoTransformer VC++ Sample.

Related Topics

Referenced By: Instance_Create, Instance_Discard, GeoTrans_FromGlobalDirection, GeoTrans_ToGlobalDirection, Instance_TryReuseCached, Instance_Serialize, Instance_UnSerialize