Skip to content

Commit 4f0400e

Browse files
dpeter99dpeter99
committed
Reset doc files
removes the extra changes
1 parent fbe6c1b commit 4f0400e

17 files changed

Lines changed: 849 additions & 849 deletions

‎projs/docs/diagrams/architecture.plantuml‎

Lines changed: 25 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -1,26 +1,26 @@
1-
@startuml
2-
3-
class ShadowApplication <<Singleton>> {
4-
-ModuleManager module_manager
5-
~void packagePrivateMethod()
6-
#{abstract} char protectedMethod(int param)
7-
}
8-
9-
class ModuleManager <<Singleton>> {
10-
-vector<string, Module> moduels
11-
---
12-
+void AddModule(Module* mo)
13-
}
14-
15-
abstract class Module {
16-
+string domain
17-
---
18-
+void Init()
19-
+void Update()
20-
+void ShutDown()
21-
}
22-
23-
24-
25-
1+
@startuml
2+
3+
class ShadowApplication <<Singleton>> {
4+
-ModuleManager module_manager
5+
~void packagePrivateMethod()
6+
#{abstract} char protectedMethod(int param)
7+
}
8+
9+
class ModuleManager <<Singleton>> {
10+
-vector<string, Module> moduels
11+
---
12+
+void AddModule(Module* mo)
13+
}
14+
15+
abstract class Module {
16+
+string domain
17+
---
18+
+void Init()
19+
+void Update()
20+
+void ShutDown()
21+
}
22+
23+
24+
25+
2626
@enduml

‎projs/docs/diagrams/project-layout.plantuml‎

Lines changed: 30 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -1,31 +1,31 @@
1-
@startuml
2-
[shadow-light] <<exe>> as editor
3-
4-
[shadow-entity] <<static lib>> as shentity
5-
[shadow-file-format] <<static lib>> as shff
6-
[shadow-reflection] <<static lib>> as shreflection
7-
[shadow-renderer] <<static lib>> as shrenderer
8-
[shadow-utilty] <<static lib>> as shutitily
9-
10-
[shadow-engine] <<static/dynamic lib>> as shengine
11-
12-
shentity --* shengine
13-
shff --* shengine
14-
shreflection --* shengine
15-
shrenderer --* shengine
16-
shutitily --* shengine
17-
18-
19-
[shadow-runner] <<exe>> as runner
20-
21-
[test-game] <<dll>> as game
22-
23-
shengine <- editor
24-
runner -> shengine
25-
26-
game ..> shengine : uses
27-
28-
runner --> game : loads
29-
editor --> game : loads
30-
1+
@startuml
2+
[shadow-light] <<exe>> as editor
3+
4+
[shadow-entity] <<static lib>> as shentity
5+
[shadow-file-format] <<static lib>> as shff
6+
[shadow-reflection] <<static lib>> as shreflection
7+
[shadow-renderer] <<static lib>> as shrenderer
8+
[shadow-utilty] <<static lib>> as shutitily
9+
10+
[shadow-engine] <<static/dynamic lib>> as shengine
11+
12+
shentity --* shengine
13+
shff --* shengine
14+
shreflection --* shengine
15+
shrenderer --* shengine
16+
shutitily --* shengine
17+
18+
19+
[shadow-runner] <<exe>> as runner
20+
21+
[test-game] <<dll>> as game
22+
23+
shengine <- editor
24+
runner -> shengine
25+
26+
game ..> shengine : uses
27+
28+
runner --> game : loads
29+
editor --> game : loads
30+
3131
@enduml

‎projs/docs/diagrams/startup.puml‎

Lines changed: 54 additions & 54 deletions
Original file line numberDiff line numberDiff line change
@@ -1,54 +1,54 @@
1-
@startuml
2-
!include <material/file>
3-
4-
autoactivate on
5-
autonumber
6-
7-
participant main as "int main(args)"
8-
9-
participant app as "ShadowApplication" <<(O,#ADD1B2) singleton>>
10-
11-
participant moduleMg as "ModuleManager" <<(O,#ADD1B2) singleton>>
12-
13-
14-
'participant gameDll as "longName" : <$ma_file{scale=0.5}> <<DLL>>
15-
16-
participant "Game DLL" as dll <<$ma_file{scale=0.5}>> #LightGray <<DLL>>
17-
18-
-> main
19-
main -> app ** : create
20-
activate app
21-
app -> moduleMg ** : create
22-
return app
23-
24-
main -> app : LoadGame
25-
26-
app -> app : load
27-
app -> dll ** : create
28-
return
29-
30-
app -> dll : sh_main
31-
32-
loop for each needed module
33-
dll -> moduleMg : AddModule()
34-
return
35-
end
36-
37-
return
38-
39-
return
40-
41-
main -> app : Init()
42-
app -> moduleMg : Init()
43-
44-
loop module in modules
45-
collections module as "Module" <<(O,#ADD1B2)entity>>
46-
moduleMg -> module : Init()
47-
return
48-
end
49-
return
50-
51-
return
52-
53-
54-
1+
@startuml
2+
!include <material/file>
3+
4+
autoactivate on
5+
autonumber
6+
7+
participant main as "int main(args)"
8+
9+
participant app as "ShadowApplication" <<(O,#ADD1B2) singleton>>
10+
11+
participant moduleMg as "ModuleManager" <<(O,#ADD1B2) singleton>>
12+
13+
14+
'participant gameDll as "longName" : <$ma_file{scale=0.5}> <<DLL>>
15+
16+
participant "Game DLL" as dll <<$ma_file{scale=0.5}>> #LightGray <<DLL>>
17+
18+
-> main
19+
main -> app ** : create
20+
activate app
21+
app -> moduleMg ** : create
22+
return app
23+
24+
main -> app : LoadGame
25+
26+
app -> app : load
27+
app -> dll ** : create
28+
return
29+
30+
app -> dll : sh_main
31+
32+
loop for each needed module
33+
dll -> moduleMg : AddModule()
34+
return
35+
end
36+
37+
return
38+
39+
return
40+
41+
main -> app : Init()
42+
app -> moduleMg : Init()
43+
44+
loop module in modules
45+
collections module as "Module" <<(O,#ADD1B2)entity>>
46+
moduleMg -> module : Init()
47+
return
48+
end
49+
return
50+
51+
return
52+
53+
54+

‎projs/docs/thesis/common/includes/declaration.tex‎

Lines changed: 31 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -1,31 +1,31 @@
1-
\selectlanguage{magyar}
2-
\pagenumbering{gobble}
3-
%--------------------------------------------------------------------------------------
4-
% Nyilatkozat
5-
%--------------------------------------------------------------------------------------
6-
\begin{center}
7-
\large
8-
\textbf{HALLGATÓI NYILATKOZAT}\\
9-
\end{center}
10-
11-
Alulírott \emph{\vikszerzoVezeteknev{} \vikszerzoKeresztnev}, szigorló hallgató kijelentem, hogy ezt a \vikmunkatipusat{} meg nem engedett segítség nélkül, saját magam készítettem, csak a megadott forrásokat (szakirodalom, eszközök stb.) használtam fel. Minden olyan részt, melyet szó szerint, vagy azonos értelemben, de átfogalmazva más forrásból átvettem, egyértelműen, a forrás megadásával megjelöltem.
12-
13-
Hozzájárulok, hogy a jelen munkám alapadatait (szerző(k), cím, angol és magyar nyelvű tartalmi kivonat, készítés éve, konzulens(ek) neve) a BME VIK nyilvánosan hozzáférhető elektronikus formában, a munka teljes szövegét pedig az egyetem belső hálózatán keresztül (vagy autentikált felhasználók számára) közzétegye. Kijelentem, hogy a benyújtott munka és annak elektronikus verziója megegyezik. Dékáni engedéllyel titkosított diplomatervek esetén a dolgozat szövege csak 3 év eltelte után válik hozzáférhetővé.
14-
15-
\begin{flushleft}
16-
\vspace*{1cm}
17-
Budapest, \today
18-
\end{flushleft}
19-
20-
\begin{flushright}
21-
\vspace*{1cm}
22-
\makebox[7cm]{\rule{6cm}{.4pt}}\\
23-
\makebox[7cm]{\emph{\vikszerzoVezeteknev{} \vikszerzoKeresztnev}}\\
24-
\makebox[7cm]{hallgató}
25-
\end{flushright}
26-
\thispagestyle{empty}
27-
28-
\vfill
29-
\cleardoublepage
30-
31-
\selectthesislanguage
1+
\selectlanguage{magyar}
2+
\pagenumbering{gobble}
3+
%--------------------------------------------------------------------------------------
4+
% Nyilatkozat
5+
%--------------------------------------------------------------------------------------
6+
\begin{center}
7+
\large
8+
\textbf{HALLGATÓI NYILATKOZAT}\\
9+
\end{center}
10+
11+
Alulírott \emph{\vikszerzoVezeteknev{} \vikszerzoKeresztnev}, szigorló hallgató kijelentem, hogy ezt a \vikmunkatipusat{} meg nem engedett segítség nélkül, saját magam készítettem, csak a megadott forrásokat (szakirodalom, eszközök stb.) használtam fel. Minden olyan részt, melyet szó szerint, vagy azonos értelemben, de átfogalmazva más forrásból átvettem, egyértelműen, a forrás megadásával megjelöltem.
12+
13+
Hozzájárulok, hogy a jelen munkám alapadatait (szerző(k), cím, angol és magyar nyelvű tartalmi kivonat, készítés éve, konzulens(ek) neve) a BME VIK nyilvánosan hozzáférhető elektronikus formában, a munka teljes szövegét pedig az egyetem belső hálózatán keresztül (vagy autentikált felhasználók számára) közzétegye. Kijelentem, hogy a benyújtott munka és annak elektronikus verziója megegyezik. Dékáni engedéllyel titkosított diplomatervek esetén a dolgozat szövege csak 3 év eltelte után válik hozzáférhetővé.
14+
15+
\begin{flushleft}
16+
\vspace*{1cm}
17+
Budapest, \today
18+
\end{flushleft}
19+
20+
\begin{flushright}
21+
\vspace*{1cm}
22+
\makebox[7cm]{\rule{6cm}{.4pt}}\\
23+
\makebox[7cm]{\emph{\vikszerzoVezeteknev{} \vikszerzoKeresztnev}}\\
24+
\makebox[7cm]{hallgató}
25+
\end{flushright}
26+
\thispagestyle{empty}
27+
28+
\vfill
29+
\cleardoublepage
30+
31+
\selectthesislanguage

‎projs/docs/thesis/common/includes/guideline.tex‎

Lines changed: 54 additions & 54 deletions
Original file line numberDiff line numberDiff line change
@@ -1,54 +1,54 @@
1-
\selecthungarian
2-
%--------------------------------------------------------------------------------------
3-
% Rovid formai es tartalmi tajekoztato
4-
%--------------------------------------------------------------------------------------
5-
6-
\footnotesize
7-
\begin{center}
8-
\large
9-
\textbf{\Large Általános információk, a diplomaterv szerkezete}\\
10-
\end{center}
11-
12-
A diplomaterv szerkezete a BME Villamosmérnöki és Informatikai Karán:
13-
\begin{enumerate}
14-
\item Diplomaterv feladatkiírás
15-
\item Címoldal
16-
\item Tartalomjegyzék
17-
\item A diplomatervező nyilatkozata az önálló munkáról és az elektronikus adatok kezeléséről
18-
\item Tartalmi összefoglaló magyarul és angolul
19-
\item Bevezetés: a feladat értelmezése, a tervezés célja, a feladat indokoltsága, a diplomaterv felépítésének rövid összefoglalása
20-
\item A feladatkiírás pontosítása és részletes elemzése
21-
\item Előzmények (irodalomkutatás, hasonló alkotások), az ezekből levonható következtetések
22-
\item A tervezés részletes leírása, a döntési lehetőségek értékelése és a választott megoldások indoklása
23-
\item A megtervezett műszaki alkotás értékelése, kritikai elemzése, továbbfejlesztési lehetőségek
24-
\item Esetleges köszönetnyilvánítások
25-
\item Részletes és pontos irodalomjegyzék
26-
\item Függelék(ek)
27-
\end{enumerate}
28-
29-
Felhasználható a következő oldaltól kezdődő \LaTeX diplomatervsablon dokumentum tartalma.
30-
31-
A diplomaterv szabványos méretű A4-es lapokra kerüljön. Az oldalak tükörmargóval készüljenek (mindenhol 2,5~cm, baloldalon 1~cm-es kötéssel). Az alapértelmezett betűkészlet a 12 pontos Times New Roman, másfeles sorközzel, de ettől kismértékben el lehet térni, ill. más betűtípus használata is megengedett.
32-
33-
Minden oldalon -- az első négy szerkezeti elem kivételével -- szerepelnie kell az oldalszámnak.
34-
35-
A fejezeteket decimális beosztással kell ellátni. Az ábrákat a megfelelő helyre be kell illeszteni, fejezetenként decimális számmal és kifejező címmel kell ellátni. A fejezeteket decimális aláosztással számozzuk, maximálisan 3 aláosztás mélységben (pl. 2.3.4.1.). Az ábrákat, táblázatokat és képleteket célszerű fejezetenként külön számozni (pl. 2.4. ábra, 4.2. táblázat vagy képletnél (3.2)). A fejezetcímeket igazítsuk balra, a normál szövegnél viszont használjunk sorkiegyenlítést. Az ábrákat, táblázatokat és a hozzájuk tartozó címet igazítsuk középre. A cím a jelölt rész alatt helyezkedjen el.
36-
37-
A képeket lehetőleg rajzoló programmal készítsék el, az egyenleteket egyenlet-szerkesztő segítségével írják le (A \LaTeX~ehhez kézenfekvő megoldásokat nyújt).
38-
39-
Az irodalomjegyzék szövegközi hivatkozása történhet sorszámozva (ez a preferált megoldás) vagy a Harvard-rendszerben (a szerző és az évszám megadásával). A teljes lista névsor szerinti sorrendben a szöveg végén szerepeljen (sorszámozott irodalmi hivatkozások esetén hivatkozási sorrendben). A szakirodalmi források címeit azonban mindig az eredeti nyelven kell megadni, esetleg zárójelben a fordítással. A listában szereplő valamennyi publikációra hivatkozni kell a szövegben (a \LaTeX-sablon a Bib\TeX~segítségével mindezt automatikusan kezeli). Minden publikáció a szerzők után a következő adatok szerepelnek: folyóirat cikkeknél a pontos cím, a folyóirat címe, évfolyam, szám, oldalszám tól-ig. A folyóiratok címét csak akkor rövidítsük, ha azok nagyon közismertek vagy nagyon hosszúak. Internetes hivatkozások megadásakor fontos, hogy az elérési út előtt megadjuk az oldal tulajdonosát és tartalmát (mivel a link egy idő után akár elérhetetlenné is válhat), valamint az elérés időpontját.
40-
41-
\vspace{5mm}
42-
Fontos:
43-
\begin{itemize}
44-
\item A szakdolgozatkészítő / diplomatervező nyilatkozata (a jelen sablonban szereplő szövegtartalommal) kötelező előírás, Karunkon ennek hiányában a szakdolgozat/diplomaterv nem bírálható és nem védhető!
45-
\item Mind a dolgozat, mind a melléklet maximálisan 15~MB méretű lehet!
46-
\end{itemize}
47-
48-
\vspace{5mm}
49-
\begin{center}
50-
Jó munkát, sikeres szakdolgozatkészítést, ill. diplomatervezést kívánunk!
51-
\end{center}
52-
53-
\normalsize
54-
\selectthesislanguage
1+
\selecthungarian
2+
%--------------------------------------------------------------------------------------
3+
% Rovid formai es tartalmi tajekoztato
4+
%--------------------------------------------------------------------------------------
5+
6+
\footnotesize
7+
\begin{center}
8+
\large
9+
\textbf{\Large Általános információk, a diplomaterv szerkezete}\\
10+
\end{center}
11+
12+
A diplomaterv szerkezete a BME Villamosmérnöki és Informatikai Karán:
13+
\begin{enumerate}
14+
\item Diplomaterv feladatkiírás
15+
\item Címoldal
16+
\item Tartalomjegyzék
17+
\item A diplomatervező nyilatkozata az önálló munkáról és az elektronikus adatok kezeléséről
18+
\item Tartalmi összefoglaló magyarul és angolul
19+
\item Bevezetés: a feladat értelmezése, a tervezés célja, a feladat indokoltsága, a diplomaterv felépítésének rövid összefoglalása
20+
\item A feladatkiírás pontosítása és részletes elemzése
21+
\item Előzmények (irodalomkutatás, hasonló alkotások), az ezekből levonható következtetések
22+
\item A tervezés részletes leírása, a döntési lehetőségek értékelése és a választott megoldások indoklása
23+
\item A megtervezett műszaki alkotás értékelése, kritikai elemzése, továbbfejlesztési lehetőségek
24+
\item Esetleges köszönetnyilvánítások
25+
\item Részletes és pontos irodalomjegyzék
26+
\item Függelék(ek)
27+
\end{enumerate}
28+
29+
Felhasználható a következő oldaltól kezdődő \LaTeX diplomatervsablon dokumentum tartalma.
30+
31+
A diplomaterv szabványos méretű A4-es lapokra kerüljön. Az oldalak tükörmargóval készüljenek (mindenhol 2,5~cm, baloldalon 1~cm-es kötéssel). Az alapértelmezett betűkészlet a 12 pontos Times New Roman, másfeles sorközzel, de ettől kismértékben el lehet térni, ill. más betűtípus használata is megengedett.
32+
33+
Minden oldalon -- az első négy szerkezeti elem kivételével -- szerepelnie kell az oldalszámnak.
34+
35+
A fejezeteket decimális beosztással kell ellátni. Az ábrákat a megfelelő helyre be kell illeszteni, fejezetenként decimális számmal és kifejező címmel kell ellátni. A fejezeteket decimális aláosztással számozzuk, maximálisan 3 aláosztás mélységben (pl. 2.3.4.1.). Az ábrákat, táblázatokat és képleteket célszerű fejezetenként külön számozni (pl. 2.4. ábra, 4.2. táblázat vagy képletnél (3.2)). A fejezetcímeket igazítsuk balra, a normál szövegnél viszont használjunk sorkiegyenlítést. Az ábrákat, táblázatokat és a hozzájuk tartozó címet igazítsuk középre. A cím a jelölt rész alatt helyezkedjen el.
36+
37+
A képeket lehetőleg rajzoló programmal készítsék el, az egyenleteket egyenlet-szerkesztő segítségével írják le (A \LaTeX~ehhez kézenfekvő megoldásokat nyújt).
38+
39+
Az irodalomjegyzék szövegközi hivatkozása történhet sorszámozva (ez a preferált megoldás) vagy a Harvard-rendszerben (a szerző és az évszám megadásával). A teljes lista névsor szerinti sorrendben a szöveg végén szerepeljen (sorszámozott irodalmi hivatkozások esetén hivatkozási sorrendben). A szakirodalmi források címeit azonban mindig az eredeti nyelven kell megadni, esetleg zárójelben a fordítással. A listában szereplő valamennyi publikációra hivatkozni kell a szövegben (a \LaTeX-sablon a Bib\TeX~segítségével mindezt automatikusan kezeli). Minden publikáció a szerzők után a következő adatok szerepelnek: folyóirat cikkeknél a pontos cím, a folyóirat címe, évfolyam, szám, oldalszám tól-ig. A folyóiratok címét csak akkor rövidítsük, ha azok nagyon közismertek vagy nagyon hosszúak. Internetes hivatkozások megadásakor fontos, hogy az elérési út előtt megadjuk az oldal tulajdonosát és tartalmát (mivel a link egy idő után akár elérhetetlenné is válhat), valamint az elérés időpontját.
40+
41+
\vspace{5mm}
42+
Fontos:
43+
\begin{itemize}
44+
\item A szakdolgozatkészítő / diplomatervező nyilatkozata (a jelen sablonban szereplő szövegtartalommal) kötelező előírás, Karunkon ennek hiányában a szakdolgozat/diplomaterv nem bírálható és nem védhető!
45+
\item Mind a dolgozat, mind a melléklet maximálisan 15~MB méretű lehet!
46+
\end{itemize}
47+
48+
\vspace{5mm}
49+
\begin{center}
50+
Jó munkát, sikeres szakdolgozatkészítést, ill. diplomatervezést kívánunk!
51+
\end{center}
52+
53+
\normalsize
54+
\selectthesislanguage

0 commit comments

Comments
 (0)