Kōtuku
  • Gallery
  • API
  • Wiki
  • GitHub
    • Audio
    • Config
    • Core
    • Display
    • Document
    • Font
    • HTTP
    • Network
    • Regex
    • SVG
    • Tiri
    • Vector
    • XML
    • XQuery
    • XRandR
      • Audio
      • MP3
      • Sound
      • File
      • MetaClass
      • Module
      • StorageDevice
      • Task
      • Thread
      • Time
      • Compression
      • CompressedStream
      • Config
      • LZMAStream
      • Script
      • Tiri
      • XML
      • XQuery
      • Controller
      • BlurFX
      • ColourFX
      • CompositeFX
      • ConvolveFX
      • DisplacementFX
      • FilterEffect
      • FloodFX
      • ImageFX
      • LightingFX
      • MergeFX
      • MorphologyFX
      • OffsetFX
      • RemapFX
      • SourceFX
      • TurbulenceFX
      • WaveFunctionFX
      • Scintilla
      • Bitmap
      • Clipboard
      • Display
      • Document
      • Font
      • Image
      • Pointer
      • Surface
      • SVG
      • ClientSocket
      • HTTP
      • NetClient
      • NetLookup
      • NetServer
      • NetSocket
      • Proxy
      • Gradient
      • GradientConic
      • GradientContour
      • GradientDiamond
      • GradientDiffusion
      • GradientDistal
      • GradientGouraud
      • GradientLinear
      • GradientMesh
      • GradientRadial
      • GradientVoronoi
      • Vector
      • VectorClip
      • VectorColour
      • VectorEllipse
      • VectorFilter
      • VectorGradient
      • VectorGroup
      • VectorImage
      • VectorPath
      • VectorPattern
      • VectorPolygon
      • VectorRectangle
      • VectorScene
      • VectorShape
      • VectorSpiral
      • VectorText
      • VectorTransition
      • VectorViewport
      • VectorWave
      • Linux Builds
      • Windows Builds
      • Customising Your Build
      • Kōtuku Objects
      • Kōtuku In Depth
      • Kōtuku Design Patterns
      • Coding With AI
      • Regex Manual
      • XML Comparisons
      • Tiri Reference Manual
      • Config API
      • Defer Syntax
      • GUI API
      • HTTP Server API
      • I/O API
      • JSON API
      • OAuth API
      • Options API
      • Proxy Server API
      • Tempus API
      • URL API
      • VFX API
      • Widgets
      • RIPL Reference Manual
      • Origo
      • Flute / Unit Testing
      • Tuku
      • Embedded Document Format
      • TDL Reference Manual
      • TDL Tools
      • Action Reference Manual
      • System Error Codes

VectorRectangle Class

Extends the Vector class with support for generating rectangles.

VectorRectangle extends the Vector class with the ability to generate rectangular paths.

Structure

The VectorRectangle class consists of the following fields:

Access
NameTypeComment
 HeightUNITThe height of the rectangle. Can be expressed as a fixed or scaled coordinate.

The height of the rectangle is defined here as either a fixed or scaled value. Negative values are permitted (this will flip the rectangle on the vertical axis).

 RoundXUNITSpecifies the size of rounded corners on the horizontal axis.

The corners of a rectangle can be rounded by setting the RoundX and RoundY values. Each value is interpreted as a radius along the relevant axis. A value of zero (the default) turns off this feature.

 RoundYUNITSpecifies the size of rounded corners on the vertical axis.

The corners of a rectangle can be rounded by setting the RoundX and RoundY values. Each value is interpreted as a radius along the relevant axis. A value of zero (the default) turns off this feature.

 RoundingUnit []Precisely controls rounded corner positioning.

Set the Rounding field if all four corners of the rectangle need to be precisely controlled. Four X,Y sizing pairs must be provided in sequence, with the first describing the top-left corner and proceeding in clockwise fashion. Each pair of values is equivalent to a RoundX,RoundY definition for that corner only.

 WidthUNITThe width of the rectangle. Can be expressed as a fixed or scaled coordinate.

The width of the rectangle is defined here as either a fixed or scaled value. Negative values are permitted (this will flip the rectangle on the horizontal axis).

 XUNITThe left-side of the rectangle. Can be expressed as a fixed or scaled coordinate.
 XOffsetUNITThe right-side of the rectangle, expressed as a fixed or scaled offset value.
 YUNITThe top of the rectangle. Can be expressed as a fixed or scaled coordinate.
 YOffsetUNITThe bottom of the rectangle, expressed as a fixed or scaled offset value.

Actions

The following actions are currently supported:

MoveMoves the vector to a new position.
ERR acMove(*Object, DOUBLE DeltaX, DOUBLE DeltaY, DOUBLE DeltaZ)
ParameterDescription
DeltaXThe number of units to move along the X axis.
DeltaYThe number of units to move along the Y axis.
DeltaZThe number of units to move along the Z axis.
MoveToPointMoves the vector to a new fixed position.
ERR acMoveToPoint(*Object, DOUBLE X, DOUBLE Y, DOUBLE Z, MTF Flags)
ParameterDescription
XThe new X position to move the object to.
YThe new Y position to move the object to.
ZThe new Z position to move the object to.
FlagsSet the relevant MTF flag for each provided parameter.
ResizeChanges the rectangle dimensions.
ERR acResize(*Object, DOUBLE Width, DOUBLE Height, DOUBLE Depth)
ParameterDescription
WidthThe new width of the object.
HeightThe new height of the object.
DepthThe new depth of the object.
VectorRectangle class documentation © Paul Manias © 2010-2026