henc · Object, Symbol & Info

Object picking, depth map, S-52 ENC symbols, S-57 / S-52 information lookup

hencSelectObj

Prototype

int hencSelectObj( HENCOBJECT obj )

Function

Sets the specified object (Object) to be displayed in the selected shape.

Parameters

Object handle value retrieved using function

Return Value

= 0 : Success
< 0 : Fail

hencPickObj

Prototype

int hencPickObj( double x, double y, list &listObjs )

Function

The object being searched is limited by the display settings of the current screen. Points, lines, and areas within the range of about 10 pixels on the screen are searched with the current scale at the specified coordinates.
However, objects or map cells that are not currently displayed are excluded from the search.

Parameters

double x : IN (longitude, degree)
double y : IN (latitude, degree)
list &listObjs : IN, OUT (List of unique handle values for retrieved objects)

Return Value

= 0 : Success
< 0 : Fail

hencObjToString

Prototype

void hencObjToString( HENCOBJECT obj, string &str )

Function

Converts the details of the object into a string.

Parameters

HENCOBJECT obj : IN (Handle of ENC feature object)
It should be the value obtained from
string &str : IN, OUT (A string containing detailed information about the object.)

Return Value

None

hencGetFilenameOfObj

Prototype

const char *hencGetFilenameOfObj( HENCOBJECT obj )

Function

Searches the file containing the specified object and extracts the file name.

Parameters

It should be a value obtained from hencPickObj()

Return Value

!= NULL : File name, Null-terminated string
== NULL : File nou found(Fail)

hencObjGetCode

Prototype

EEncObject hencObjGetCode( HENCOBJECT obj )

Function

Obtains the S-57 object code value of the object.

Parameters

It should be the value obtained from

Return Value

S-57 Refer feature object catalog

hencObjGetPrimType

Prototype

EObjectPrimitiveType hencObjGetPrimType( HENCOBJECT obj )

Function

Find out the Primitive Type (point, line, face) of the object’s S-57 object.

Parameters

HENCOBJECT obj : IN (Handle of ENC feature object)
It should be the value obtained from

Return Value

See the S-57 feature object primitive type of the object

hencObjGetPoints

Prototype

int hencObjGetPoints( HENCOBJECT obj, S_OBJ_POLYGON *data )

Function

Obtains the coordinate information of S-57 object.

Parameters

HENCOBJECT obj : IN (Handle of ENC feature object)
It should be the value obtained from
S_OBJ_POLYGON * data : IN, OUT (S_OBJ_POLYGON *data)
It contains the information of the poly polygon as the structure of the following form.

Return Value

== 0 : Success
< 0 : Fail

hencDepthmapGenerate

Prototype

HENCDEPTHMAP hencDepthmapGenerate()

Function

Collect only depth information from all currently loaded ENC map cells.

Parameters

None

Return Value

!= 0 : Handle value of generated depth information
== 0 : Fail

hencDepthmapSave

Prototype

int hencDepthmapSave( HENCDEPTHMAP hdd, const char *fn )

Function

Save the created set of depth information to a file.

Parameters

HENCDEPTHMAP hdd : IN (Depth information handle value generated by .)
const char * fn : IN (Filename for storing depth information)

Return Value

= 0 : Success
< 0 : Fail

hencDepthmapLoad

Prototype

HENCDEPTHMAP hencDepthmapLoad( const char *fn )

Function

Read a set of depth information from a depth information file.

Parameters

const char *fn : IN (Filename for storing depth information)

Return Value

!= 0 : Handle value of depth information read
== 0 : Fail

hencDepthmapGetData

Prototype

int hencDepthmapGetData( HENCDEPTHMAP hdd, double x, double y, double &dep1, double &dep2 )

Function

Find depth information at specific coordinates in the depth information set.

Parameters

HENCDEPTHMAP hdd : IN (Handle value of the depth information set)
double x : IN (Longitude of depth information search location, degree)
double y : IN (Latitude of depth information search location, degree)
double &dep1 : OUT (Minimum depth)
double &dep2 : OUT (Maximum depth)

Return Value

= 0 : Success
< 0 : Fail

hencDepthmapDelete

Prototype

int hencDepthmapDelete( HENCDEPTHMAP hdd )

Function

Clear the memory occupied by the depth information set.

Parameters

HENCDEPTHMAP hdd : IN (Handle value of the depth information set)

Return Value

= 0 : Success
< 0 : Fail

hencGetEncSymbolCount

Prototype

int hencGetEncSymbolCount()

Function

Obtain the number of available S-52 symbols.

Parameters

None

Return Value

Number of symbols available in the library

hencGetEncSymbolName

Prototype

const char *hencGetEncSymbolName( int no )

Function

Obtain the name of the string for S-52 symbol number.

Parameters

int no : IN (Symbol number)

Return Value

!= NULL : Symbol name, Null-terminated string
Same as the name specified in the S-52 standard document
== NULL : Fail (Incorrect symbol number)

hencDrawEncSymbol

Prototype

int hencDrawEncSymbol( LPCTSTR name )

Function

Display the S-52 symbol on the screen.

Parameters

const char *name : IN (Null-terminated string)
Same as the name specified in the S-52 standard document

Return Value

= 0 : Success
< 0 : Fail

hencDrawEncSymbolAtGlPos

Prototype

int hencDrawEncSymbolAtGlPos( const char *name, double x, double y, double z, double angle = 0, double scale = 1.0 )

Function

Display the S-52 symbol on the screen.

Parameters

const char *name : IN (Null-terminated string, Same as the name specified in the S-52 standard document)
double x : IN (The x value of the OpenGL coordinate system)
double y : IN (The y value of the OpenGL coordinate system)
double z : IN (The z value of the OpenGL coordinate system)
double angle : IN (CW, Rotation Angle, degree)
double scale : IN (Zoom-in/Zoom-out value)

Return Value

= 0 : Success
< 0 : Fail

hencDrawEncSymbolAtWinPos

Prototype

int hencDrawEncSymbolAtWinPos( const char *name, double x, double y )

Function

Display the S-52 symbol on the screen.

Parameters

const chat *name : IN (Null-terminated string, Same as the name specified in the S-52 standard document)
double x : IN (The x value of the Window GDI coordinate system)
double y : IN (The y value of the Window GDI coordinate system)

Return Value

= 0 : Success
< 0 : Fail

hencDrawEncSymbolAtMapPos

Prototype

int hencDrawEncSymbolAtMapPos( const char *name, double x, double y )

Function

Display the S-52 symbol on the screen.

Parameters

const char *name : IN (Null-terminated string, Same as the name specified in the S-52 standard document)
double x : IN (longitude, degree)
double y : IN (latitude, degree)

Return Value

= 0 : Success
< 0 : Fail

hencGetEncLineCount

Prototype

int hencGetEncLineCount()

Function

Obtain the number of available S-52 Complex Lines.

Parameters

None

Return Value

Number of Complex Lines available in the library

hencGetEncLineName

Prototype

const char *hencGetEncLineName( int no )

Function

Obtain the name of the string for the S-52 Complex Line number.

Parameters

int no : IN (Complex Line number)

Return Value

!= NULL : String of Complex Line number, Null-terminated string
Same as the name specified in the S-52 standard document
== NULL : Fail (Incorrect number)

hencDrawEncLineAtGlPos

Prototype

int hencDrawEncLineAtGlPos( LPCTSTR name, double x1, double y1, double x2, double y2, double z )

Function

Display the S-52 complex line on the screen.

Parameters

LPCTSTR name : IN (Null-terminated string, Use the name obtained with )
double x1 : IN (The x value of the line starting point, OpenGL coordinate system)
double y1 : IN (The y value of the line starting point, OpenGL coordinate system)
double x2 : IN (The x value of the line end point, OpenGL coordinate system)
double y2 : IN (The y value of the line end point, OpenGL coordinate system)
double z : IN (z value in OpenGL coordinate system)

Return Value

= 0 : Success
< 0 : Fail

hencDrawEncLineAtWinPos

Prototype

int hencDrawEncLineAtWinPos( LPCTSTR name, double x1, double y1, double x2, double y2, double z )

Function

Display the S-52 complex line on the screen.

Parameters

LPCTSTR name : IN (Null-terminated string, Use the name obtained with )
double x1 : IN (The x value of the line start point, the Windows GDI coordinate system)
double y1 : IN (The y value of the line start point, the Windows GDI coordinate system)
double x2 : IN (The x value of the line end point, the Windows GDI coordinate system)
double y2 : IN (The y value of the line end point, the Windows GDI coordinate system)
double z : IN (The z value of the line, the OpenGL coordinate system)

Return Value

= 0 : Success
< 0 : Fail

hencDrawEncLineAtMapPos

Prototype

int hencDrawEncLineAtMapPos( LPCTSTR name, double x1, double y1, double x2, double y2, double z )

Function

Display the S-52 complex line on the screen.

Parameters

LPCTSTR name : IN (Null-terminated string, Use the name obtained with )
double x1 : IN (The longitude value of the line start point, degree, Geographic coordinate system)
double y1 : IN (The latitude value of the line start point, degree, Geographic coordinate system)
double x2 : IN (The longitude value of the line end point, degree, Geographic coordinate system)
double y2 : IN (The latitude value of the end start point, degree, Geographic coordinate system)
double z : IN (The z value of the line, the OpenGL coordinate system)

Return Value

= 0 : Success
< 0 : Fail

hencGetEncPatternCount

Prototype

int hencGetEncPatternCount()

Function

Obtain the number of available S-52 Fill patterns.

Parameters

None

Return Value

Number of Fill patterns available in the library

hencGetEncPatternName

Prototype

const char * hencGetEncPatternName( int no )

Function

Obtain the string name for S-52 Fill pattern number.

Parameters

int no : IN (Fill pattern number)

Return Value

!= NULL : String of pattern number, Null-terminated string
Same as the name specified in the S-52 standard document
== NULL : Fail (Incorrect pattern number)

hencDrawEncPatternFillAtGlPos

Prototype

int hencDrawEncPatternFillAtGlPos( LPCTSTR name, int cntPts, double *x, double *y, double z )

Function

Fill the given area with the S-52 fill pattern.

Parameters

LPCTSTR name : IN (Null-terminated string, S-52 fill pattern name, Use the name obtained with i>
int cntPts : Number of region polygon coordinates
double *x : IN (X coordinate array of region polygon, OpenGL coordinate system)
double *y : IN (Y coordinate array of region polygon, OpenGL coordinate system)
double z : IN (Z value of line, OpenGL coordinate system, same as all coordinates)

Return Value

= 0 : Success
< 0 : Fail

hencDrawEncPatternFillAtWinPos

Prototype

int hencDrawEncPatternFillAtWinPos( LPCTSTR name, int cntPts, double *x, double *y )

Function

Fill the given area with the S-52 fill pattern.

Parameters

LPCTSTR name : IN (Null-terminated string, S-52 fill pattern name, Use the name obtained with i>
int cntPts : Number of region polygon coordinates
double *x : IN (X coordinate array of region polygon, Windows GDI coordinate system)
double *y : IN (Y coordinate array of region polygon, Windows GDI coordinate system)

Return Value

= 0 : Success
< 0 : Fail

hencDrawEncPatternFillAtMapPos

Prototype

int hencDrawEncPatternFillAtMapPos( LPCTSTR name, int cntPts, double *x, double *y )

Function

Fill the given area with the S-52 fill pattern.

Parameters

LPCTSTR name : IN (Null-terminated string, S-52 fill pattern name, Use the name obtained with i>
int cntPts : Number of area polygon coordinates
double *x : IN (Longitude coordinate array of region polygon)
double *y : IN (Latitude coordinate array of region polygon)

Return Value

= 0 : Success
< 0 : Fail

hencGetColor

Prototype

COLORREF hencGetColor( EEncColor color )

Function

Refer S-52 Color

Parameters

EEncColor color : IN (S-52 color code value)

Return Value

RGB value

Prototype

COLORREF hencGetColor( EEncColorset setNo, EEncColor color )

Function

Refer S-52 Color

Parameters

EEncColorset setNo : Specify the color you want to acquire
EEncColor color : IN (S-52 color code value)

Return Value

RGB value

Prototype

COLORREF hencGetColor( const char *acronym )

Function

Refer S-52 Color

Parameters

const char *acronym : IN (S-52 color acronym string)

Return Value

RGB value

hencGetColorName

Prototype

const char * hencGetColorName( EEncColor color )

Function

Obtain an acronym corresponding to the color code.

Parameters

EEncColor color : IN (S-52 color code)

Return Value

!= NULL : S-52 color acronym string
== NULL : Fail (Incorrect string)

hencGetPrimName

Prototype

const char * hencGetPrimName( EObjectPrimitiveType t )

Function

Refer the S-57 ENC Object Primitive Type

Parameters

EObjectPrimitiveType t : IN (S-57 ENC Object Primitive Type)

Return Value

!= NULL : String
== NULL : Fail

hencGetObjectName

Prototype

const char * hencGetObjectName( EEncObject obj )

Function

Obtains the acronym string corresponding to the S-57 Feature Object Code.

Parameters

EEncObject obj : IN (S-57 Feature Object Code)

Return Value

!= NULL : String
== NULL : Fail

hencGetObjectDesc

Prototype

const char * hencGetObjectDesc( EEncObject obj )

Function

Obtains the description string corresponding to the S-57 Feature Object Code.

Parameters

EEncObject obj : IN (S-57 Feature Object Code)

Return Value

!= NULL : String
== NULL : Fail

hencGetAttrName

Prototype

const char * hencGetAttrName( EEncAttr attr )

Function

Obtain the acronym string corresponding to S-57 Feature Attribute Code.

Parameters

EEncAttr attr : IN (S-57 Feature Attribute Code)

Return Value

!= NULL : String
== NULL : Fail

hencEnumAttr

Prototype

EEncAttr hencEnumAttr( const char *acronym )

Function

Obtain the code value corresponding to S-57 feature attribute acronym.

Parameters

const char *acronym : IN (S-57 feature attribute acronym string)

Return Value

S-57 Feature Attribute Code

hencEnumObjectName

Prototype

EEncObject hencEnumObjectName( const char *acronym )

Function

Obtain the code value corresponding to S-57 feature attribute acronym.

Parameters

const char *acronym : IN (S-57 Feature Object acronym string)

Return Value

S-57 Feature Object Code