Core/com.benomad.msdk.core.svs/Form

Form

abstract class Form : CPPAdapter

Defines the abstraction layer of all geometric (and none geometric) forms handled by the SVS format.

Since

v2.5.0 Added getNbAttributes,getAttributes and Create methods

Inheritors

Types

Link copied to clipboard
enum GeoType
An enumeration that defines all possible types of geometric object.

Properties

Link copied to clipboard
val ABSTRACT: Byte = 0
Defines a SVS Form with no geometry
Link copied to clipboard
open var address: Long
Link copied to clipboard
val ELLIPSE: Byte = 3
Defines a (possibly multi) ellipse
Link copied to clipboard
val POINT: Byte = 8
Defines a (possibly multi) point
Link copied to clipboard
val POLYGON: Byte = 1
Defines a (possibly multi) polygon
Link copied to clipboard
val POLYLINE: Byte = 6
Defines a (possibly multi) polyline
Link copied to clipboard
val RECTANGLE: Byte = 2
Defines a (possibly multi) rectangle

Functions

Link copied to clipboard
abstract fun copy(copyAttributes: Boolean): Form
Clones this SVS form with or without its attribute(s).
Link copied to clipboard
open fun create(objID: ObjectId): Array<Form>
open fun create(objID: ObjectId, getAttributes: Boolean): Array<Form>
Creates the SVS Forms related to the specified Object Identifier.
Link copied to clipboard
open fun dispose()
Call this method if you want to dispose immediately all underlying native resources.
Link copied to clipboard
open fun geoType(): Form.GeoType
Returns the form's geometry type.
Link copied to clipboard
open fun getAttributes(): Array<Attribute>
Returns all attributes attached to this form (Assuming your SVS dataset is UTF-8 encoded).
open fun getAttributes(fromUnicode: Boolean): Array<Attribute>
Returns all attributes attached to this form.
Link copied to clipboard
open fun getBoundingRect(): GeoRect
Returns the 2D form's bounding rectangle.
Link copied to clipboard
open fun getGeoType(): Byte
Returns the form's geometry type.
Link copied to clipboard
open fun getNbAttributes(): Int
Returns the number of form's attributes.
Link copied to clipboard
open fun getNbForms(): Int
Returns the number of elementary geometric elements of form's geometry.
Link copied to clipboard
open fun is3D(): Boolean
Returns true if this form is a 3D form.
Link copied to clipboard
open fun isOwned(): Boolean
Check whether this SVS Form is already handled by a SVS.
Link copied to clipboard
open fun setAttribute(index: Int, att: Attribute, fromUnicode: Boolean)
Set/update the value of an existing attribute.