Commit e7383386 authored by Mathieu Malaterre's avatar Mathieu Malaterre

DOC: Document some vtkCocoa* classes + some tweaks

parent a3bb06b2
......@@ -13,6 +13,7 @@
=========================================================================*/
// .NAME vtkCarbonRenderWindow - Carbon OpenGL rendering window
//
// .SECTION Description
// vtkCarbonRenderWindow is a concrete implementation of the abstract
// class vtkOpenGLRenderWindow. vtkCarbonRenderWindow interfaces to the
......@@ -23,9 +24,7 @@
#include "vtkOpenGLRenderWindow.h"
#include <Carbon/Carbon.h> // Carbon and MAC specific
#include <OpenGL/gl.h> // Carbon and MAC specific
#include <AGL/agl.h> // Carbon and MAC specific
class VTK_RENDERING_EXPORT vtkCarbonRenderWindow : public vtkOpenGLRenderWindow
......
......@@ -12,6 +12,14 @@
PURPOSE. See the above copyright notice for more information.
=========================================================================*/
// .NAME vtkCocoaGLView - Cocoa OpenGL rendering context
//
// .SECTION Description
// This class onle takes care of allocating an NSOpenGLView which simply
// providea rendering context. This class uses Objective-C++
//
// .SECTION See Also
// vtkCocoaRenderWindow
#import <Cocoa/Cocoa.h>
#import <OpenGL/gl.h>
......
......@@ -13,10 +13,14 @@
=========================================================================*/
// .NAME vtkCocoaRenderWindow - Cocoa OpenGL rendering window
//
// .SECTION Description
// vtkCocoaRenderWindow is a concrete implementation of the abstract
// class vtkOpenGLRenderWindow. vtkCocoaRenderWindow interfaces to the
// OpenGL graphics library using the Cocoa API on Mac OSX.
// It interacts with the OSX Window manager to display a window and create
// its vtkCocoaGLView. These were separated to allow applications to do their
// own window management and just use vtkCocoaGLView themselves.
#ifndef __vtkCocoaRenderWindow_h
#define __vtkCocoaRenderWindow_h
......
......@@ -16,26 +16,17 @@
// required by vtkRenderWindowInteractor.
//
// .SECTION Description
// The interactor interfaces with vtkCocoaWindow.mm and vtkCocoaGLView.mm
// The interactor interfaces with vtkCocoaRenderWindow and vtkCocoaGLView
// to trap messages from the Cocoa window manager and send them to vtk.
//
#ifndef __vtkCocoaRenderWindowInteractor_h
#define __vtkCocoaRenderWindowInteractor_h
#include "vtkRenderWindowInteractor.h"
#ifdef __cplusplus
extern "C" {
#endif
#ifdef __cplusplus
};
#endif
class VTK_RENDERING_EXPORT vtkCocoaRenderWindowInteractor : public vtkRenderWindowInteractor {
class VTK_RENDERING_EXPORT vtkCocoaRenderWindowInteractor : public vtkRenderWindowInteractor
{
public:
// Description:
// Construct object so that light follows camera motion.
......@@ -78,12 +69,12 @@ public:
// Cocoa specific application terminate, calls ClassExitMethod then
// calls PostQuitMessage(0) to terminate app. An application can Specify
// ExitMethod for alternative behaviour (i.e. suppresion of keyboard exit)
void TerminateApp(void);
void TerminateApp();
// Description:
// Cocoa timer methods
int CreateTimer(int timertype);
int DestroyTimer(void);
int DestroyTimer();
// Description:
// Methods to set the default exit method for the class. This method is
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment