🌀 Отладка скриптов

Скрипты в 3DCoat могут быть сложными: ведь они пишутся на AngelScript, а с этим языком уже связано довольно много больших и успешных проектов.

Поэтому, при написания своего скрипта, тебе может понадобиться знать значения некоторых переменных в процессе выполнения. И ты можешь это узнать.

Этот код включаем в начало своих скриптов и получаем возможность

• печатать в лог-файл (log)
• рисовать на сцене (drw)

// доступ к отладке
Debug dbg;


void main() {

    // текстовый лог
    // открывается из меню "Скрипты / Посмотреть журнал выполнения"
    DebugLog log = dbg.log();
    // подготавливаем текстовый лог
    log.clear();

    // вьюпорт
    // графику видишь сразу
    DebugDraw drw = dbg.draw();
    // подготавливаем вьюпорт
    //   1) очищаем
    //   2) выбираем цвет кисти по умолчанию
    drw.clear().color( 0xFFFFEE00 );

    // дальше пишем что хотим показать / отобразить
    // ...
}

Что можем печатать в лог?

// значения конкретных переменных
float delta = 1.2345;
log += delta;

// результаты математических операций
log += pow( a, 3 ) * sqrt( 2 ) / 12;

// текст / заметку
log +=
    "This is a debug-note."
    " We do treat variables provisionally as constants.";

// все объявленные локальные переменные
log += dbg.vars();
// или (дальше, когда неск. вариантов, пишу без "или")
log += dbg.variables();

// все объявленные глобальные переменные
log += dbg.gvars();
log += dbg.globalVariables();

// текущий стек вызовов
log += dbg.callstack();

// меш
// структура меша появится в виде текста
Builder builder;
const Mesh a = builder.cylinder()
  .positionTop( Vec3( 0, 120, 0 ) )
  .positionBottom( Vec3( 0, 0, 0 ) )
  .radiusTop( 50 )
  .radiusBottom( 50 )
  .details( 0.1 )
  ();
log += a;

Что можем отобразить во вьюпорт?

// точку
// point( position, color )
drw.point( Vec3( 50, 0, 0 ) );
drw.point( Vec3( 50, 60, 0 ), Color( 0xFFAAFF33 ) );

// линию
// line( startPosition, endPosition, startColor, endColor )
drw.line( Vec3( 0, 0, 0 ), Vec3( 100, 50, 25 ) );
drw.line( Vec3( 0, 50, 0 ), Vec3( 0, 200, 25 ),
    Color( 0xFF33FF33 ) );
drw.line( Vec3( 100, 120, 0 ), Vec3( 100, 250, 25 ),
    Color( 0xFFAA0000 ), Color( 0xFF0000AA ) );

// круг
// circle( position, normal, radius, color )
drw.circle( Vec3( 0, 0, 0 ), Vec3( 100, 50, 25 ), 20 );
drw.circle( Vec3( 0, 50, 0 ), Vec3( 0, 200, 25 ), 50,
    Color( 0xFF55FFAA ) );

// сферу
// sphere( position, radius, color )
drw.sphere( Vec3( 0, 0, 0 ), 15 );
drw.sphere( Vec3( 0, 50, 0 ), 45,
    Color( 0x9955FFAA ) );

// треугольник
// triangle( A, B, C, colorA, colorB, colorC )
const Vec3  a( 0, 0, 0 );
const Vec3  b( 80, 30, 70 );
const Vec3  c( 10, 25, 100 ) );
drw.triangle( a, b, c );
drw.triangle( a, b, c,
    Color( 0x77AA0000 ) );
drw.triangle( a, b, c,
    Color( 0xFFAA0000 ), Color( 0xFF00AA00 ), Color( 0xFF0000AA ) );

// надпись, число
// note( position, text )
drw.note( Vec3( 0, 0, 0 ),  "Note A" );
drw.note( Vec3( 0, 30, 0 ), "Note B",
    Color( 0xFF33FF33 ) );
drw.note( Vec3( 0, 0, 20 ),  111 );
drw.note( Vec3( 0, 30, 20 ), 222.51,
    Color( 0xFF33FF33 ) );

Векторы, матрицы, боксы и пр. здесь не перечисляем: очевидно, что они печатаются / визуализируются просто:

log += МойОбъектКоторыйХочуНапечатать;
drw += МойОбъектКоторыйХочуНарисовать;

Сложную визуализацию можно разбросать по слоям, чтобы отображать / скрывать их по отдельности:

drw += "First";
// или `drw.layer( "First" );`
// теперь всё ниже рисуется в слое `First`
// ...
drw += "Second";
// а теперь - в слое `Second`
// ...

См. также

🌀 Как создать свой скрипт

DebugDraw

DebugLog