SDK:Types

From Vectorworks Developer
Jump to: navigation, search

.SDK|SDK ..SDK:Types|SDK Types ..VCOM:VCOM (Vectorworks Component Object Model)|VCOM Basics ..VCOM:Class Reference|VCOM Class Reference

What is this?

VectorWorks SDK provides predefined types for types. A plug-in must use those types to ensure correct communications with the SDK functions.

Note There are other types defined in the SDK, but the ones described in this article should be used since the others are declared obsolete.

Types

Standard C++ Types

Type Name Description
size_t A type suitable for representing the amount of memory. This is unsigned type.
bool Booolean value type.
float Real 32-bit number.
double Real 64-bit number.

Generic types

Type Name Description
Uint8 Unsigned 8-bit number
Sint8 Signed 8-bit number
Uint16 Unsigned 16-bit number
Sint16 Signed 16-bit number
Uint32 Unsigned 32-bit number
Sint32 Signed 32-bit number
Uint64 Unsigned 64-bit number
Sint64 Signed 64-bit number
Real32 Real 32-bit number
Real64 Real 64-bit number

Range constants:

Constant name Constnat value
kGSMaxUint8 255
kGSMaxUint16 65535
kGSMaxUint32 4294967295UL
kGSMaxUint64 18446744073709551615ULL
kGSMaxSint8 127
kGSMaxSint16 32767
kGSMaxSint32 2147483647L
kGSMaxSint64 9223372036854775807LL
kGSMinUint8 0
kGSMinUint16 0
kGSMinUint32 0UL
kGSMinUint64 0ULL
kGSMinSint8 (-128)
kGSMinSint16 (-32768)
kGSMinSint32 (-2147483647-1)
kGSMinSint64 (-9223372036854775808LL)

Strings

There is only one string class TXString.

TXStringArray defines array of string;

SDK Specific

Type name Description
MCObjectHandle Identificator of VectorWorks object. Used to recognize object instance.
OSType A 32-bit indetified number encoded as Four Character Code (e.g. 'ApfT')
InternalIndex Represents index to an object. This index is document dependent.
InternalName Represents name of an object. This name is document dependent.
ColorRef Color reference. Identificator of a color in the active color palette.
OpacityRef Opacity reference. Identificator of opacity.
WorldCoord Real number representing world coordinate in VectorWorks document. WorldCoord are always in units -- milimeters.
WorldArea Represents world coordinate area in VectorWorks document. (WorldCoord * WorldCoord)
WorldVolume Represents world coordinate volume in VectorWorks document. (WorldCoord * WorldCoord * WorldCoord)
WorldPt 2D point in the world coordinate system of the document. Defined by (x,y) WoordCoord values.
WorldPt3 3D point in the world coordinate system of the document. Defined by (x,y,z) WoordCoord values.
TransformMatrix Defines a word coordinate transformation in the document.

CallBackPtr

This is obsolete type. It represents VectorWorks callback pointer used with obsolete functions SDK:Obsolete Function Reference

The new callback mechanism involves VCOM:VCOM (VectorWorks Component Object Model) with interface VCOM:VectorWorks:ISDK.

WorldCoord Comparison

Magnitude-based WorldCoord Comparison Functions.

All WorldCoord comparisons must use these functions.

These WorldCoord comparison functions are necessary because most floating point numbers that are not whole numbers cannot be represented exactly (they have floating point approximations).

Double precision floating point numbers (doubles) are accurate to 15 digits, but we'll consider WorldCoords equal if they are the same up to the 13th significant digit (to allow for drift).

Note that these functions do and must take the magnitude of the values into account. 100,000,000,000,000 must be considered equal to 100,000,000,000,001, and 1.00000000000000 must be considered equal to 1.00000000000001.

WorldCoordsAreNearlyEqual

Boolean WorldCoordsAreNearlyEqual(WorldCoord n1, WorldCoord n2);

Using epsilon (kNearlyEqualEpsilonForWorldCoords = 1e-13) for comparison.

WorldCoordIsNearlyZero

Boolean WorldCoordIsNearlyZero(WorldCoord n);

Using epsilon (kNearlyEqualEpsilonForWorldCoords = 1e-13) for comparison.

WorldCoordsAreNotNearlyEqual

Boolean WorldCoordsAreNotNearlyEqual(WorldCoord n1, WorldCoord n2);

Using epsilon (kNearlyEqualEpsilonForWorldCoords = 1e-13) for comparison.

WorldCoord1_GE_WorldCoord2

Boolean WorldCoord1_GE_WorldCoord2(WorldCoord n1, WorldCoord n2);

Using epsilon (kNearlyEqualEpsilonForWorldCoords = 1e-13) for comparison.

WorldCoord1_GT_WorldCoord2

Boolean WorldCoord1_GT_WorldCoord2(WorldCoord n1, WorldCoord n2);

Using epsilon (kNearlyEqualEpsilonForWorldCoords = 1e-13) for comparison.

WorldCoord1_LE_WorldCoord2

Boolean WorldCoord1_LE_WorldCoord2(WorldCoord n1, WorldCoord n2);

Using epsilon (kNearlyEqualEpsilonForWorldCoords = 1e-13) for comparison.

WorldCoord1_LT_WorldCoord2

Boolean WorldCoord1_LT_WorldCoord2(WorldCoord n1, WorldCoord n2);

Using epsilon (kNearlyEqualEpsilonForWorldCoords = 1e-13) for comparison.

WorldCoordBumpedHigher

WorldCoord WorldCoordBumpedHigher(WorldCoord n);

Using epsilon (kNearlyEqualEpsilonForWorldCoords = 1e-13) for comparison.

WorldCoordBumpedLower

WorldCoord WorldCoordBumpedLower(WorldCoord n);

Using epsilon (kNearlyEqualEpsilonForWorldCoords = 1e-13) for comparison.

WorldCoordsAreRelativelyClose

Boolean WorldCoordsAreRelativelyClose(WorldCoord n1, WorldCoord n2, double ratio = 1e-7);

See Also

Personal tools
NamespacesFFFF

Variants
Actions
Advanced Search
See Also
Navigation
Toolbox