TINMAN 3D / REALTIME TERRAIN
Software Development Kit - User Manual
The LicenceDomain class represents the client-side functionality of a licence domain.
sealed class
|
LicenceDomain
|
||||
The
licence
domain
of
the
Tinman
3D
SDK
(tinman_3d).
public
static
readonly
field
|
Tinman
|
||
type
|
LicenceDomain
|
||
Remarks:
To
obtain
a
new
licence
manually,
you
can
use
the
Request
and
Request
methods
in
your
application
to
generate
a
licence
request.
Include
the
licence
request
file
in
your
email
to
sales@tinman3d.com
and
we
will
be
happy
to
complete
your
licence
request.
If
you
have
any
other
questions,
please
send
an
email
to:
info@tinman3d.com.
According to LicenceKey, the environment variable for the Tinman 3D SDK is this:
TINMAN_3D_LICENCEKEY = ...
Allow licence domain to be unlocked via licence key found in environment variable?
public
property
|
AllowUnlockByEnvironment
{
get
set
}
|
||
type
|
bool
|
||
value
|
true
to
allow
environment
variable
licence
key,
false
to
disable
it.
|
||
Remarks:
After the licence domain has been unlocked, setting this property has no longer any effect.
Defaults
to
true.
See also:
IsUnlockedByEnvironmentHas this licence domain been unlocked?
[ThreadSafe]
|
||||
public
property
|
IsUnlocked
{
get
}
|
|||
type
|
bool
|
|||
value
|
true
if
this
licence
domain
is
unlocked,
false
if
not. |
|||
Is this licence domain being activated from one of the licence keys that have been specified via LicenceKey?
public
property
|
IsUnlockedByApplication
{
get
}
|
||
type
|
bool
|
||
value
|
true
if
this
licence
domain
has
been
activated
from
one
of
the
licence
keys
that
have
been
specified
via
LicenceKey,
false
otherwise.
|
||
Remarks:
The TryUnlock method is called each time this property is get.
Is this licence domain being activated from the licence key that has been specified in the environment variable (see LicenceKey)?
public
property
|
IsUnlockedByEnvironment
{
get
}
|
||
type
|
bool
|
||
value
|
true
if
this
licence
domain
has
been
activated
from
the
licence
key
that
has
been
specified
in
the
environment
variable,
false
otherwise.
|
||
Remarks:
The TryUnlock method is called each time this property is get.
Machine-readable name of this licence domain.
public
property
|
Name
{
get
}
|
||
type
|
string
|
||
value
|
|
Licence domain name. | |
Creates a new instance of LicenceDomain.
public
constructor
|
LicenceDomain
(string name,
string comment,
Domain domain)
|
||
params
|
name
|
[not-empty]
|
The machine-readable domain name (see Name). |
comment
|
The human-readable domain comment to put into licence requests. | ||
domain
|
[not-null]
|
The licence domain worker object. | |
Generates a source code fragment for C# resp. C++ which reconstructs a licence key string using some pseudo-random arithmetic.
[Pure]
|
||||
public
static
method
|
GenerateLicenceKeySetup
(bool cpp,
string licenceKey,
string variableName = "licenceKey")
|
|||
type
|
string
|
|||
params
|
cpp
|
Generate
C++
source
code
(true),
or
C#
source
code
(false)?
|
||
licenceKey
|
[not-empty]
|
The Tinman 3D licence key string. | ||
variableName
|
[not-empty]
|
Name
of
the
variable
which
the
reconstructed
licence
key
string
will
be
assigned
to.
Defaults
to
'licenceKey'.
|
||
returns
|
|
The code fragment. | ||
Remarks:
You can use the source code fragment if you do not want to embed the licence key as a string literal into your binary.
The C# code fragment looks like this:
// Tinman 3D licence key:
// CIk!6Dh6Ui;lSE+Z{{jx7$Y~8,#TSt~o%CK#(e,F#O9.d;fGc+bU35%HVl;[.+s#@h.bo1~{riL.4|UreHfeuac}5ZV~DBocxU}@
{
sbyte[] licenceKeyData;
licenceKeyData = new sbyte[N+1];
licenceKeyData[0] = ?;
licenceKeyData[1] = (sbyte) (licenceKeyData[0] op ?);
...
licenceKeyData[N] = (sbyte) (licenceKeyData[N-1] op ?);
licenceKey = global::Tinman.Core.StringUtil.BinaryDecode(licenceKeyData);
}The
C++
code
fragment
looks
like
this:
// Tinman 3D licence key:
// CIk!6Dh6Ui;lSE+Z{{jx7$Y~8,#TSt~o%CK#(e,F#O9.d;fGc+bU35%HVl;[.+s#@h.bo1~{riL.4|UreHfeuac}5ZV~DBocxU}@
{
CodeX::int8* licenceKeyData;
licenceKeyData = new CodeX::int8[N+1];
licenceKeyData[0] = ?;
licenceKeyData[1] = static_cast<CodeX::int8> (licenceKeyData[0] op ?);
...
licenceKeyData[N] = static_cast<CodeX::int8> (licenceKeyData[N-1] op ?);
licenceKey = ::Tinman::Core::StringUtil::BinaryDecode(licenceKeyData);
delete[] licenceKeyData;
}where
'licenceKey'
is
the
variable
name
that
has
been
specified
via
the
variableName
parameter,
N+1
is
the
buffer
length
and
op
and
?
perform
pseudo-random
arithmetic
operations.
Specifies a licence key that shall be used to unlock this licence domain.
[ThreadSafe]
|
||||
public
method
|
LicenceKey
(string licenceKey)
|
|||
params
|
licenceKey
|
The licence key (will be normalized if necessary, see LicenceKeyNormalize. | ||
Remarks:
Each licence key is a string of 100 characters, interpreted as a base-85 number using printable ASCII characters as digits (whitespaces are ignored). These characters will never be used in a licence key string:
"&'/<>\]`This allows licence keys to be put into string literals or XML files. Here is an example key:
CIk!6Dh6Ui;lSE+Z{{jx7$Y~8,#TSt~o%CK#(e,F#O9.d;fGc+bU35%HVl;[.+s#@h.bo1~{riL.4|UreHfeuac}5ZV~DBocxU}@Please
note
that
the
example
key
above
is
invalid.
You
must
specify
at
least
one
valid
one
before
using
the
Tinman
3D
SDK.
An application can specify any number of licence keys. Upon first call to Unlock request, the licence domain is unlocked; for this at least one valid licence key must have been specified. All invalid licence keys are ignored silently.
A
licence
key
can
optionally
be
specified
via
a
user
environment
variable
named
{NAME}_LICENCEKEY,
where
{NAME}
is
the
value
of
Name,
converted
to
uppercase.
Licence
keys
specified
via
LicenceKey
have
precedence
over
the
environment
variable
key.
Normalizes the given licence key string.
public
static
method
|
LicenceKeyNormalize
(string licenceKey)
|
||
type
|
string
|
||
params
|
licenceKey
|
The licence key string. | |
returns
|
The
normalized
licence
key
string,
containing
exactly
100
base-85
characters,
or
null.
|
||
Formulates a licence request for this licence domain.
public
method
|
Request
(LicenceMetadata metadata,
Path path = null)
|
||
type
|
Path
|
||
params
|
metadata
|
User licence metadata for the licence key. | |
path
|
Optional
directory
for
licence
request
file.
If
null,
the
file
will
be
stored
in
the
current
users
home
directory.
Defaults
to
null.
|
||
returns
|
|
Path to licence request file. | |
Remarks:
The licence request is a human-readable JSON value (see From). The licence request file is a text file with UTF-8 encoding (see UTF_8) and leading byte-order marks.
When a licence key is granted for the returned request, it will allow the enclosing environment (see LicenceType) to activate this licence domain.
Formulates a licence request for this licence domain.
public
method
|
Request
(LicenceType type,
Path path = null)
|
||
type
|
Path
|
||
params
|
type
|
The licence type to request. | |
path
|
Optional
directory
for
licence
request
file.
If
null,
the
file
will
be
stored
in
the
current
users
home
directory.
Defaults
to
null.
|
||
returns
|
|
Path to licence request file. | |
Remarks:
The licence request is a human-readable JSON value (see From). The licence request file is a text file with UTF-8 encoding (see UTF_8) and leading byte-order marks.
When a licence key is granted for the returned request, it will allow the enclosing environment (see LicenceType) to activate this licence domain.
Checks if this licence domain has been unlocked.
[ThreadSafe]
|
||||
public
method
|
TryUnlock
()
|
|||
type
|
bool
|
|||
returns
|
true
if
unlocked,
false
when
still
locked. |
|||
Remarks:
When this licence domain is still unlocked, the method will try to unlock it using the set of specified licence keys (see LicenceKey). On success, the program will continue to execute normally. On failure, an exception will be thrown.
Checks if this licence domain has been unlocked.
[ThreadSafe]
|
||||
public
method
|
Unlock
()
|
|||
Remarks:
When this licence domain is still unlocked, the method will try to unlock it using the set of specified licence keys (see LicenceKey). On success, the program will continue to execute normally. On failure, an exception will be thrown.
Exceptions:
Unlocks a protected content file.
public
static
method
|
UnlockContent
(Path content,
string licenceKey)
|
||
type
|
Path
|
||
params
|
content
|
[not-null]
|
Path to the unprotected content file. |
licenceKey
|
[not-null]
|
The licence key to use. | |
returns
|
The
canonical
path
to
the
unlocked
content
file
or
null
if
licenceKey
cannot
be
used
to
unlock
content |
||
Remarks:
The
unlocked
content
will
be
written
to
a
file
having
the
same
path
as
content,
without
the
file
suffix:
'.lic'.
Unlocks a protected byte array.
[ThreadSafe]
|
||||
public
method
|
UnlockInt8s
(int32 locked)
|
|||
type
|
int8[]
|
|||
params
|
locked
|
The identifier of the locked data item. | ||
returns
|
|
The unlocked byte array. | ||
Exceptions:
Unlocks a protected string value.
[ThreadSafe]
|
||||
public
method
|
UnlockString
(int32 locked)
|
|||
type
|
string
|
|||
params
|
locked
|
The identifier of the locked data item. | ||
returns
|
|
The unlocked string value. | ||
Exceptions:
The logger object of this class.
public
static
readonly
field
|
Logger
|
||
type
|
ILogger
|
||
info@tinman3d.com
| Copyright © 2012 - 2017 Matthias Englert, Fulda (Germany)