com.azalient.api.b.display
Interface ISymbol

All Superinterfaces:

IDescribed, IRecord, RecordR, RecordRW, RecordW, SortableData, StoreRecordRW

public interface ISymbol
extends IDescribed, StoreRecordRW

A symbol is an extruded polygon used for decoration in the model.

It can be coloured, drawn filled or wireframe, and the line width of the edges can be changed

Field Summary

Fields inherited from interface com.azalient.api.a.tables.IRecord

DELETED, KEY_SEP, KEY_SEP_CHAR

Method Summary

NamedColour	colour() Return the colour of the symbol.
boolean	filled() Returns true if the symbol should be drawn filled (the default), otherwise wire-frame.
double	linewidth() Return the line width for the symbol.
IXyz	vertex(int i) Returns a given vertex, or null, if the index is outside [0 ...
int	vertices() The number of vertices in the symbol

Methods inherited from interface com.azalient.api.a.tables.IDescribed

description

Methods inherited from interface com.azalient.api.file.StoreRecordRW

canRename, rename, store

Methods inherited from interface com.azalient.api.file.RecordR

extraSet, finished, isApplicable, isEditable, set

Methods inherited from interface com.azalient.api.a.tables.IRecord

name

Methods inherited from interface com.azalient.api.file.RecordW

extraCols, extraGet, extraGetB, extraGetD, extraGetI, extraGetS, extraGetT, get, isVolatile

Method Detail

vertices

int vertices()

The number of vertices in the symbol

vertex

IXyz vertex(int i)

Returns a given vertex, or null, if the index is outside [0 ... n-1]

filled

boolean filled()

Returns true if the symbol should be drawn filled (the default), otherwise wire-frame.

linewidth

double linewidth()

Return the line width for the symbol. The default value is 1.0

colour

NamedColour colour()

Return the colour of the symbol.