trunk/Classes/GraphicClientView.h

//
//  GraphicClientView.h
//
/*
    Copyright (c) 2000-2017 Toshi Nagata. All rights reserved.

 This program is free software; you can redistribute it and/or modify
 it under the terms of the GNU General Public License as published by
 the Free Software Foundation version 2 of the License.
 
 This program is distributed in the hope that it will be useful,
 but WITHOUT ANY WARRANTY; without even the implied warranty of
 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 GNU General Public License for more details.
 */

#import <Cocoa/Cocoa.h>

enum {
        kGraphicGenericViewType = 0,
        kGraphicPianoRollViewType = 1,
        kGraphicTimeChartViewType = 2,
        kGraphicStripChartViewType = 3
};

extern CGFloat gLineDash1[];
extern CGFloat gLineDash2[];
extern CGFloat gDashWidth;

@interface GraphicClientView : NSView {
    id dataSource;                              //  The data source
    float minValue, maxValue;
        float visibleRangeMin, visibleRangeMax;  //  To be used in save/restoreVisibleRange

        // The current graphic tool is taken from -[GraphicWindowController graphicTool] 
        // within mouseDown/mouseMoved/flagsChanged handler. 
        // Some client (like TimeChartView) may want to override the selection mode;
        // this is implemented in -[GraphicClientView modifyLocalGraphicTool:];
    int localGraphicTool;

    BOOL isDragging;
    BOOL isLoupeDragging;
        BOOL autoScaleOnResizing;
    NSUInteger initialModifierFlags;
    NSUInteger currentModifierFlags;
    NSMutableArray *selectPoints;
    NSBezierPath *selectionPath;
        NSRect initialSelectionRect;
    NSTimer *autoscrollTimer;
}

//  Should be overridden in subclasses
+ (float)minHeight;
- (int)clientViewType;

- (BOOL)hasVerticalScroller;
- (void)setDataSource: (id)object;
- (id)dataSource;
- (void)paintEditingRange: (NSRect)aRect startX: (float *)startp endX: (float *)endp;
- (void)reloadData;
- (void)setYScale: (float)y;
- (float)yScale;
- (void)setMinValue: (float)value;
- (float)minValue;
- (void)setMaxValue: (float)value;
- (float)maxValue;

//  The visible/focus track can either be chosen in the track list, or be determined
//  for each client view. The following methods calls the GraphicWindowController
//  versions by default, but the subclass can override them to implement client-specific
//  focus track handling (e.g. 'tempo' view always edits the conductor track)
- (BOOL)isFocusTrack: (int)trackNum;
- (int32_t)visibleTrackCount;
- (int)sortedTrackNumberAtIndex: (int)index;

//  Set client-specific focus track. By default, focus track is -1 (i.e. as in the track list)
- (void)setFocusTrack:(int)aTrack;
- (int)focusTrack;

//  Update internal information for the track if necessary
- (void)doTrackModified:(int)aTrack;

//  Drawing
- (void)drawContentsInRect:(NSRect)aRect;
- (void)drawVerticalLinesInRect: (NSRect)aRect;
- (NSColor *)verticalLineColor: (BOOL)beforeEndOfSequence;

//- (int)selectMode;
- (BOOL)isDragging;
//- (BOOL)shiftDown;
- (NSArray *)selectPoints;
- (NSBezierPath *)selectionPath;
- (NSRect)willInvalidateSelectRect: (NSRect)rect;
- (void)invalidateSelectRegion;
- (void)calcSelectRegion;
- (void)setSelectRegion: (NSBezierPath *)path;
- (void)drawSelectRegion;
- (BOOL)isPointInSelectRegion: (NSPoint)point;

//  The subclass should override this to respond to mouse actions
- (void)doMouseDown: (NSEvent *)theEvent;
- (void)doMouseDragged: (NSEvent *)theEvent;
- (void)doMouseUp: (NSEvent *)theEvent;
//- (void)draggingDidEnd: (NSRect)bounds;

//  Overrides for implementing selection rectangle/region
- (void)mouseDown: (NSEvent *)theEvent;
- (void)mouseDragged: (NSEvent *)theEvent;
- (void)mouseUp: (NSEvent *)theEvent;

//  Info text during mouse move and dragging
- (NSString *)infoTextForMousePoint:(NSPoint)pt dragging:(BOOL)flag option:(int *)option;

//  Will be called from GraphicWindowController's mouseMoved: handler
- (void)doMouseMoved: (NSEvent *)theEvent;

//  Will be called from GraphicBackgroundView's flagsChanged: handler
- (void)doFlagsChanged: (NSEvent *)theEvent;

- (int)modifyLocalGraphicTool:(int)originalGraphicTool;

- (void)convertFromPoint:(NSPoint)pt toY:(float *)y andTick:(int32_t *)tick;
- (NSPoint)convertToPointFromY:(float)y andTick:(int32_t)tick;

- (void)setVisibleRangeMin:(float)min max:(float)max;
- (void)getVisibleRangeMin:(float *)min max:(float *)max;
- (void)saveVisibleRange;
- (void)restoreVisibleRange;

- (float)scrollVerticalPosition;
- (void)scrollToVerticalPosition:(float)pos;

@end