vtkScalarBarActor.cxx 31.4 KB
Newer Older
1
2
3
4
5
/*=========================================================================

  Program:   Visualization Toolkit
  Module:    vtkScalarBarActor.cxx

6
  Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
7
8
  All rights reserved.
  See Copyright.txt or http://www.kitware.com/Copyright.htm for details.
Will Schroeder's avatar
Will Schroeder committed
9

10
11
     This software is distributed WITHOUT ANY WARRANTY; without even
     the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
12
     PURPOSE.  See the above copyright notice for more information.
13
14
15

=========================================================================*/
#include "vtkScalarBarActor.h"
16

17
18
#include "vtkCellArray.h"
#include "vtkCellData.h"
19
#include "vtkObjectFactory.h"
20
#include "vtkPolyData.h"
21
22
23
#include "vtkPolyDataMapper2D.h"
#include "vtkScalarsToColors.h"
#include "vtkTextMapper.h"
Sebastien Barre's avatar
Sebastien Barre committed
24
#include "vtkTextProperty.h"
25
26
#include "vtkViewport.h"
#include "vtkWindow.h"
27
#include "vtkLookupTable.h"
28
29
30
31
32
33
34
#include "vtkFloatArray.h"
#include "vtkPointData.h"
#include "vtkTexture.h"
#include "vtkImageData.h"
#include "vtkRenderer.h"
#include "vtkProperty2D.h"

Brad King's avatar
Brad King committed
35
vtkStandardNewMacro(vtkScalarBarActor);
36

37
vtkCxxSetObjectMacro(vtkScalarBarActor,LookupTable,vtkScalarsToColors);
Sebastien Barre's avatar
Sebastien Barre committed
38
39
vtkCxxSetObjectMacro(vtkScalarBarActor,LabelTextProperty,vtkTextProperty);
vtkCxxSetObjectMacro(vtkScalarBarActor,TitleTextProperty,vtkTextProperty);
40
41
vtkCxxSetObjectMacro(vtkScalarBarActor,BackgroundProperty,vtkProperty2D);
vtkCxxSetObjectMacro(vtkScalarBarActor,FrameProperty,vtkProperty2D);
42

Sebastien Barre's avatar
Sebastien Barre committed
43
44
//----------------------------------------------------------------------------
// Instantiate object with 64 maximum colors; 5 labels; %%-#6.3g label
45
46
47
48
49
// format, no title, and vertical orientation. The initial scalar bar
// size is (0.05 x 0.8) of the viewport size.
vtkScalarBarActor::vtkScalarBarActor()
{
  this->LookupTable = NULL;
50
51
52
53
54
  this->Position2Coordinate->SetValue(0.17, 0.8);
  
  this->PositionCoordinate->SetCoordinateSystemToNormalizedViewport();
  this->PositionCoordinate->SetValue(0.82,0.1);
  
55
56
  this->MaximumNumberOfColors = 64;
  this->NumberOfLabels = 5;
57
  this->NumberOfLabelsBuilt = 0;
58
59
  this->Orientation = VTK_ORIENT_VERTICAL;
  this->Title = NULL;
60
  this->ComponentTitle = NULL;
61

Sebastien Barre's avatar
Sebastien Barre committed
62
63
64
65
66
67
68
69
70
71
  this->LabelTextProperty = vtkTextProperty::New();
  this->LabelTextProperty->SetFontSize(12);
  this->LabelTextProperty->SetBold(1);
  this->LabelTextProperty->SetItalic(1);
  this->LabelTextProperty->SetShadow(1);
  this->LabelTextProperty->SetFontFamilyToArial();

  this->TitleTextProperty = vtkTextProperty::New();
  this->TitleTextProperty->ShallowCopy(this->LabelTextProperty);

72
73
74
75
76
77
  this->LabelFormat = new char[8]; 
  sprintf(this->LabelFormat,"%s","%-#6.3g");

  this->TitleMapper = vtkTextMapper::New();
  this->TitleActor = vtkActor2D::New();
  this->TitleActor->SetMapper(this->TitleMapper);
78
79
80
  this->TitleActor->GetPositionCoordinate()->
    SetReferenceCoordinate(this->PositionCoordinate);
  
81
82
83
84
85
86
87
88
  this->TextMappers = NULL;
  this->TextActors = NULL;

  this->ScalarBar = vtkPolyData::New();
  this->ScalarBarMapper = vtkPolyDataMapper2D::New();
  this->ScalarBarMapper->SetInput(this->ScalarBar);
  this->ScalarBarActor = vtkActor2D::New();
  this->ScalarBarActor->SetMapper(this->ScalarBarMapper);
89
90
  this->ScalarBarActor->GetPositionCoordinate()->
    SetReferenceCoordinate(this->PositionCoordinate);
Ken Martin's avatar
Ken Martin committed
91
92
93
94
  this->LastOrigin[0] = 0;
  this->LastOrigin[1] = 0;
  this->LastSize[0] = 0;
  this->LastSize[1] = 0;
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
  
  // If opacity is on, a jail like texture is displayed behind it..

  this->UseOpacity       = 0;
  this->TextureGridWidth = 10.0;
  
  this->TexturePolyData = vtkPolyData::New();
  vtkPolyDataMapper2D * textureMapper = vtkPolyDataMapper2D::New();
  textureMapper->SetInput(this->TexturePolyData);
  this->TextureActor = vtkActor2D::New();
  this->TextureActor->SetMapper(textureMapper);
  textureMapper->Delete();
  this->TextureActor->GetPositionCoordinate()->
    SetReferenceCoordinate(this->PositionCoordinate);
  vtkFloatArray* tc = vtkFloatArray::New();
  tc->SetNumberOfComponents(2);
  tc->SetNumberOfTuples(4);
  tc->InsertComponent(0,0, 0.0);  
  tc->InsertComponent(0,1, 0.0);
  tc->InsertComponent(1,1, 0.0);
  tc->InsertComponent(3,0, 0.0);  
  this->TexturePolyData->GetPointData()->SetTCoords(tc);
  tc->Delete();

  vtkCellArray* polys2 = vtkCellArray::New();
  polys2->InsertNextCell(4);
  polys2->InsertCellPoint(0);
  polys2->InsertCellPoint(1);
  polys2->InsertCellPoint(2);
  polys2->InsertCellPoint(3);
  this->TexturePolyData->SetPolys(polys2);
  polys2->Delete();

  vtkProperty2D *imageProperty = vtkProperty2D::New();
  imageProperty->SetOpacity(0.08);
  this->TextureActor->SetProperty(imageProperty);
  imageProperty->Delete();

  // Create the default texture. Just a "Jail" like grid

  const unsigned int dim = 128;
  vtkImageData *image = vtkImageData::New();
  image->SetDimensions(dim, dim, 1);
  image->SetScalarTypeToUnsignedChar();
  image->AllocateScalars();
  
  for (unsigned int y = 0; y < dim; y++)
    {
    unsigned char *ptr = 
      static_cast< unsigned char * >(image->GetScalarPointer(0, y, 0));
    for (unsigned int x = 0; x < dim; x++)
      {
      *ptr = ((x == y) || (x == (dim-y-1))) ? 255 : 0;
      ++ptr;
      }
    }

  this->Texture = vtkTexture::New();
  this->Texture->SetInput( image );
  this->Texture->RepeatOn();
  image->Delete();
156
157
158
159

  // Default text position : Above scalar bar if orientation is horizontal
  //                         Right of scalar bar if orientation is vertical
  this->TextPosition = SucceedScalarBar;
160
161
162

  this->MaximumWidthInPixels = VTK_INT_MAX;
  this->MaximumHeightInPixels = VTK_INT_MAX;
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181

  this->BackgroundProperty = vtkProperty2D::New();
  this->FrameProperty = vtkProperty2D::New();

  this->DrawBackground = 0;
  this->Background = vtkPolyData::New();
  this->BackgroundMapper = vtkPolyDataMapper2D::New();
  this->BackgroundMapper->SetInput(this->Background);
  this->BackgroundActor = vtkActor2D::New();
  this->BackgroundActor->SetMapper(this->BackgroundMapper);
  this->BackgroundActor->GetPositionCoordinate()->SetReferenceCoordinate(this->PositionCoordinate);

  this->DrawFrame = 0;
  this->Frame = vtkPolyData::New();
  this->FrameMapper = vtkPolyDataMapper2D::New();
  this->FrameMapper->SetInput(this->Frame);
  this->FrameActor = vtkActor2D::New();
  this->FrameActor->SetMapper(this->FrameMapper);
  this->FrameActor->GetPositionCoordinate()->SetReferenceCoordinate(this->PositionCoordinate);
182
183

  this->EnhancedMode = false;
184
185
}

Sebastien Barre's avatar
Sebastien Barre committed
186
//----------------------------------------------------------------------------
Ken Martin's avatar
Ken Martin committed
187
188
189
190
191
192
193
194
195
196
197
198
199
200
// Release any graphics resources that are being consumed by this actor.
// The parameter window could be used to determine which graphic
// resources to release.
void vtkScalarBarActor::ReleaseGraphicsResources(vtkWindow *win)
{
  this->TitleActor->ReleaseGraphicsResources(win);
  if (this->TextMappers != NULL )
    {
    for (int i=0; i < this->NumberOfLabelsBuilt; i++)
      {
      this->TextActors[i]->ReleaseGraphicsResources(win);
      }
    }
  this->ScalarBarActor->ReleaseGraphicsResources(win);
201
202
  this->BackgroundActor->ReleaseGraphicsResources(win);
  this->FrameActor->ReleaseGraphicsResources(win);
Ken Martin's avatar
Ken Martin committed
203
204
}

Sebastien Barre's avatar
Sebastien Barre committed
205
//----------------------------------------------------------------------------
206
207
vtkScalarBarActor::~vtkScalarBarActor()
{
Ken Martin's avatar
Ken Martin committed
208
209
210
211
212
  if (this->LabelFormat) 
    {
    delete [] this->LabelFormat;
    this->LabelFormat = NULL;
    }
213
214
215
216
217
218

  this->TitleMapper->Delete();
  this->TitleActor->Delete();

  if (this->TextMappers != NULL )
    {
219
    for (int i=0; i < this->NumberOfLabelsBuilt; i++)
220
221
222
223
224
225
226
227
228
229
230
      {
      this->TextMappers[i]->Delete();
      this->TextActors[i]->Delete();
      }
    delete [] this->TextMappers;
    delete [] this->TextActors;
    }

  this->ScalarBar->Delete();
  this->ScalarBarMapper->Delete();
  this->ScalarBarActor->Delete();
Ken Martin's avatar
Ken Martin committed
231
232
233
234
235
236

  if (this->Title)
    {
    delete [] this->Title;
    this->Title = NULL;
    }
237
238
239
240
241
242

  if ( this->ComponentTitle )
    {
    delete [] this->ComponentTitle;
    this->ComponentTitle = NULL;
    }
243
244
  
  this->SetLookupTable(NULL);
Sebastien Barre's avatar
Sebastien Barre committed
245
246
  this->SetLabelTextProperty(NULL);
  this->SetTitleTextProperty(NULL);
247
248
249
  this->Texture->Delete();
  this->TextureActor->Delete();
  this->TexturePolyData->Delete();
250
251
252
253
254
255
256
257
  this->Background->Delete();
  this->BackgroundMapper->Delete();
  this->BackgroundActor->Delete();
  this->Frame->Delete();
  this->FrameMapper->Delete();
  this->FrameActor->Delete();
  this->SetBackgroundProperty(NULL);
  this->SetFrameProperty(NULL);
258
259
}

Sebastien Barre's avatar
Sebastien Barre committed
260
//----------------------------------------------------------------------------
261
int vtkScalarBarActor::RenderOverlay(vtkViewport *viewport)
Ken Martin's avatar
Ken Martin committed
262
{
263
  int renderedSomething = 0;
Ken Martin's avatar
Ken Martin committed
264
265
  int i;
  
266
267
268
269
270
271
272
273
274
275
  if (this->DrawBackground)
    {
    renderedSomething += this->BackgroundActor->RenderOverlay(viewport);
    }
  
  if (this->DrawFrame)
    {
    renderedSomething += this->FrameActor->RenderOverlay(viewport);
    }
  
276
277
278
279
280
281
  if (this->UseOpacity)
    {
    this->Texture->Render(vtkRenderer::SafeDownCast(viewport));
    renderedSomething += this->TextureActor->RenderOverlay(viewport);
    }

Ken Martin's avatar
Ken Martin committed
282
283
284
  // Everything is built, just have to render
  if (this->Title != NULL)
    {
285
    renderedSomething += this->TitleActor->RenderOverlay(viewport);
Ken Martin's avatar
Ken Martin committed
286
287
    }
  this->ScalarBarActor->RenderOverlay(viewport);
288
289
290
291
292
293
  if( this->TextActors == NULL)
    {
     vtkWarningMacro(<<"Need a mapper to render a scalar bar");
     return renderedSomething;
    }
  
Ken Martin's avatar
Ken Martin committed
294
295
  for (i=0; i<this->NumberOfLabels; i++)
    {
296
    renderedSomething += this->TextActors[i]->RenderOverlay(viewport);
Ken Martin's avatar
Ken Martin committed
297
    }
298
299
300
301

  renderedSomething = (renderedSomething > 0)?(1):(0);

  return renderedSomething;
Ken Martin's avatar
Ken Martin committed
302
303
}

Sebastien Barre's avatar
Sebastien Barre committed
304
//----------------------------------------------------------------------------
305
int vtkScalarBarActor::RenderOpaqueGeometry(vtkViewport *viewport)
306
{
307
  int renderedSomething = 0;
308
  int i;
309
310
  int size[2];
  
Sebastien Barre's avatar
Sebastien Barre committed
311
  if (!this->LookupTable)
312
313
    {
    vtkWarningMacro(<<"Need a mapper to render a scalar bar");
314
    return 0;
315
316
    }

Sebastien Barre's avatar
Sebastien Barre committed
317
318
319
320
321
322
323
324
325
326
327
328
  if (!this->TitleTextProperty)
    {
    vtkErrorMacro(<<"Need title text property to render a scalar bar");
    return 0;
    }

  if (!this->LabelTextProperty)
    {
    vtkErrorMacro(<<"Need label text property to render a scalar bar");
    return 0;
    }

Ken Martin's avatar
Ken Martin committed
329
  // Check to see whether we have to rebuild everything
330
  int positionsHaveChanged = 0;
Sebastien Barre's avatar
Sebastien Barre committed
331
332
333
  if (viewport->GetMTime() > this->BuildTime || 
      (viewport->GetVTKWindow() && 
       viewport->GetVTKWindow()->GetMTime() > this->BuildTime))
Ken Martin's avatar
Ken Martin committed
334
335
336
    {
    // if the viewport has changed we may - or may not need
    // to rebuild, it depends on if the projected coords chage
Bill Lorensen's avatar
Bill Lorensen committed
337
    int *barOrigin;
Ken Martin's avatar
Ken Martin committed
338
339
340
341
342
343
344
    barOrigin = this->PositionCoordinate->GetComputedViewportValue(viewport);
    size[0] = 
      this->Position2Coordinate->GetComputedViewportValue(viewport)[0] -
      barOrigin[0];
    size[1] = 
      this->Position2Coordinate->GetComputedViewportValue(viewport)[1] -
      barOrigin[1];
345
346
347
348
349
350
351

    // Check if we have bounds on the maximum size 
    size[0] = size[0] > this->MaximumWidthInPixels 
            ? this->MaximumWidthInPixels : size[0];
    size[1] = size[1] > this->MaximumHeightInPixels 
            ? this->MaximumHeightInPixels : size[1];

Sebastien Barre's avatar
Sebastien Barre committed
352
353
    if (this->LastSize[0] != size[0] || 
        this->LastSize[1] != size[1] ||
354
355
        this->LastOrigin[0] != barOrigin[0] || 
        this->LastOrigin[1] != barOrigin[1])
Ken Martin's avatar
Ken Martin committed
356
      {
357
      positionsHaveChanged = 1;
Ken Martin's avatar
Ken Martin committed
358
359
360
      }
    }
  
361
  // Check to see whether we have to rebuild everything
362
363
  if (positionsHaveChanged ||
      this->GetMTime() > this->BuildTime || 
Sebastien Barre's avatar
Sebastien Barre committed
364
365
      this->LookupTable->GetMTime() > this->BuildTime ||
      this->LabelTextProperty->GetMTime() > this->BuildTime ||
366
367
368
369
      this->TitleTextProperty->GetMTime() > this->BuildTime ||
      this->BackgroundProperty->GetMTime() > this->BuildTime ||
      this->FrameProperty->GetMTime() > this->BuildTime)

370
371
372
373
374
375
376
    {
    vtkDebugMacro(<<"Rebuilding subobjects");

    // Delete previously constructed objects
    //
    if (this->TextMappers != NULL )
      {
377
      for (i=0; i < this->NumberOfLabelsBuilt; i++)
378
379
380
381
        {
        this->TextMappers[i]->Delete();
        this->TextActors[i]->Delete();
        }
382
383
384
385
      delete [] this->TextMappers;
      delete [] this->TextActors;
      }

386
    // Build scalar bar object; determine its type
387
388
    // i.e. has scale set to log
    int isLogTable = this->LookupTable->UsingLogScale();
389
    
Ken Martin's avatar
Ken Martin committed
390
    // we hard code how many steps to display
391
    vtkScalarsToColors *lut = this->LookupTable;
Ken Martin's avatar
Ken Martin committed
392
    int numColors = this->MaximumNumberOfColors;
Ken Martin's avatar
Ken Martin committed
393
    double *range = lut->GetRange();
394
395
396
397
398
399

    int numPts = 2*(numColors + 1);
    vtkPoints *pts = vtkPoints::New();
    pts->SetNumberOfPoints(numPts);
    vtkCellArray *polys = vtkCellArray::New();
    polys->Allocate(polys->EstimateSize(numColors,4));
400
    vtkUnsignedCharArray *colors = vtkUnsignedCharArray::New();
401
402
403

    unsigned int nComponents = ((this->UseOpacity) ? 4 : 3);
    colors->SetNumberOfComponents( nComponents );
404
    colors->SetNumberOfTuples(numColors);
405
406
407
408
409
410
411
412

    this->ScalarBarActor->SetProperty(this->GetProperty());
    this->ScalarBar->Initialize();
    this->ScalarBar->SetPoints(pts);
    this->ScalarBar->SetPolys(polys);
    this->ScalarBar->GetCellData()->SetScalars(colors);
    pts->Delete(); polys->Delete(); colors->Delete();

413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
    // set frame structure
    vtkPoints *frPts = vtkPoints::New();
    frPts->SetNumberOfPoints(5);
    vtkCellArray *frLines = vtkCellArray::New();
    frLines->Allocate(frLines->EstimateSize(1,5));

    this->FrameActor->SetProperty(this->FrameProperty);
    this->Frame->Initialize();
    this->Frame->SetPoints(frPts);
    this->Frame->SetLines(frLines);
    frPts->Delete(); frLines->Delete();

    // set background structure
    vtkPoints *bgPts = vtkPoints::New();
    bgPts->SetNumberOfPoints(4);
    vtkCellArray *bgPolys = vtkCellArray::New();
    bgPolys->Allocate(bgPolys->EstimateSize(1,4));

    this->BackgroundActor->SetProperty(this->BackgroundProperty);
    this->Background->Initialize();
    this->Background->SetPoints(bgPts);
    this->Background->SetPolys(bgPolys);
    bgPts->Delete(); bgPolys->Delete();

437
    // get the viewport size in display coordinates
438
439
440
441
442
443
444
445
    int *barOrigin, barWidth, barHeight;
    barOrigin = this->PositionCoordinate->GetComputedViewportValue(viewport);
    size[0] = 
      this->Position2Coordinate->GetComputedViewportValue(viewport)[0] -
      barOrigin[0];
    size[1] = 
      this->Position2Coordinate->GetComputedViewportValue(viewport)[1] -
      barOrigin[1];
446
447
448
449
450
451
452

    // Check if we have bounds on the maximum size 
    size[0] = size[0] > this->MaximumWidthInPixels 
            ? this->MaximumWidthInPixels : size[0];
    size[1] = size[1] > this->MaximumHeightInPixels 
            ? this->MaximumHeightInPixels : size[1];
    
Ken Martin's avatar
Ken Martin committed
453
454
455
456
457
    this->LastOrigin[0] = barOrigin[0];
    this->LastOrigin[1] = barOrigin[1];
    this->LastSize[0] = size[0];
    this->LastSize[1] = size[1];
    
458
459
    // Update all the composing objects
    this->TitleActor->SetProperty(this->GetProperty());
460
461
462
463
464
    
    
    //update with the proper title
    if ( this->ComponentTitle && strlen(this->ComponentTitle) > 0 )
      {
465
466
      //need to account for a space between title & component and null term      
      char *combinedTitle = new char[ ( strlen(this->Title) + strlen(this->ComponentTitle) + 2) ];
467
468
469
470
471
472
473
474
475
476
477
      strcpy(combinedTitle, this->Title );
      strcat( combinedTitle, " " );
      strcat( combinedTitle, this->ComponentTitle );
      this->TitleMapper->SetInput(combinedTitle);
      delete [] combinedTitle;
      }
    else
      {
      this->TitleMapper->SetInput(this->Title);
      }

Sebastien Barre's avatar
Sebastien Barre committed
478
479
480
481
482
483
484
485
486
487
488
    if (this->TitleTextProperty->GetMTime() > this->BuildTime)
      {
      // Shallow copy here so that the size of the title prop is not affected
      // by the automatic adjustment of its text mapper's size (i.e. its
      // mapper's text property is identical except for the font size
      // which will be modified later). This allows text actors to
      // share the same text property, and in that case specifically allows
      // the title and label text prop to be the same.
      this->TitleMapper->GetTextProperty()->ShallowCopy(this->TitleTextProperty);
      this->TitleMapper->GetTextProperty()->SetJustificationToCentered();
      }
489
    
Ken Martin's avatar
Ken Martin committed
490
491
492
    // find the best size for the title font
    int titleSize[2];
    this->SizeTitle(titleSize, size, viewport);
493
    
Ken Martin's avatar
Ken Martin committed
494
495
496
    // find the best size for the ticks
    int labelSize[2];
    this->AllocateAndSizeLabels(labelSize, size, viewport,range);
497
    this->NumberOfLabelsBuilt = this->NumberOfLabels;
Ken Martin's avatar
Ken Martin committed
498
    
499
    // generate points
Ken Martin's avatar
Ken Martin committed
500
501
    double x[3]; x[2] = 0.0;
    double delta;
Philippe Pébay's avatar
Philippe Pébay committed
502
503
    int barX = 0;
    int barY = 0;
504
    if ( this->Orientation == VTK_ORIENT_VERTICAL )
505
      {
506
507
508
509
510
      // Adjust height and width only in enhanced more or if at least
      // one amongst the frame and the background was requested
      if ( this->DrawBackground ||
           this->DrawFrame ||
           this->EnhancedMode )
511
512
513
514
        {
        barX = static_cast<int>(size[0] * 0.05);
        barY = static_cast<int>(size[1] * 0.05 + labelSize[1] / 2);
        }
515
516
517
518
519

      barWidth = size[0] - 4 - labelSize[0] - 2 * barX;
      barHeight = static_cast<int>(0.86*size[1]) - barY;
      delta=static_cast<double>(barHeight)/numColors;
      for (i=0; i<numPts/2; i++)
520
        {
521
522
523
524
525
526
527
        x[0] = (this->TextPosition == vtkScalarBarActor::PrecedeScalarBar) 
          ? (size[0] - barWidth - barX) : barX;
        x[1] = barY + i*delta;
        pts->SetPoint(2*i,x);
        x[0] = (this->TextPosition == vtkScalarBarActor::PrecedeScalarBar) 
          ? size[0] - barX: barX + barWidth;
        pts->SetPoint(2*i+1,x);
528
        }
529
      }
530
    else
531
      {
532
533
534
535
536
      // Adjust height and width only in enhanced more or if at least
      // one amongst the frame and the background was requested
      if ( this->DrawBackground ||
           this->DrawFrame ||
           this->EnhancedMode )
537
        {
538
539
        barX = static_cast<int>(size[0] * 0.05) + labelSize[0] / 2;
        barY = static_cast<int>(size[1] * 0.05);
540
        }
541
542
543
544
      barWidth = size[0] - 2 * barX;
      barHeight = static_cast<int>(0.4*size[1]) - barY;
      delta=static_cast<double>(barWidth)/numColors;
      for (i=0; i<numPts/2; i++)
545
        {
546
547
548
549
550
551
552
        x[0] = barX + i*delta;
        x[1] = (this->TextPosition == vtkScalarBarActor::PrecedeScalarBar) 
          ? size[1] - barY: barY + barHeight ;
        pts->SetPoint(2*i,x);
        x[1] = (this->TextPosition == vtkScalarBarActor::PrecedeScalarBar) 
          ? (size[1]-barHeight - barY) : barY;
        pts->SetPoint(2*i+1,x);
553
        }
554
555
      }
    
556
557
    //polygons & cell colors
    unsigned char *rgba, *rgb;
558
    vtkIdType ptIds[4];
559
560
561
562
563
564
565
566
    for (i=0; i<numColors; i++)
      {
      ptIds[0] = 2*i;
      ptIds[1] = ptIds[0] + 1;
      ptIds[2] = ptIds[1] + 2;
      ptIds[3] = ptIds[0] + 2;
      polys->InsertNextCell(4,ptIds);

567
568
      if ( isLogTable )
        {
Ken Martin's avatar
Ken Martin committed
569
        double rgbval = log10(range[0]) + 
570
          i*(log10(range[1])-log10(range[0]))/(numColors -1);
Ken Martin's avatar
Ken Martin committed
571
        rgba = lut->MapValue(pow(10.0,rgbval));
572
573
574
575
        }
      else
        {
        rgba = lut->MapValue(range[0] + (range[1] - range[0])*
576
                             (i /(numColors-1.0)));
577
578
        }

579
      rgb = colors->GetPointer( nComponents * i); //write into array directly
580
581
582
      rgb[0] = rgba[0];
      rgb[1] = rgba[1];
      rgb[2] = rgba[2];
583
584
585
586
      if (this->UseOpacity)
        {
        rgb[3] = rgba[3];
        }
587
588
      }

589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
    // generate background and frame points and cell
    x[2] = 0.0;
    x[0]=0; x[1]=0;
    bgPts->SetPoint(0,x);
    frPts->SetPoint(0,x);
    frPts->SetPoint(4,x);
    
    x[0]=0; x[1]=size[1];
    bgPts->SetPoint(1,x);
    frPts->SetPoint(1,x);
    
    x[0]=size[0]; x[1]=size[1];
    bgPts->SetPoint(2,x);
    frPts->SetPoint(2,x);
    
    x[0]=size[0]; x[1]=0;
    bgPts->SetPoint(3,x);
    frPts->SetPoint(3,x);

    vtkIdType bgIds[5] = {0,1,2,3,4};
    bgPolys->InsertNextCell(4,bgIds);
    frLines->InsertNextCell(5,bgIds);

612
613
    // Now position everything properly
    //
Ken Martin's avatar
Ken Martin committed
614
    double val;
615
    int sizeTextData[2];
616
617
    if (this->Orientation == VTK_ORIENT_VERTICAL)
      {
618
      
619
      // center the title
Ken Martin's avatar
Ken Martin committed
620
      this->TitleActor->SetPosition(size[0]/2, 0.9*size[1]);
621
      
Jim Miller's avatar
Style    
Jim Miller committed
622
      for (i=0; i < this->NumberOfLabels; i++)
623
        {
Ken Martin's avatar
Ken Martin committed
624
625
        if (this->NumberOfLabels > 1)
          {
626
          val = static_cast<double>(i)/(this->NumberOfLabels-1) *barHeight + barY;
Ken Martin's avatar
Ken Martin committed
627
628
629
          }
        else 
          {
630
          val = 0.5*(barHeight + barY);
Ken Martin's avatar
Ken Martin committed
631
          }
632
        this->TextMappers[i]->GetSize(viewport,sizeTextData);
Sebastien Barre's avatar
Sebastien Barre committed
633
        this->TextMappers[i]->GetTextProperty()->SetJustificationToLeft();
634
635
        if (this->TextPosition == vtkScalarBarActor::PrecedeScalarBar)
          {
636
          this->TextActors[i]->SetPosition(barX, val - sizeTextData[1]/2);
637
638
639
          }
        else
          {
640
          this->TextActors[i]->SetPosition(barX + barWidth + 3,
641
642
                                           val - sizeTextData[1]/2);
          }
643
        }
644
645
646
      }
    else
      {
647
648
      if (this->TextPosition == vtkScalarBarActor::PrecedeScalarBar)
        {
649
        this->TitleActor->SetPosition(size[0]/2, barY);
650
651
652
653
        }
      else
        {
        this->TitleActor->SetPosition(size[0]/2, 
654
                                      barHeight + labelSize[1] + 0.1*size[1]);
655
        }
Jim Miller's avatar
Style    
Jim Miller committed
656
      for (i=0; i < this->NumberOfLabels; i++)
657
        {
658
        this->TextMappers[i]->GetSize(viewport,sizeTextData);
Sebastien Barre's avatar
Sebastien Barre committed
659
        this->TextMappers[i]->GetTextProperty()->SetJustificationToCentered();
Ken Martin's avatar
Ken Martin committed
660
661
        if (this->NumberOfLabels > 1)
          {
662
          val = static_cast<double>(i)/(this->NumberOfLabels-1) * barWidth + barX;
Ken Martin's avatar
Ken Martin committed
663
664
665
          }
        else
          {
666
          val = 0.5*(barWidth+barY);
Ken Martin's avatar
Ken Martin committed
667
          }
668
669
670
671
672
673
        if (this->TextPosition == vtkScalarBarActor::PrecedeScalarBar)
          {
          this->TextActors[i]->SetPosition(val, size[1] * 0.3);
          }
        else
          {
674
          this->TextActors[i]->SetPosition(val, barY + barHeight + 0.05*size[1]);
675
          }
676
        }
677
678
      }

679
680
681
682
683
684
    // Set the texture points
    //
    vtkPoints *texturePoints = vtkPoints::New();
    texturePoints->SetNumberOfPoints(4);
    this->TexturePolyData->SetPoints(texturePoints);
    texturePoints->SetPoint(0, 0.0, 0.0, 0.0);
685
686
687
688
689

    double p1[2], p2[2];
    if (this->Orientation == VTK_ORIENT_VERTICAL)
      {
      p1[0] = (this->TextPosition == vtkScalarBarActor::PrecedeScalarBar) 
690
691
        ? (size[0] - barWidth - barX) : barX;
      p1[1] = barY;
692
      p2[0] = p1[0] + barWidth;
693
      p2[1] = p1[1] + barHeight;
694
695
696
      }
    else
      {
697
      p1[0] = barX;
698
      p1[1] = (this->TextPosition == vtkScalarBarActor::PrecedeScalarBar) 
699
        ? (size[1] - barHeight - barY) : barY;
700
701
702
703
704
705
706
707
      p2[0] = p1[0] + barWidth;
      p2[1] = p1[1] + barHeight;
      }

    texturePoints->SetPoint(0, p1[0], p1[1], 0.0);
    texturePoints->SetPoint(1, p2[0], p1[1], 0.0);
    texturePoints->SetPoint(2, p2[0], p2[1], 0.0);
    texturePoints->SetPoint(3, p1[0], p2[1], 0.0);
708
709
710
711
712
    texturePoints->Delete();

    vtkDataArray * tc = this->TexturePolyData->GetPointData()->GetTCoords();
    tc->SetTuple2(1, barWidth / this->TextureGridWidth, 0.0);
    tc->SetTuple2(2, barWidth / this->TextureGridWidth, 
713
                  barHeight / this->TextureGridWidth);
714
715
    tc->SetTuple2(3, 0.0, barHeight / this->TextureGridWidth);

716
717
718
    this->BuildTime.Modified();
    }

719

720
  // Everything is built, just have to render
Jim Miller's avatar
Style    
Jim Miller committed
721
722
  if (this->Title != NULL)
    {
723
    renderedSomething += this->TitleActor->RenderOpaqueGeometry(viewport);
Jim Miller's avatar
Style    
Jim Miller committed
724
    }
Ken Martin's avatar
Ken Martin committed
725
  this->ScalarBarActor->RenderOpaqueGeometry(viewport);
Jim Miller's avatar
Style    
Jim Miller committed
726
727
  for (i=0; i<this->NumberOfLabels; i++)
    {
728
    renderedSomething += this->TextActors[i]->RenderOpaqueGeometry(viewport);
Jim Miller's avatar
Style    
Jim Miller committed
729
    }
730
731
732
733

  renderedSomething = (renderedSomething > 0)?(1):(0);

  return renderedSomething;
734
735
}

736
737
738
739
740
741
742
743
//-----------------------------------------------------------------------------
// Description:
// Does this prop have some translucent polygonal geometry?
int vtkScalarBarActor::HasTranslucentPolygonalGeometry()
{
  return 0;
}

Sebastien Barre's avatar
Sebastien Barre committed
744
//----------------------------------------------------------------------------
745
void vtkScalarBarActor::PrintSelf(ostream& os, vtkIndent indent)
746
{
Brad King's avatar
Brad King committed
747
  this->Superclass::PrintSelf(os,indent);
748
749
750
751
752
753
754
755
756
757
758

  if ( this->LookupTable )
    {
    os << indent << "Lookup Table:\n";
    this->LookupTable->PrintSelf(os,indent.GetNextIndent());
    }
  else
    {
    os << indent << "Lookup Table: (none)\n";
    }

Sebastien Barre's avatar
Sebastien Barre committed
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
  if (this->TitleTextProperty)
    {
    os << indent << "Title Text Property:\n";
    this->TitleTextProperty->PrintSelf(os,indent.GetNextIndent());
    }
  else
    {
    os << indent << "Title Text Property: (none)\n";
    }

  if (this->LabelTextProperty)
    {
    os << indent << "Label Text Property:\n";
    this->LabelTextProperty->PrintSelf(os,indent.GetNextIndent());
    }
  else
    {
    os << indent << "Label Text Property: (none)\n";
    }

779
  os << indent << "Title: " << (this->Title ? this->Title : "(none)") << "\n";
780
  os << indent << "ComponentTitle: " << (this->ComponentTitle ? this->ComponentTitle : "(none)") << "\n";
781
782
783
  os << indent << "Maximum Number Of Colors: " 
     << this->MaximumNumberOfColors << "\n";
  os << indent << "Number Of Labels: " << this->NumberOfLabels << "\n";
784
  os << indent << "Number Of Labels Built: " << this->NumberOfLabelsBuilt << "\n";
785
786

  os << indent << "Orientation: ";
Jim Miller's avatar
Style    
Jim Miller committed
787
788
789
790
791
792
793
794
  if ( this->Orientation == VTK_ORIENT_HORIZONTAL )
    {
    os << "Horizontal\n";
    }
  else
    {
    os << "Vertical\n";
    }
795
796

  os << indent << "Label Format: " << this->LabelFormat << "\n";
797
798
799
800
  os << indent << "UseOpacity: " << this->UseOpacity << "\n";
  if (this->UseOpacity)
    {
    os << indent << "TextureGridWidth: " << this->TextureGridWidth << "\n";
Karthik Krishnan's avatar
Karthik Krishnan committed
801
802
    os << indent << "TextureActor:\n";
    this->TextureActor->PrintSelf(os, indent.GetNextIndent());
803
    }
804
805
806
807
808
809
810
811
  if (this->TextPosition == vtkScalarBarActor::PrecedeScalarBar)
    {
    os << indent << "TextPosition: PrecedeScalarBar\n";
    }
  else
    {
    os << indent << "TextPosition: SucceedScalarBar\n";
    }
Karthik Krishnan's avatar
Karthik Krishnan committed
812
813
814
815
816

  os << indent << "MaximumWidthInPixels: " 
     << this->MaximumWidthInPixels << endl;
  os << indent << "MaximumHeightInPixels: " 
     << this->MaximumHeightInPixels << endl;
817
818
819
820
821
822
823
824
825
826

  os << indent << "DrawBackground: " << this->DrawBackground << "\n";
  os << indent << "Background Property:\n";
  this->BackgroundProperty->PrintSelf(os,indent.GetNextIndent());
  os << indent << "DrawFrame: " << this->DrawFrame << "\n";
  os << indent << "Frame Property:\n";
  this->FrameProperty->PrintSelf(os,indent.GetNextIndent());

  os << indent << "Enhanced Mode:\n"
     << this->EnhancedMode << endl;
827
}
Ken Martin's avatar
Ken Martin committed
828

Sebastien Barre's avatar
Sebastien Barre committed
829
//----------------------------------------------------------------------------
Will Schroeder's avatar
Will Schroeder committed
830
831
832
833
834
835
836
837
838
void vtkScalarBarActor::ShallowCopy(vtkProp *prop)
{
  vtkScalarBarActor *a = vtkScalarBarActor::SafeDownCast(prop);
  if ( a != NULL )
    {
    this->SetPosition2(a->GetPosition2());
    this->SetLookupTable(a->GetLookupTable());
    this->SetMaximumNumberOfColors(a->GetMaximumNumberOfColors());
    this->SetOrientation(a->GetOrientation());
Sebastien Barre's avatar
Sebastien Barre committed
839
840
    this->SetLabelTextProperty(a->GetLabelTextProperty());
    this->SetTitleTextProperty(a->GetTitleTextProperty());
Will Schroeder's avatar
Will Schroeder committed
841
842
843
844
845
846
847
848
849
850
    this->SetLabelFormat(a->GetLabelFormat());
    this->SetTitle(a->GetTitle());
    this->GetPositionCoordinate()->SetCoordinateSystem(
      a->GetPositionCoordinate()->GetCoordinateSystem());    
    this->GetPositionCoordinate()->SetValue(
      a->GetPositionCoordinate()->GetValue());
    this->GetPosition2Coordinate()->SetCoordinateSystem(
      a->GetPosition2Coordinate()->GetCoordinateSystem());    
    this->GetPosition2Coordinate()->SetValue(
      a->GetPosition2Coordinate()->GetValue());
851
852
853
854
855
    this->SetDrawBackground(a->GetDrawBackground());
    this->SetBackgroundProperty(a->GetBackgroundProperty());
    this->SetDrawFrame(a->GetDrawFrame());
    this->SetFrameProperty(a->GetFrameProperty());
    this->SetEnhancedMode(a->GetEnhancedMode());
Will Schroeder's avatar
Will Schroeder committed
856
857
858
859
860
    }

  // Now do superclass
  this->vtkActor2D::ShallowCopy(prop);
}
Ken Martin's avatar
Ken Martin committed
861

Sebastien Barre's avatar
Sebastien Barre committed
862
863
864
//----------------------------------------------------------------------------
void vtkScalarBarActor::AllocateAndSizeLabels(int *labelSize, 
                                              int *size,
Ken Martin's avatar
Ken Martin committed
865
                                              vtkViewport *viewport,
Ken Martin's avatar
Ken Martin committed
866
                                              double *range)
Ken Martin's avatar
Ken Martin committed
867
{
Sebastien Barre's avatar
Sebastien Barre committed
868
869
  labelSize[0] = labelSize[1] = 0;

Ken Martin's avatar
Ken Martin committed
870
871
  this->TextMappers = new vtkTextMapper * [this->NumberOfLabels];
  this->TextActors = new vtkActor2D * [this->NumberOfLabels];
Sebastien Barre's avatar
Sebastien Barre committed
872

Ken Martin's avatar
Ken Martin committed
873
  char string[512];
Sebastien Barre's avatar
Sebastien Barre committed
874

Ken Martin's avatar
Ken Martin committed
875
  double val;
Ken Martin's avatar
Ken Martin committed
876
877
  int i;
  
Sebastien Barre's avatar
Sebastien Barre committed
878
879
880
881
882
  // TODO: this should be optimized, maybe by keeping a list of
  // allocated mappers, in order to avoid creation/destruction of
  // their underlying text properties (i.e. each time a mapper is
  // created, text properties are created and shallow-assigned a font size
  // which value might be "far" from the target font size).
883

884
885
  // is this a vtkLookupTable or a subclass of vtkLookupTable 
  // with its scale set to log
886
  int isLogTable = this->LookupTable->UsingLogScale();
887

Ken Martin's avatar
Ken Martin committed
888
889
890
  for (i=0; i < this->NumberOfLabels; i++)
    {
    this->TextMappers[i] = vtkTextMapper::New();
Sebastien Barre's avatar
Sebastien Barre committed
891

892
893
    if ( isLogTable )
      {
Ken Martin's avatar
Ken Martin committed
894
      double lval;
Ken Martin's avatar
Ken Martin committed
895
896
      if (this->NumberOfLabels > 1)
        {
897
898
        lval = log10(range[0]) +
          static_cast<double>(i)/(this->NumberOfLabels-1) *
Ken Martin's avatar
Ken Martin committed
899
900
901
902
903
904
          (log10(range[1])-log10(range[0]));
        }
      else
        {
        lval = log10(range[0]) + 0.5*(log10(range[1])-log10(range[0]));
        }
Ken Martin's avatar
Ken Martin committed
905
      val = pow(10.0,lval);
906
907
908
      }
    else
      {
Ken Martin's avatar
Ken Martin committed
909
910
      if (this->NumberOfLabels > 1)
        {
911
912
913
        val = range[0] +
          static_cast<double>(i)/(this->NumberOfLabels-1) 
          * (range[1]-range[0]);
Ken Martin's avatar
Ken Martin committed
914
915
916
917
918
        }
      else
        {
        val = range[0] + 0.5*(range[1]-range[0]);
        }
919
920
      }

Ken Martin's avatar
Ken Martin committed
921
922
    sprintf(string, this->LabelFormat, val);
    this->TextMappers[i]->SetInput(string);
Sebastien Barre's avatar
Sebastien Barre committed
923
924
925
926
927
928
929
930
931
932

    // Shallow copy here so that the size of the label prop is not affected
    // by the automatic adjustment of its text mapper's size (i.e. its
    // mapper's text property is identical except for the font size
    // which will be modified later). This allows text actors to
    // share the same text property, and in that case specifically allows
    // the title and label text prop to be the same.
    this->TextMappers[i]->GetTextProperty()->ShallowCopy(
      this->LabelTextProperty);

Ken Martin's avatar
Ken Martin committed
933
934
935
936
937
938
    this->TextActors[i] = vtkActor2D::New();
    this->TextActors[i]->SetMapper(this->TextMappers[i]);
    this->TextActors[i]->SetProperty(this->GetProperty());
    this->TextActors[i]->GetPositionCoordinate()->
      SetReferenceCoordinate(this->PositionCoordinate);
    }
Sebastien Barre's avatar
Sebastien Barre committed
939

Ken Martin's avatar
Ken Martin committed
940
941
  if (this->NumberOfLabels)
    {
Sebastien Barre's avatar
Sebastien Barre committed
942
943
    int targetWidth, targetHeight;

Ken Martin's avatar
Ken Martin committed
944
945
    if ( this->Orientation == VTK_ORIENT_VERTICAL )
      {
946
947
      targetWidth = static_cast<int>(0.6*size[0]);
      targetHeight = static_cast<int>(0.86*size[1]/this->NumberOfLabels);
Ken Martin's avatar
Ken Martin committed
948
949
950
      }
    else
      {
951
952
      targetWidth = static_cast<int>(size[0]*0.8/this->NumberOfLabels);
      targetHeight = static_cast<int>(0.25*size[1]);
Ken Martin's avatar
Ken Martin committed
953
      }
Sebastien Barre's avatar
Sebastien Barre committed
954
955
956
957
958
959
960

    vtkTextMapper::SetMultipleConstrainedFontSize(viewport, 
                                                  targetWidth, 
                                                  targetHeight,
                                                  this->TextMappers,
                                                  this->NumberOfLabels,
                                                  labelSize);
Ken Martin's avatar
Ken Martin committed
961
962
963
    }
}

Sebastien Barre's avatar
Sebastien Barre committed
964
965
966
//----------------------------------------------------------------------------
void vtkScalarBarActor::SizeTitle(int *titleSize, 
                                  int *size, 
Ken Martin's avatar
Ken Martin committed
967
968
                                  vtkViewport *viewport)
{
Sebastien Barre's avatar
Sebastien Barre committed
969
970
971
972
973
974
975
  titleSize[0] = titleSize[1] = 0;

  if (this->Title == NULL || !strlen(this->Title))
    {
    return;
    }

Ken Martin's avatar
Ken Martin committed
976
977
  int targetWidth, targetHeight;
  
Sebastien Barre's avatar
Sebastien Barre committed
978
979
  targetWidth = size[0];
  if ( this->Orientation == VTK_ORIENT_VERTICAL )
Ken Martin's avatar
Ken Martin committed
980
    {
981
    targetHeight = static_cast<int>(0.1*size[1]);
Sebastien Barre's avatar
Sebastien Barre committed
982
983
984
    }
  else
    {
985
    targetHeight = static_cast<int>(0.25*size[1]);
Ken Martin's avatar
Ken Martin committed
986
    }
Sebastien Barre's avatar
Sebastien Barre committed
987
988
989
990
991
992

  this->TitleMapper->SetConstrainedFontSize(
    viewport, targetWidth, targetHeight);

  this->TitleMapper->GetSize(viewport, titleSize);
}