Dokumentace třídy Grendel::Example::Star

Diagram dědičnosti pro třídu Grendel::Example::Star

Grendel::Base::BaseInteractiveShape Grendel::Base::ICanvasCloneable Grendel::Base::BaseShape Grendel::Base::IInteractiveShape Grendel::Base::BaseCanvasObject Grendel::Base::IShape Grendel::Base::IShape Grendel::Base::ICanvasObject Grendel::Base::ICanvasObject Grendel::Base::ICanvasObject Grendel::Communication::IMessageReceiver Grendel::Communication::IMessageReceiver Grendel::Communication::IMessageReceiver

Seznam všech členů.

Veřejné metody

 Star (Canvas canvas, int corners, double radius, double internalRadius, Color outlineColor)
 Star (Canvas canvas)
ICanvasObject Clone ()
 vytvoření klonu. Původní objekt (this) musí zůstat nezměněn.
void CloneLeft ()
void MoveLeft ()
override void Painting ()
 hlavní kreslící metoda. Musí obsahovat všechny elemntární příkazy (primitiva) pro vykreslení tvaru. Kreslící metoda je volána volána při inicializace plátna, při jeho obnovování (např. po zakrytí okna, resp. v jednotlivých animačních krocích. Tato metoda musí být předefinována v odvozených třídách, pokud je tvar vytvářen jako elementární (tj. nesložený z jiných tvarů)
override void Interaction (MouseButtons button, Position location)
 obsluha vstupních (myších) událostí. Kód obsahuje reakci tvaru na stisk tlačítka myši uvnitř aktivní oblasti. /summary>
void AddToCommunicationGroup (string groupName)
 Přidává objekt do komunikační skupiny v centrální komunikačním uzlu.
void RemoveFromCommunicationGroup (string groupName)
 Vyjímá objekt z komunikační skupiny.
virtual void MessageReceiving (object message)
override string ToString ()

Chráněné metody

void InheritGroupsFrom (ICanvasObject templet)

Vlastnosti

double Radius [get, set]
int Corners [get, set]
double InternalRadius [get, set]
bool MaltesianEfect [get, set]
 
override Position LeftTopCorner [get]
override Position RightBottomCorner [get]
Color OutlineColor [get, set]
bool IsActive [get, set]
Position Location [get, set]
IShape ParentShape [get, set]
Position AbsolutePosition [get]
Color BaseColor [get, set]
int Layer [get, set]
WorldMatrix LocalTransformation [get, set]
WorldMatrix TotalTransformation [get]
Canvas Canvas [get]
IList< string > ComunnicationGroups [get]


Detailní popis

Pravidelná hvězda se specifikovaným očtem cípů a nastavitelným vnitřním a vnějším průměrem. Vztažný bod je ve středu hvězdy. Ukázkový a testovací tvar.

Definice je uvedena na řádku 41 v souboru ExampleShapes.cs.


Dokumentace konstruktoru a destruktoru

Grendel::Example::Star::Star ( Canvas  canvas,
int  corners,
double  radius,
double  internalRadius,
Color  outlineColor 
) [inline]

Definice je uvedena na řádku 48 v souboru ExampleShapes.cs.

Grendel::Example::Star::Star ( Canvas  canvas  )  [inline]

Definice je uvedena na řádku 56 v souboru ExampleShapes.cs.


Dokumentace k metodám

ICanvasObject Grendel::Example::Star::Clone (  )  [inline]

vytvoření klonu. Původní objekt (this) musí zůstat nezměněn.

Implementuje Grendel::Base::ICanvasCloneable.

Definice je uvedena na řádku 59 v souboru ExampleShapes.cs.

void Grendel::Example::Star::CloneLeft (  )  [inline]

Definice je uvedena na řádku 71 v souboru ExampleShapes.cs.

void Grendel::Example::Star::MoveLeft (  )  [inline]

Definice je uvedena na řádku 76 v souboru ExampleShapes.cs.

override void Grendel::Example::Star::Painting (  )  [inline, virtual]

hlavní kreslící metoda. Musí obsahovat všechny elemntární příkazy (primitiva) pro vykreslení tvaru. Kreslící metoda je volána volána při inicializace plátna, při jeho obnovování (např. po zakrytí okna, resp. v jednotlivých animačních krocích. Tato metoda musí být předefinována v odvozených třídách, pokud je tvar vytvářen jako elementární (tj. nesložený z jiných tvarů)

Implementuje Grendel::Base::BaseShape.

Definice je uvedena na řádku 151 v souboru ExampleShapes.cs.

override void Grendel::Example::Star::Interaction ( MouseButtons  button,
Position  location 
) [inline, virtual]

obsluha vstupních (myších) událostí. Kód obsahuje reakci tvaru na stisk tlačítka myši uvnitř aktivní oblasti. /summary>

Implementuje Grendel::Base::BaseInteractiveShape.

Definice je uvedena na řádku 168 v souboru ExampleShapes.cs.

void Grendel::Base::BaseCanvasObject::AddToCommunicationGroup ( string  groupName  )  [inline, inherited]

Přidává objekt do komunikační skupiny v centrální komunikačním uzlu.

Parametry:
groupName Identifikace komunikační skupiny.

Implementuje Grendel::Base::ICanvasObject.

Definice je uvedena na řádku 133 v souboru Shapes.cs.

void Grendel::Base::BaseCanvasObject::RemoveFromCommunicationGroup ( string  groupName  )  [inline, inherited]

Vyjímá objekt z komunikační skupiny.

Implementuje Grendel::Base::ICanvasObject.

Definice je uvedena na řádku 139 v souboru Shapes.cs.

virtual void Grendel::Base::BaseCanvasObject::MessageReceiving ( object  message  )  [inline, virtual, inherited]

Implementuje Grendel::Communication::IMessageReceiver.

Definice je uvedena na řádku 145 v souboru Shapes.cs.

void Grendel::Base::BaseCanvasObject::InheritGroupsFrom ( ICanvasObject  templet  )  [inline, protected, inherited]

Definice je uvedena na řádku 149 v souboru Shapes.cs.

override string Grendel::Base::BaseCanvasObject::ToString (  )  [inline, inherited]

Definice je uvedena na řádku 154 v souboru Shapes.cs.


Dokumentace k vlastnosti

double Grendel::Example::Star::Radius [get, set]

vnější poloměr (vnějších cípů)

Definice je uvedena na řádku 85 v souboru ExampleShapes.cs.

int Grendel::Example::Star::Corners [get, set]

počet cípů (musí být větší nebo roven 2).

Definice je uvedena na řádku 97 v souboru ExampleShapes.cs.

double Grendel::Example::Star::InternalRadius [get, set]

vnitřní průměr

Definice je uvedena na řádku 109 v souboru ExampleShapes.cs.

bool Grendel::Example::Star::MaltesianEfect [get, set]

efekt spočívající ve vyplnění jen nekterých sekcí mezi cípy hvězdy (ostatní jsou nevyplněné, tj. zcela průhledné)

Definice je uvedena na řádku 122 v souboru ExampleShapes.cs.

override Position Grendel::Example::Star::LeftTopCorner [get]

Levý horní roh obdélníkové oblasti, která by měla obsahovat všechny viditelné části tvaru. Tato oblast definuje aktivní část tvaru tj. oblast v níž jsou zachytávány události myši a následně doručovány tomuto interaktivnímu tvaru. Pozice je relativní vůči vztažnému bodu daného tvaru (vztažný bod by neměl být umístěn vně aktivní oblasti)

Reimplementuje stejnojmenný prvek z Grendel::Base::BaseInteractiveShape.

Definice je uvedena na řádku 131 v souboru ExampleShapes.cs.

override Position Grendel::Example::Star::RightBottomCorner [get]

Pravý dolní roh obdélníkové oblasti, která by měla obsahovat všechny viditelné části tvaru. Tato oblast definuje aktivní část tvaru tj. oblast v níž jsou zachytávány události myši a následně doručovány tomuto interaktivnímu tvaru. Pozice je relativní vůči vztažnému bodu daného tvaru (vztažný bod by neměl být umístěn vně aktivní oblasti)

Reimplementuje stejnojmenný prvek z Grendel::Base::BaseInteractiveShape.

Definice je uvedena na řádku 135 v souboru ExampleShapes.cs.

Color Grendel::Example::Star::OutlineColor [get, set]

barva orámování

Definice je uvedena na řádku 142 v souboru ExampleShapes.cs.

bool Grendel::Base::BaseInteractiveShape::IsActive [get, set, inherited]

interaktivní objekt je běžně aktivní, tj. reaguje na vstupní události. Pomocí vlastnosti IsActive je však možno tvar dočasně deaktivovat. To je užitečné například ve složených objektech.

Implementuje Grendel::Base::IInteractiveShape.

Definice je uvedena na řádku 257 v souboru Shapes.cs.

Position Grendel::Base::BaseShape::Location [get, set, inherited]

umístění vztažného bodu objektu. Umístění je u podtvarů relativní ke vztažnému bodu nadřízeného podtvaru. U tvarů bez nadřízeného tvaru (= kořenových tvarů) je umístění vztaženo k fyzickým souřadnicím plátna (tj. je absolutní)

Implementuje Grendel::Base::IShape.

Definice je uvedena na řádku 187 v souboru Shapes.cs.

IShape Grendel::Base::BaseShape::ParentShape [get, set, inherited]

rodičovský tj. nadřízený tvar. Podřízený tvar je umístěn relativně vůči nadřízenému a sdílí jeho transformace (např. je posouván spolu s rodičem). Závisí na něm také existenčně tj. při zániku nadřízeného objektu je destruován. U kořenových objekty tj. objektu, které nejsou součástí žádného objektu, má tato vlastnost hodnotu null.

Implementuje Grendel::Base::IShape.

Definice je uvedena na řádku 192 v souboru Shapes.cs.

Position Grendel::Base::BaseShape::AbsolutePosition [get, inherited]

absolutní pozice tvaru vůči plátnu. Je vypočítána z umístění aplikací transformací v řetězci nadřízených objektů.

Implementuje Grendel::Base::IShape.

Definice je uvedena na řádku 197 v souboru Shapes.cs.

Color Grendel::Base::BaseShape::BaseColor [get, set, inherited]

základní barva tvaru (typicky je převažující barva např. barva výplně u jednobarevných objektů). Pokud tvar nemá základní barvu je možno vrátit tzv. prázdnou barvu (= plně průhledná černá).

Implementuje Grendel::Base::IShape.

Definice je uvedena na řádku 203 v souboru Shapes.cs.

int Grendel::Base::BaseShape::Layer [get, set, inherited]

vrstva, v níž je tvar kreslen. Tvary ve vyšších vstvách (= s numericky vyšší hodnotou) zakrývají objekty ve vrstvách nižších. Základní vrstva je vrstva 0. Lze používat i vrstvy se zápornou hodnotou.

Implementuje Grendel::Base::IShape.

Definice je uvedena na řádku 212 v souboru Shapes.cs.

WorldMatrix Grendel::Base::BaseShape::LocalTransformation [get, set, inherited]

lokální (vnitřní) transformace tvaru. Ovlivňuje jak elementární kreslící operace (primitiva tj. Canvas.DrawXXX), tak případné podřízené objekty.

Implementuje Grendel::Base::IShape.

Definice je uvedena na řádku 222 v souboru Shapes.cs.

WorldMatrix Grendel::Base::BaseShape::TotalTransformation [get, inherited]

globální (vnější) transformace objektu. Transformace objektu jako celku, zděděné z řetězce nadřízených objektů.

Implementuje Grendel::Base::IShape.

Definice je uvedena na řádku 227 v souboru Shapes.cs.

Canvas Grendel::Base::BaseCanvasObject::Canvas [get, inherited]

vrací plátno, k němuž objekt patří

Implementuje Grendel::Base::ICanvasObject.

Definice je uvedena na řádku 123 v souboru Shapes.cs.

IList<string> Grendel::Base::BaseCanvasObject::ComunnicationGroups [get, inherited]

Kopie seznamu komunikačních skupin, do níž objekt přísluší.

Implementuje Grendel::Base::ICanvasObject.

Definice je uvedena na řádku 127 v souboru Shapes.cs.


Dokumentace pro tuto třídu byla generována z následujícího souboru:

Generováno Sun Jul 12 20:34:44 2009 pro projekt Grafická knihovna GRENDEL programem  doxygen 1.5.5