Tvorba aplikace ObjectARX

Přehled informací

• postup tvorby aplikace v kostce,
• vytvoření uživatelské třídy,
• význam zpráv AutoCADu,
  • zprávy zasílané všem aplikacím,
• implementace vstupního bodu pro AutoCAD,
  • syntaxe acrxEntryPoint ,
  • vysvětlení části kódu,
  • příklad kostry funkce s obsluhou zpráv,
• inicializace ObjectARX aplikace,
  • způsob inicializace,
• registrace nových příkazů,
  • syntaxe funkce pro registraci nových příkazů,
  • argumenty funkce pro registraci nových příkazů,
• příprava na odstranění aplikace,
  • nutné akce při ukončení aplikace,
• nahrání aplikace,
• odstranění aplikace,
• poznámka - zakázání odstranění aplikace.

Postup tvorby aplikace v kostce

Aplikace ObjectARX je dynamicky slinkovaná knihovna (DLL), která sdílí s AutoCADem adresový prostor a umožňuje přímé volání funkcí a prostředků AutoCADu. Tvorbu aplikace ObjectARX je možné rozdělit do několika kroků:

1. Vytvoření uživatelských tříd implementující nové příkazy.
2. Určení, které zprávy AutoCADu bude aplikace ObjectARX zpracovávat (využívat).
3. Implementace "vstupního bodu" do AutoCADu.
4. Inicializace všech uživatelských tříd, které jsme vytvořili.
5. Připravení aplikace na odstranění.

Tvorbu aplikace ObjectARX si můžeme zjednodušit pomocí ObjectARX Wizard.

Vytvoření uživatelské třídy

Uživatelské třídy je možné odvozovat od většiny tříd ObjectARX. Odvozování tříd se řídí stejnými pravidly jako v C++. Díky odvozování tříd se zvyšuje jejich funkčnost pro danou aplikaci.

Význam zpráv AutoCADu

AutoCAD posílá čtyři druhy zpráv:

• zprávy zaslané všem aplikacím,
• zprávy zaslané pouze aplikaci, která je registrovala funkci AutoLISPu pomocí acedDefun(),
• zprávy zaslané aplikaci, která má registrované služby s ObjectARX,
• zprávy pouze reagující na aplikace používající ActiveX automatizaci.

Další výklad uvádí pouze zprávy zasílané všem aplikacím, o dalších zprávách se dozvíte více v referenční příručce, jež je součástí SDK ObjectARX 2000.

Zprávy zasílané všem aplikacím

Implementace vstupního bodu pro AutoCAD

AutoCAD volá modul ObjectARX pomocí (přes) acrxEntryPoint(). Tuto funkci musí obsahovat všechny aplikace ObjectARX. Funkce acrxEntryPoint() nahrazuje funkci main(). Funkce acrxEntryPoint() slouží jako vstupní bod pro AutoCAD nebo jiné aplikace, funkce umožňuje komunikovat mezi aplikací a ObjectARX. ObjectARX komunikuje s okolním světem pomocí tzv. status kódů. Všechny požadavky pro volané funkce definované pomocí acedDefun() jsou vytvořeny pomocí acrxEntryPoint.

Syntaxe funkce acrxEntryPoint

  extern "C" AcRx::AppRetCode acrxEntryPoint 
     (AcRx::AppMsgCode msg, void *pkt);

Vysvětlení části kódu

• extern "C" - umožňuje volat funkce jazyka C v C++ programu,
• AcRx::AppRetCode - obsahuje status kódy vrácené AutoCADu,
• acrxEntryPoint() - volání funkce acrxEntryPoint,
• msg - reprezentuje správu poslanou jádru ObjectARX aplikace,
• pkt - drží hodnoty datových paketů.

V těle funkce acrxEntryPaint() se nachází příkaz switch (nebo podobná rozhodovací struktura) pro odchycení (správu) zpráv poslaných z AutoCADu. Pro každou zprávu poslanou z AutoCADu by zde měl být obslužný kód nebo volání obslužného kódu. Nakonec by funkce měla vrátit návratový kód (celé číslo) informující o průběhu funkce. Když funkce proběhne vpořádku měla by vrátit hodnotu AcRx::kRetOK.

Příklad kostry funkce s obsluhou zpráv

  extern "C" AcRx::AppRetCode acrxEntryPoint
    (AcRx::AppMsgCode msg, void *pkt)
  {
    switch (msg)
    {
      case AcRx::kInitAppMsg:
        break;
      case AcRx::kUnloadAppMsg:
        break;
            ....
      default:
        break;
    }
    return AcRx:;kRetOK
  }

Inicializace ObjectARX aplikace

V aplikaci ObjectARX musíme inicializovat všechny uživatelské třídy a příkazy. Inicializaci je možné provést v části, která odchytává zprávu AutoCADu AcRx::kInitAppMsg.

Způsob inicializace

1. Definujeme uživatelské třídy (pomocí funkce rxInit()).
2. Zavoláme funkci acrxBuildClassHierarchy(), aby se přestavěl strom tříd ObjectARX.
3. Inicializujeme všechny ostatní třídy.
4. Registrujeme jméno služby.
5. Nakonec registrujeme příkazy ve formátu příkazů AutoCADu. AutoCADu musíme sdělit jména nových příkazů definovaných naší aplikací, aby je mohl AutoCAD používat.

Registrace nových příkazů

Syntaxe funkce pro registraci nových příkazů

  Acad::ErrorStatus AcEdCommandStack::addCommand
  (
    const char* cmdGroupName,
    const char* cmdGlobalName,
    const char* cmdLocalName,
    Adesk::Int32 commandFlags,
    AcRxFunctionPtr functionAddr
  );

Argumenty příkazu funkce pro registraci nových příkazů

Příprava na odstranění aplikace

Když je naše aplikace odstraněna z AutoCADu, musíme zajistit, aby byly odstraněny i všechny uživatelské třídy nebo příkazy, které naše aplikace vytvořila. Veškeré akce související s odstraněním aplikace musíme umístit do části funkce acrxEntryPoint, která reaguje na zprávu AcRxUnloadAppMsg poslanou AutoCADem při odstranění aplikace.

Nutné akce při ukončení aplikace

1. Musíme odstranit všechny příkazy vytvořené pomocí funkcí acedRegCmds() a acedDefun(). Příkazy, které byly vytvořeny pomocí funkce acedRegCmds() lze odstranit i jako celou skupinu:

   Syntaxe funkce pro odstranění příkazu removeCmd():

    virtual Aced::ErrorStatus AcEdCommandStack::removeCmd
    ( const char* cmdGroupName, const char* cmdGlobalName) = 0;
   

   Příklad syntaxe odstranění celé skupiny příkazů:

    virtual Aced::ErrorStatus AcEdCommandStack::removeGroup
    (const char* cmdGroupName);
   

   Argumenty funkcí jsou buď jméno skupiny (cmdGroupName), případně i jméno příkazu (cmdglobalName).

2. Odstraníme všechny uživatelské třídy. K odstranění tříd použijeme funkci:

deleteAcRxClass()

funkce odstraní třídy z hierarchie AcRx hierarchického stromu tříd. POZOR třídy se musí odstraňovat od potomků směrem k rodičům.

3. Vymažte všechny reaktory přiřazené objektům:
   • AcDbObject,
   • AcDbDatabase,
   • AcRxDynamicLinker,
   • AcEditor.
4. Pokud jsme v aplikaci registrovali nějakou službu, musíme ji také odstranit. K odstranění služeb, které registrovala naše aplikace, použijeme funkci:

    acrxServiceDictionary->remove()
   

Nahrání aplikace

Aplikaci ObjectARX je možné nahrát v AutoCADu několika způsoby:

• pomocí prostředků umožňujících nahrání aplikace při akci v AutoCADu např. při nahrání výkresu,
• při spuštění AutoCADu. Aby byla aplikace automaticky nahrána při spuštění AutoCADu, musí být inicializována v inicializačním souboru acad.rx. Každý řádek v tomto souboru obsahuje jméno programu, který má být spustěn. U programu musí být uvedena celá cesta. Soubor acad.rx musí ležet ve vyhledávací cestě AutoCADu.
• pomocí požadavku na nahrání aplikace ObjectARX: AcRxDynamicLinker::loadModule();,
• použitím dialogového okna AutoCADu - APPLOAD,
• pomocí funkce AutoLISPu - arxload(),
• pomocí funkce acedArxLoad() v prostředí ObjectARX,
• napsáním ARX příkazu do příkazové řádky AutoCADu a použitím volby Load.

Odstranění aplikace

Aby bylo možné aplikaci odstranit z AutoCADu musí být aplikace odemčená. Pokud tomu tak je, je možné aplikaci odstranit způsoby:

• posláním požadavku na odstranění ObjectARX aplikace z jiné aplikace. Požadavek má tvar:

  AcRxDynamicLinker::unloadmodule();

• použitím dialogového okna AutoCADu - APPLOAD,
• pomocí funkce AutoLISPu - arxunload(),
• pomocí funkce acedArxUnload() v prostředí ObjectARX,
• napsáním ARX příkazu do příkazové řádky AutoCADu a použitím volby Unload.

Poznámka - zakázání odstranění aplikace

Aplikaci ObjectARX je možné zakázat odtranit. Aplikace se může vyskytovat ve dvou stavech:

• locked - aplikace je zamčená, nelze odstranit,
• unlocked - aplikace je odemčena, lze odstranit z AutoCADu.

Standardně je aplikace nastavena jako zamčená. Aby ji bylo možné odstranit, nastavíme její stav na odemčený (unlocked):

Adesk::Boolean AcRxDynamicLinker::unlockAppication(void* pkt) const;

Potřebujeme-li zakázat aplikaci, aby se dala odstranit, uzamčeme ji pomocí funkce:

Adesk::Boolean AcRxDynamicLinker::lockAppication(void* pkt) const;