Update copyright date; remove old CVS keyword
[ctsim.git] / src / tips.cpp
1 /*****************************************************************************
2 ** FILE IDENTIFICATION
3 **
4 **   Name:          tips.cpp
5 **   Purpose:       User tips for CTSim
6 **   Programmer:    Kevin Rosenberg
7 **   Date Started:  February 2001
8 **
9 **  This is part of the CTSim program
10 **  Copyright (C) 1983-2009 Kevin Rosenberg
11 **
12 **  This program is free software; you can redistribute it and/or modify
13 **  it under the terms of the GNU General Public License (version 2) as
14 **  published by the Free Software Foundation.
15 **
16 **  This program is distributed in the hope that it will be useful,
17 **  but WITHOUT ANY WARRANTY; without even the implied warranty of
18 **  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
19 **  GNU General Public License for more details.
20 **
21 **  You should have received a copy of the GNU General Public License
22 **  along with this program; if not, write to the Free Software
23 **  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
24 ******************************************************************************/
25
26 #include "wx/wxprec.h"
27
28 #ifndef WX_PRECOMP
29 #include "wx/wx.h"
30 #endif
31
32
33 #include "tips.h"
34
35 #if defined(HAVE_CONFIG_H)
36 #include "config.h"
37 #endif
38
39
40 const char* const CTSimTipProvider::s_aszTips[] = {
41   "You can create a geometric phantom using the \"File - Create Phantom\" menu command.",
42   "You can create a gray-scale, rasterized image of a phantom by using the \"Process - Rasterize\" menu command on a geometric phantom.",
43   "You can simulate the x-ray process by using the \"Process - Projections\" menu command on a geometric phantom.",
44   "You can simulate first, second, and third-fourth-fifth generation CT scanners by using different scanner geometries.",
45   "You can reconstruct an image from the x-ray data by using the \"Reconstruction\" menu on a projection file.",
46   "You can specify different levels of smoothing by using different filters in the \"Reconstruction\" dialog.",
47   "You can select a row and column of an image by left-mouse button clicking on an image.",
48   "You can plot a column or row of an image by using the \"Analyze - Plot\" command.",
49   "You can save your plots to a disk file by using the \"File - Save\" command.",
50   "You can create your own phantoms using a text editor. Please see the manual for the simple file format.",
51   "You can perform 2-dimension Fourier transform of images using the \"Filter\" menu commands.",
52   "You can create an image of a filter by using the \"File - Create Filter\" menu command.",
53   "You can add two images by using the \"Image - Add\" menu command.",
54   "You can display the value of a pixel in an image by right-mouse button clicking on an image.",
55   "You can view a 3-dimensional view of an image using the \"Image - 3D\" menu command.",
56   "You can scale an image to any size using the \"Image - Scale Size\" menu command.",
57   "You can display context-sensitive help by using the \"Help\" button on dialog boxes.",
58   "You can compare two images by using the \"Analyze - Compare Images\" menu command.",
59   "You can display these tips at any time by using the \"Help - Tips\" menu command.",
60   "You can control CTSim's operation using the \"File - Preferences\" menu command.",
61 };
62
63 const size_t CTSimTipProvider::s_iNumTips = sizeof(s_aszTips) / sizeof(const char *);
64
65
66 CTSimTipProvider::CTSimTipProvider (size_t iCurrentTip)
67 : wxTipProvider (iCurrentTip)
68 {
69   if (iCurrentTip >= s_iNumTips)
70     iCurrentTip = 0;
71
72   m_iCurrentTip = iCurrentTip;
73 }
74
75 wxString
76 CTSimTipProvider::GetTip()
77 {
78   if (m_iCurrentTip >= s_iNumTips)
79     m_iCurrentTip = 0;
80
81   size_t iThisTip = m_iCurrentTip;
82   ++m_iCurrentTip;
83
84   return wxString (wxConvUTF8.cMB2WX(s_aszTips[iThisTip]));
85 }
86
87 size_t
88 CTSimTipProvider::GetCurrentTip()
89 {
90   if (m_iCurrentTip >= s_iNumTips)
91     m_iCurrentTip = 0;
92
93   return m_iCurrentTip;
94 }
95