vtkScalarBarActor.cxx 54.6 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
#include "vtkFloatArray.h"
#include "vtkPointData.h"
#include "vtkTexture.h"
#include "vtkImageData.h"
#include "vtkRenderer.h"
33
#include "vtkMathTextActor.h"
34
35
#include "vtkProperty2D.h"

36
37
38
#include <vector>
#include <set>

Brad King's avatar
Brad King committed
39
vtkStandardNewMacro(vtkScalarBarActor);
40

41
vtkCxxSetObjectMacro(vtkScalarBarActor,LookupTable,vtkScalarsToColors);
Sebastien Barre's avatar
Sebastien Barre committed
42
43
vtkCxxSetObjectMacro(vtkScalarBarActor,LabelTextProperty,vtkTextProperty);
vtkCxxSetObjectMacro(vtkScalarBarActor,TitleTextProperty,vtkTextProperty);
44
45
vtkCxxSetObjectMacro(vtkScalarBarActor,BackgroundProperty,vtkProperty2D);
vtkCxxSetObjectMacro(vtkScalarBarActor,FrameProperty,vtkProperty2D);
46

Sebastien Barre's avatar
Sebastien Barre committed
47
48
//----------------------------------------------------------------------------
// Instantiate object with 64 maximum colors; 5 labels; %%-#6.3g label
49
50
51
52
53
// 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;
54
  this->Position2Coordinate->SetValue(0.17, 0.8);
55

56
57
  this->PositionCoordinate->SetCoordinateSystemToNormalizedViewport();
  this->PositionCoordinate->SetValue(0.82,0.1);
58

59
60
  this->MaximumNumberOfColors = 64;
  this->NumberOfLabels = 5;
61
  this->NumberOfLabelsBuilt = 0;
62
63
  this->Orientation = VTK_ORIENT_VERTICAL;
  this->Title = NULL;
64
  this->ComponentTitle = NULL;
65

Sebastien Barre's avatar
Sebastien Barre committed
66
67
68
69
70
71
72
73
74
75
  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);

76
  this->LabelFormat = new char[8];
77
78
79
80
81
  sprintf(this->LabelFormat,"%s","%-#6.3g");

  this->TitleMapper = vtkTextMapper::New();
  this->TitleActor = vtkActor2D::New();
  this->TitleActor->SetMapper(this->TitleMapper);
82
83
  this->TitleActor->GetPositionCoordinate()->
    SetReferenceCoordinate(this->PositionCoordinate);
84

85
86
87
88
89
  this->TextMappers = NULL;
  this->TextActors = NULL;

  this->ScalarBar = vtkPolyData::New();
  this->ScalarBarMapper = vtkPolyDataMapper2D::New();
90
  this->ScalarBarMapper->SetInputData(this->ScalarBar);
91
92
  this->ScalarBarActor = vtkActor2D::New();
  this->ScalarBarActor->SetMapper(this->ScalarBarMapper);
93
94
  this->ScalarBarActor->GetPositionCoordinate()->
    SetReferenceCoordinate(this->PositionCoordinate);
Ken Martin's avatar
Ken Martin committed
95
96
97
98
  this->LastOrigin[0] = 0;
  this->LastOrigin[1] = 0;
  this->LastSize[0] = 0;
  this->LastSize[1] = 0;
99

David Thompson's avatar
David Thompson committed
100
101
  this->DrawAnnotations = 1;
  this->AnnotationLeaderPadding = 8.;
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
  this->AnnotationBoxes = vtkPolyData::New();
  this->AnnotationBoxesMapper = vtkPolyDataMapper2D::New();
  this->AnnotationBoxesActor = vtkActor2D::New();
  this->AnnotationBoxesMapper->SetInputData( this->AnnotationBoxes );
  this->AnnotationBoxesActor->SetMapper( this->AnnotationBoxesMapper );
  this->AnnotationBoxesActor->GetPositionCoordinate()->
    SetReferenceCoordinate( this->PositionCoordinate );
  this->AnnotationLeaders = vtkPolyData::New();
  this->AnnotationLeadersMapper = vtkPolyDataMapper2D::New();
  this->AnnotationLeadersActor = vtkActor2D::New();
  this->AnnotationLeadersMapper->SetInputData( this->AnnotationLeaders );
  this->AnnotationLeadersActor->SetMapper( this->AnnotationLeadersMapper );
  this->AnnotationLeadersActor->GetPositionCoordinate()->
    SetReferenceCoordinate( this->PositionCoordinate );
  this->AnnotationLabels = 0; // Can't allocate until we have a lookup table.
  this->NumberOfAnnotationLabelsBuilt = 0;

119
120
121
122
  // If opacity is on, a jail like texture is displayed behind it..

  this->UseOpacity       = 0;
  this->TextureGridWidth = 10.0;
123

124
125
  this->TexturePolyData = vtkPolyData::New();
  vtkPolyDataMapper2D * textureMapper = vtkPolyDataMapper2D::New();
126
  textureMapper->SetInputData(this->TexturePolyData);
127
128
129
130
131
132
133
134
  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);
135
  tc->InsertComponent(0,0, 0.0);
136
137
  tc->InsertComponent(0,1, 0.0);
  tc->InsertComponent(1,1, 0.0);
138
  tc->InsertComponent(3,0, 0.0);
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
  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);
Berk Geveci's avatar
Berk Geveci committed
161
  image->AllocateScalars(VTK_UNSIGNED_CHAR, 1);
162

163
164
  for (unsigned int y = 0; y < dim; y++)
    {
165
    unsigned char *ptr =
166
167
168
169
170
171
172
173
174
      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();
175
  this->Texture->SetInputData( image );
176
177
  this->Texture->RepeatOn();
  image->Delete();
178
179
180
181

  // Default text position : Above scalar bar if orientation is horizontal
  //                         Right of scalar bar if orientation is vertical
  this->TextPosition = SucceedScalarBar;
182
183
184

  this->MaximumWidthInPixels = VTK_INT_MAX;
  this->MaximumHeightInPixels = VTK_INT_MAX;
185
186
187
188
189
190
191

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

  this->DrawBackground = 0;
  this->Background = vtkPolyData::New();
  this->BackgroundMapper = vtkPolyDataMapper2D::New();
192
  this->BackgroundMapper->SetInputData(this->Background);
193
194
195
196
197
198
199
  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();
200
  this->FrameMapper->SetInputData(this->Frame);
201
202
203
  this->FrameActor = vtkActor2D::New();
  this->FrameActor->SetMapper(this->FrameMapper);
  this->FrameActor->GetPositionCoordinate()->SetReferenceCoordinate(this->PositionCoordinate);
204
205
}

Sebastien Barre's avatar
Sebastien Barre committed
206
//----------------------------------------------------------------------------
Ken Martin's avatar
Ken Martin committed
207
208
209
210
211
212
213
214
215
216
217
218
219
// 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);
      }
    }
220
221
222
223
224
225
226
  if ( this->AnnotationLabels != NULL )
    {
    for ( int i = 0; i < this->NumberOfAnnotationLabelsBuilt; ++ i )
      {
      this->AnnotationLabels[i]->ReleaseGraphicsResources(win);
      }
    }
Ken Martin's avatar
Ken Martin committed
227
  this->ScalarBarActor->ReleaseGraphicsResources(win);
228
229
  this->AnnotationBoxesActor->ReleaseGraphicsResources(win);
  this->AnnotationLeadersActor->ReleaseGraphicsResources(win);
230
231
  this->BackgroundActor->ReleaseGraphicsResources(win);
  this->FrameActor->ReleaseGraphicsResources(win);
Ken Martin's avatar
Ken Martin committed
232
233
}

Sebastien Barre's avatar
Sebastien Barre committed
234
//----------------------------------------------------------------------------
235
236
vtkScalarBarActor::~vtkScalarBarActor()
{
237
  if (this->LabelFormat)
Ken Martin's avatar
Ken Martin committed
238
239
240
241
    {
    delete [] this->LabelFormat;
    this->LabelFormat = NULL;
    }
242
243
244
245
246
247

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

  if (this->TextMappers != NULL )
    {
248
    for (int i=0; i < this->NumberOfLabelsBuilt; i++)
249
250
251
252
253
254
255
256
      {
      this->TextMappers[i]->Delete();
      this->TextActors[i]->Delete();
      }
    delete [] this->TextMappers;
    delete [] this->TextActors;
    }

257
258
259
260
261
262
263
264
265
  if ( this->AnnotationLabels != NULL )
    {
    for ( int i = 0; i < this->NumberOfAnnotationLabelsBuilt; ++ i )
      {
      this->AnnotationLabels[i]->Delete();
      }
    delete [] this->AnnotationLabels;
    }

266
267
268
  this->ScalarBar->Delete();
  this->ScalarBarMapper->Delete();
  this->ScalarBarActor->Delete();
Ken Martin's avatar
Ken Martin committed
269

270
271
272
273
274
275
276
277
  this->AnnotationBoxes->Delete();
  this->AnnotationBoxesMapper->Delete();
  this->AnnotationBoxesActor->Delete();

  this->AnnotationLeaders->Delete();
  this->AnnotationLeadersMapper->Delete();
  this->AnnotationLeadersActor->Delete();

Ken Martin's avatar
Ken Martin committed
278
279
280
281
282
  if (this->Title)
    {
    delete [] this->Title;
    this->Title = NULL;
    }
283
284
285
286
287
288

  if ( this->ComponentTitle )
    {
    delete [] this->ComponentTitle;
    this->ComponentTitle = NULL;
    }
289

290
  this->SetLookupTable(NULL);
Sebastien Barre's avatar
Sebastien Barre committed
291
292
  this->SetLabelTextProperty(NULL);
  this->SetTitleTextProperty(NULL);
293
294
295
  this->Texture->Delete();
  this->TextureActor->Delete();
  this->TexturePolyData->Delete();
296
297
298
299
300
301
302
303
  this->Background->Delete();
  this->BackgroundMapper->Delete();
  this->BackgroundActor->Delete();
  this->Frame->Delete();
  this->FrameMapper->Delete();
  this->FrameActor->Delete();
  this->SetBackgroundProperty(NULL);
  this->SetFrameProperty(NULL);
304
305
}

Sebastien Barre's avatar
Sebastien Barre committed
306
//----------------------------------------------------------------------------
307
int vtkScalarBarActor::RenderOverlay(vtkViewport *viewport)
Ken Martin's avatar
Ken Martin committed
308
{
309
  int renderedSomething = 0;
Ken Martin's avatar
Ken Martin committed
310
  int i;
311

312
313
314
315
  if (this->DrawBackground)
    {
    renderedSomething += this->BackgroundActor->RenderOverlay(viewport);
    }
316

317
318
319
320
  if (this->DrawFrame)
    {
    renderedSomething += this->FrameActor->RenderOverlay(viewport);
    }
321

322
323
324
325
326
327
  if (this->UseOpacity)
    {
    this->Texture->Render(vtkRenderer::SafeDownCast(viewport));
    renderedSomething += this->TextureActor->RenderOverlay(viewport);
    }

Ken Martin's avatar
Ken Martin committed
328
329
330
  // Everything is built, just have to render
  if (this->Title != NULL)
    {
331
    renderedSomething += this->TitleActor->RenderOverlay(viewport);
Ken Martin's avatar
Ken Martin committed
332
    }
333
334
335
336

  // Draw either the scalar bar (non-indexed mode) or the annotated value boxes (indexed mode).
  vtkLookupTable* lkup = vtkLookupTable::SafeDownCast( this->LookupTable );
  if ( ! lkup || ( lkup && ! lkup->GetIndexedLookup() ) )
337
    {
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
    this->ScalarBarActor->RenderOverlay(viewport);

    if( this->TextActors == NULL)
      {
      vtkWarningMacro(<<"Need a mapper to render a scalar bar");
      return renderedSomething;
      }

    for (i=0; i<this->NumberOfLabels; i++)
      {
      renderedSomething += this->TextActors[i]->RenderOverlay(viewport);
      }
    }
  else
    {
    this->AnnotationBoxesActor->RenderOverlay(viewport);
354
    }
355

356
  if ( this->AnnotationLabels == NULL && this->NumberOfAnnotationLabelsBuilt )
Ken Martin's avatar
Ken Martin committed
357
    {
358
359
    vtkWarningMacro(<<"Need a mapper to render the scalar bar");
    return renderedSomething;
Ken Martin's avatar
Ken Martin committed
360
    }
361

David Thompson's avatar
David Thompson committed
362
  if ( this->DrawAnnotations )
363
    {
David Thompson's avatar
David Thompson committed
364
365
366
367
368
369
    if ( this->NumberOfAnnotationLabelsBuilt )
      this->AnnotationLeadersActor->RenderOverlay( viewport );
    for ( i = 0; i < this->NumberOfAnnotationLabelsBuilt; ++ i )
      {
      renderedSomething += this->AnnotationLabels[i]->RenderOverlay( viewport );
      }
370
    }
371

372
  renderedSomething = (renderedSomething > 0)?(1):(0);
373
  return renderedSomething;
Ken Martin's avatar
Ken Martin committed
374
375
}

Sebastien Barre's avatar
Sebastien Barre committed
376
//----------------------------------------------------------------------------
377
int vtkScalarBarActor::RenderOpaqueGeometry(vtkViewport *viewport)
378
{
379
  int renderedSomething = 0;
380
  int i;
381
  int size[2];
382

Sebastien Barre's avatar
Sebastien Barre committed
383
  if (!this->LookupTable)
384
385
    {
    vtkWarningMacro(<<"Need a mapper to render a scalar bar");
386
    return 0;
387
388
    }

Sebastien Barre's avatar
Sebastien Barre committed
389
390
391
392
393
394
395
396
397
398
399
400
  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
401
  // Check to see whether we have to rebuild everything
402
  int positionsHaveChanged = 0;
403
404
  if (viewport->GetMTime() > this->BuildTime ||
      (viewport->GetVTKWindow() &&
Sebastien Barre's avatar
Sebastien Barre committed
405
       viewport->GetVTKWindow()->GetMTime() > this->BuildTime))
Ken Martin's avatar
Ken Martin committed
406
407
408
    {
    // 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
409
    int *barOrigin;
Ken Martin's avatar
Ken Martin committed
410
    barOrigin = this->PositionCoordinate->GetComputedViewportValue(viewport);
411
    size[0] =
Ken Martin's avatar
Ken Martin committed
412
413
      this->Position2Coordinate->GetComputedViewportValue(viewport)[0] -
      barOrigin[0];
414
    size[1] =
Ken Martin's avatar
Ken Martin committed
415
416
      this->Position2Coordinate->GetComputedViewportValue(viewport)[1] -
      barOrigin[1];
417

418
419
    // Check if we have bounds on the maximum size
    size[0] = size[0] > this->MaximumWidthInPixels
420
            ? this->MaximumWidthInPixels : size[0];
421
    size[1] = size[1] > this->MaximumHeightInPixels
422
423
            ? this->MaximumHeightInPixels : size[1];

424
    if (this->LastSize[0] != size[0] ||
Sebastien Barre's avatar
Sebastien Barre committed
425
        this->LastSize[1] != size[1] ||
426
        this->LastOrigin[0] != barOrigin[0] ||
427
        this->LastOrigin[1] != barOrigin[1])
Ken Martin's avatar
Ken Martin committed
428
      {
429
      positionsHaveChanged = 1;
Ken Martin's avatar
Ken Martin committed
430
431
      }
    }
432

433
  // Check to see whether we have to rebuild everything
434
  if (positionsHaveChanged ||
435
      this->GetMTime() > this->BuildTime ||
Sebastien Barre's avatar
Sebastien Barre committed
436
437
      this->LookupTable->GetMTime() > this->BuildTime ||
      this->LabelTextProperty->GetMTime() > this->BuildTime ||
438
439
440
441
      this->TitleTextProperty->GetMTime() > this->BuildTime ||
      this->BackgroundProperty->GetMTime() > this->BuildTime ||
      this->FrameProperty->GetMTime() > this->BuildTime)

442
443
444
445
446
447
448
    {
    vtkDebugMacro(<<"Rebuilding subobjects");

    // Delete previously constructed objects
    //
    if (this->TextMappers != NULL )
      {
449
      for (i=0; i < this->NumberOfLabelsBuilt; i++)
450
451
452
453
        {
        this->TextMappers[i]->Delete();
        this->TextActors[i]->Delete();
        }
454
455
456
457
      delete [] this->TextMappers;
      delete [] this->TextActors;
      }

458
459
460
461
462
463
464
465
    if ( this->AnnotationLabels != NULL )
      {
      for ( i = 0; i < this->NumberOfAnnotationLabelsBuilt; ++ i )
        {
        this->AnnotationLabels[i]->Delete();
        }
      delete [] this->AnnotationLabels;
      this->AnnotationLabels = 0;
David Thompson's avatar
David Thompson committed
466
      this->NumberOfAnnotationLabelsBuilt = 0;
467
468
      }

469
    // Build scalar bar object; determine its type
470
    // i.e. is scale set to log, is categorical or continuous?
471
    int isLogTable = this->LookupTable->UsingLogScale();
472
473
    vtkLookupTable* lkup = vtkLookupTable::SafeDownCast( this->LookupTable );
    int isCategorical = lkup && lkup->GetIndexedLookup();
474

Ken Martin's avatar
Ken Martin committed
475
    // we hard code how many steps to display
476
    vtkScalarsToColors *lut = this->LookupTable;
Ken Martin's avatar
Ken Martin committed
477
    int numColors = this->MaximumNumberOfColors;
Ken Martin's avatar
Ken Martin committed
478
    double *range = lut->GetRange();
479
480
481
482
483
484

    int numPts = 2*(numColors + 1);
    vtkPoints *pts = vtkPoints::New();
    pts->SetNumberOfPoints(numPts);
    vtkCellArray *polys = vtkCellArray::New();
    polys->Allocate(polys->EstimateSize(numColors,4));
485
    vtkUnsignedCharArray *colors = vtkUnsignedCharArray::New();
486
487
488

    unsigned int nComponents = ((this->UseOpacity) ? 4 : 3);
    colors->SetNumberOfComponents( nComponents );
489
    colors->SetNumberOfTuples(numColors);
490
491
492
493
494
495
496
497

    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();

498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
    // 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();

522
    // get the viewport size in display coordinates
523
524
    int *barOrigin, barWidth, barHeight;
    barOrigin = this->PositionCoordinate->GetComputedViewportValue(viewport);
525
    size[0] =
526
527
      this->Position2Coordinate->GetComputedViewportValue(viewport)[0] -
      barOrigin[0];
528
    size[1] =
529
530
      this->Position2Coordinate->GetComputedViewportValue(viewport)[1] -
      barOrigin[1];
531

532
533
    // Check if we have bounds on the maximum size
    size[0] = size[0] > this->MaximumWidthInPixels
534
            ? this->MaximumWidthInPixels : size[0];
535
    size[1] = size[1] > this->MaximumHeightInPixels
536
            ? this->MaximumHeightInPixels : size[1];
537

Ken Martin's avatar
Ken Martin committed
538
539
540
541
    this->LastOrigin[0] = barOrigin[0];
    this->LastOrigin[1] = barOrigin[1];
    this->LastSize[0] = size[0];
    this->LastSize[1] = size[1];
542

543
544
    // Update all the composing objects
    this->TitleActor->SetProperty(this->GetProperty());
545
546


547
548
549
    //update with the proper title
    if ( this->ComponentTitle && strlen(this->ComponentTitle) > 0 )
      {
550
      //need to account for a space between title & component and null term
551
      char *combinedTitle = new char[ ( strlen(this->Title) + strlen(this->ComponentTitle) + 2) ];
552
553
554
555
556
557
558
559
560
561
562
      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
563
564
565
566
567
568
569
570
571
572
573
    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();
      }
574

Ken Martin's avatar
Ken Martin committed
575
576
577
    // find the best size for the title font
    int titleSize[2];
    this->SizeTitle(titleSize, size, viewport);
578

Ken Martin's avatar
Ken Martin committed
579
580
581
    // find the best size for the ticks
    int labelSize[2];
    this->AllocateAndSizeLabels(labelSize, size, viewport,range);
582
    this->NumberOfLabelsBuilt = this->NumberOfLabels;
583

584
    // generate points
Ken Martin's avatar
Ken Martin committed
585
586
    double x[3]; x[2] = 0.0;
    double delta;
Philippe Pébay's avatar
Philippe Pébay committed
587
588
    int barX = 0;
    int barY = 0;
589
590
    if ( this->Orientation == VTK_ORIENT_VERTICAL )
      {
591
592
593
      // Adjust height and width only in enhanced more or if at least
      // one amongst the frame and the background was requested
      if ( this->DrawBackground ||
594
           this->DrawFrame )
595
596
597
598
        {
        barX = static_cast<int>(size[0] * 0.05);
        barY = static_cast<int>(size[1] * 0.05 + labelSize[1] / 2);
        }
599
600
601

      barWidth = size[0] - 4 - labelSize[0] - 2 * barX;
      barHeight = static_cast<int>(0.86*size[1]) - barY;
602
      delta=static_cast<double>(barHeight)/numColors;
603
      for (i=0; i<numPts/2; i++)
604
        {
605
        x[0] = (this->TextPosition == vtkScalarBarActor::PrecedeScalarBar)
606
607
          ? (size[0] - barWidth - barX) : barX;
        x[1] = barY + i*delta;
608
        pts->SetPoint(2*i,x);
609
        x[0] = (this->TextPosition == vtkScalarBarActor::PrecedeScalarBar)
610
          ? size[0] - barX: barX + barWidth;
611
        pts->SetPoint(2*i+1,x);
612
        }
613
614
615
      }
    else
      {
616
617
618
      // Adjust height and width only in enhanced more or if at least
      // one amongst the frame and the background was requested
      if ( this->DrawBackground ||
619
           this->DrawFrame )
620
        {
621
622
        barX = static_cast<int>(size[0] * 0.05) + labelSize[0] / 2;
        barY = static_cast<int>(size[1] * 0.05);
623
        }
624
625
      barWidth = size[0] - 2 * barX;
      barHeight = static_cast<int>(0.4*size[1]) - barY;
626
      delta=static_cast<double>(barWidth)/numColors;
627
      for (i=0; i<numPts/2; i++)
628
        {
629
        x[0] = barX + i*delta;
630
        x[1] = (this->TextPosition == vtkScalarBarActor::PrecedeScalarBar)
631
          ? size[1] - barY: barY + barHeight ;
632
        pts->SetPoint(2*i,x);
633
        x[1] = (this->TextPosition == vtkScalarBarActor::PrecedeScalarBar)
634
          ? (size[1]-barHeight - barY) : barY;
635
        pts->SetPoint(2*i+1,x);
636
        }
637
      }
638

639
640
    //polygons & cell colors
    unsigned char *rgba, *rgb;
641
    vtkIdType ptIds[4];
642
643
644
645
646
647
648
649
    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);

650
651
      if ( isLogTable )
        {
652
        double rgbval = log10(range[0]) +
653
          i*(log10(range[1])-log10(range[0]))/(numColors -1);
Ken Martin's avatar
Ken Martin committed
654
        rgba = lut->MapValue(pow(10.0,rgbval));
655
656
657
658
        }
      else
        {
        rgba = lut->MapValue(range[0] + (range[1] - range[0])*
659
                             (i /(numColors-1.0)));
660
661
        }

662
      rgb = colors->GetPointer( nComponents * i); //write into array directly
663
664
665
      rgb[0] = rgba[0];
      rgb[1] = rgba[1];
      rgb[2] = rgba[2];
666
667
668
669
      if (this->UseOpacity)
        {
        rgb[3] = rgba[3];
        }
670
671
      }

672
673
674
675
676
    // generate background and frame points and cell
    x[0]=0; x[1]=0;
    bgPts->SetPoint(0,x);
    frPts->SetPoint(0,x);
    frPts->SetPoint(4,x);
677

678
679
680
    x[0]=0; x[1]=size[1];
    bgPts->SetPoint(1,x);
    frPts->SetPoint(1,x);
681

682
683
684
    x[0]=size[0]; x[1]=size[1];
    bgPts->SetPoint(2,x);
    frPts->SetPoint(2,x);
685

686
687
688
689
690
691
692
693
    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);

694
695
    // Now position everything properly
    //
Ken Martin's avatar
Ken Martin committed
696
    double val;
697
    int sizeTextData[2];
698
699
    if (this->Orientation == VTK_ORIENT_VERTICAL)
      {
700
      // center the title
Ken Martin's avatar
Ken Martin committed
701
      this->TitleActor->SetPosition(size[0]/2, 0.9*size[1]);
702

Jim Miller's avatar
Style    
Jim Miller committed
703
      for (i=0; i < this->NumberOfLabels; i++)
704
        {
Ken Martin's avatar
Ken Martin committed
705
706
        if (this->NumberOfLabels > 1)
          {
707
          val = static_cast<double>(i)/(this->NumberOfLabels-1) *barHeight + barY;
Ken Martin's avatar
Ken Martin committed
708
          }
709
        else
Ken Martin's avatar
Ken Martin committed
710
          {
711
          val = 0.5*(barHeight + barY);
Ken Martin's avatar
Ken Martin committed
712
          }
713
        this->TextMappers[i]->GetSize(viewport,sizeTextData);
Sebastien Barre's avatar
Sebastien Barre committed
714
        this->TextMappers[i]->GetTextProperty()->SetJustificationToLeft();
715
716
        if (this->TextPosition == vtkScalarBarActor::PrecedeScalarBar)
          {
717
          this->TextActors[i]->SetPosition(barX,
718
                                           val - 0.6*sizeTextData[1]);
719
720
721
          }
        else
          {
722
          this->TextActors[i]->SetPosition(barX + barWidth + 3,
723
                                           val - 0.6*sizeTextData[1]);
724
          }
725
        }
726
      }
727
    else // if (this->Orientation == VTK_ORIENT_VERTICAL)
728
      {
729
730
      if (this->TextPosition == vtkScalarBarActor::PrecedeScalarBar)
        {
731
        this->TitleActor->SetPosition(size[0]/2,
732
                                      barY + 0.1*titleSize[1]);
733
734
735
        }
      else
        {
736
        this->TitleActor->SetPosition(size[0]/2,
737
                                      barHeight + labelSize[1] + 0.1*size[1] + 0.15*titleSize[1]);
738
        }
Jim Miller's avatar
Style    
Jim Miller committed
739
      for (i=0; i < this->NumberOfLabels; i++)
740
        {
741
        this->TextMappers[i]->GetSize(viewport,sizeTextData);
Sebastien Barre's avatar
Sebastien Barre committed
742
        this->TextMappers[i]->GetTextProperty()->SetJustificationToCentered();
Ken Martin's avatar
Ken Martin committed
743
744
        if (this->NumberOfLabels > 1)
          {
745
          val = static_cast<double>(i)/(this->NumberOfLabels-1) * barWidth + barX;
Ken Martin's avatar
Ken Martin committed
746
747
748
          }
        else
          {
749
          val = 0.5*(barWidth+barY);
Ken Martin's avatar
Ken Martin committed
750
          }
751
752
753
754
755
756
        if (this->TextPosition == vtkScalarBarActor::PrecedeScalarBar)
          {
          this->TextActors[i]->SetPosition(val, size[1] * 0.3);
          }
        else
          {
757
          this->TextActors[i]->SetPosition(val, barY + barHeight + 0.05*size[1]);
758
          }
759
        }
760
761
      }

762
763
764
765
766
767
    // Set the texture points
    //
    vtkPoints *texturePoints = vtkPoints::New();
    texturePoints->SetNumberOfPoints(4);
    this->TexturePolyData->SetPoints(texturePoints);
    texturePoints->SetPoint(0, 0.0, 0.0, 0.0);
768
769
770
771

    double p1[2], p2[2];
    if (this->Orientation == VTK_ORIENT_VERTICAL)
      {
772
      p1[0] = (this->TextPosition == vtkScalarBarActor::PrecedeScalarBar)
773
774
        ? (size[0] - barWidth - barX) : barX;
      p1[1] = barY;
775
      p2[0] = p1[0] + barWidth;
776
      p2[1] = p1[1] + barHeight;
777
778
779
      }
    else
      {
780
      p1[0] = barX;
781
      p1[1] = (this->TextPosition == vtkScalarBarActor::PrecedeScalarBar)
782
        ? (size[1] - barHeight - barY) : barY;
783
784
785
786
787
788
789
790
      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);
791
792
793
794
    texturePoints->Delete();

    vtkDataArray * tc = this->TexturePolyData->GetPointData()->GetTCoords();
    tc->SetTuple2(1, barWidth / this->TextureGridWidth, 0.0);
795
    tc->SetTuple2(2, barWidth / this->TextureGridWidth,
796
                  barHeight / this->TextureGridWidth);
797
798
    tc->SetTuple2(3, 0.0, barHeight / this->TextureGridWidth);

799
800
801
802
803
804
    if ( isCategorical )
      {
      // this->ScalarBar will not be drawn; instead, draw padded boxes
      // and leaders to labels for each annotated value.
      // Since labels are user-provided, we render with vtkMathTextActor to allow fancy-ness.
      int numNotes = lkup->GetNumberOfAnnotatedValues();
David Thompson's avatar
David Thompson committed
805
      numPts = 4 * numNotes; // 2 triangles per annotation: half-opaque, half-translucent.
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
      pts = vtkPoints::New();
      pts->SetNumberOfPoints( numPts );
      polys = vtkCellArray::New();
      polys->Allocate( polys->EstimateSize( 2 * numNotes, 3 ) );
      colors = vtkUnsignedCharArray::New();
      colors->SetNumberOfComponents( 4 ); // RGBA
      colors->SetNumberOfTuples( 2 * numNotes );

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

      // Use the nicely-provided scalar bar position to place
      // the annotated value swatches.
David Thompson's avatar
David Thompson committed
823
      double swatchPad;
David Thompson's avatar
David Thompson committed
824
      double swatchC0, swatchC1; // fixed swatch coordinates
825
826
827
828
829
      if ( this->Orientation == VTK_ORIENT_VERTICAL )
        {
        barWidth = size[0] - 4 - labelSize[0] - 2 * barX;
        barHeight = static_cast<int>(0.86*size[1]) - barY;
        delta = static_cast<double>(barHeight) / numNotes;
David Thompson's avatar
David Thompson committed
830
        swatchPad = delta > 16. ? 4. : ( delta / 4. );
David Thompson's avatar
David Thompson committed
831
832
833
        swatchC0 = ( this->TextPosition == vtkScalarBarActor::PrecedeScalarBar )
          ? ( size[0] - barWidth - barX ) : barX;
        swatchC1 = swatchC0 + barWidth;
David Thompson's avatar
David Thompson committed
834
        this->NumberOfAnnotationLabelsBuilt =
David Thompson's avatar
David Thompson committed
835
836
837
          this->LayoutAnnotationsVertically(
            this->TextPosition == vtkScalarBarActor::PrecedeScalarBar ? swatchC1 : swatchC0,
            barY, barWidth, barHeight, delta, swatchPad );
838
839
        for ( i = 0; i < numNotes; ++ i )
          {
David Thompson's avatar
David Thompson committed
840
          x[0] = swatchC0;
David Thompson's avatar
David Thompson committed
841
          x[1] = barY + i * delta + swatchPad;
842
          pts->SetPoint( 4 * i, x );
David Thompson's avatar
David Thompson committed
843
          x[0] = swatchC1;
844
          pts->SetPoint( 4 * i + 1, x );
David Thompson's avatar
David Thompson committed
845
          x[1] += delta - swatchPad * 2;
846
          pts->SetPoint( 4 * i + 2, x );
David Thompson's avatar
David Thompson committed
847
          x[0] = swatchC0;
848
849
850
851
852
853
854
855
          pts->SetPoint( 4 * i + 3, x );
          }
        }
      else
        {
        barWidth = size[0] - 2 * barX;
        barHeight = static_cast<int>( 0.4 * size[1] ) - barY;
        delta = static_cast<double>(barWidth) / numNotes;
David Thompson's avatar
David Thompson committed
856
        swatchPad = delta > 16. ? 4. : ( delta / 4. );
David Thompson's avatar
David Thompson committed
857
858
859
860
        swatchC0 = (this->TextPosition == vtkScalarBarActor::PrecedeScalarBar)
          ? size[1] - barY: barY + barHeight ;
        swatchC1 = (this->TextPosition == vtkScalarBarActor::PrecedeScalarBar)
          ? (size[1]-barHeight - barY) : barY;
David Thompson's avatar
David Thompson committed
861
        this->NumberOfAnnotationLabelsBuilt =
David Thompson's avatar
David Thompson committed
862
863
864
          this->LayoutAnnotationsHorizontally(
            barX, this->TextPosition == vtkScalarBarActor::PrecedeScalarBar ? swatchC0 : swatchC1,
            barWidth, barHeight, delta, swatchPad );
865
866
        for ( i = 0; i < numNotes; ++ i )
          {
David Thompson's avatar
David Thompson committed
867
          x[0] = barX + i * delta + swatchPad;
David Thompson's avatar
David Thompson committed
868
          x[1] = swatchC0;
869
          pts->SetPoint( 4 * i, x );
David Thompson's avatar
David Thompson committed
870
          x[0] += delta - swatchPad * 2;
871
          pts->SetPoint( 4 * i + 1, x );
David Thompson's avatar
David Thompson committed
872
          x[1] = swatchC1;
873
          pts->SetPoint( 4 * i + 2, x );
David Thompson's avatar
David Thompson committed
874
          x[0] -= delta - swatchPad * 2;
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
          pts->SetPoint( 4 * i + 3, x );
          }
        }
      for ( i = 0; i < numNotes; ++ i )
        {
        ptIds[0] = 4 * i;
        ptIds[1] = ptIds[0] + 1;
        ptIds[2] = ptIds[0] + 2;
        polys->InsertNextCell( 3, ptIds );

        ptIds[1] = ptIds[2];
        ptIds[2] = ptIds[0] + 3;
        polys->InsertNextCell( 3, ptIds );

        // We could just call lkup->GetTableValue( i % lkup->GetNumberOfTableValues() ), but
        // that would draw colors even when an annotation did not have a valid conversion to/from a double...
        rgba = lkup->MapValue( lkup->GetAnnotatedValue( i ).ToDouble() );
        rgb = colors->GetPointer( /* numComponents */ 4 * /* numCells/swatch */ 2 * /* swatch */ i ); //write into array directly
        rgb[0] = rgba[0]; rgb[1] = rgba[1]; rgb[2] = rgba[2]; rgb[3] = rgba[3];
        rgb[4] = rgba[0]; rgb[5] = rgba[1]; rgb[6] = rgba[2]; rgb[7] = 255; // second triangle is always opaque
        }
      }
897
898
899
900
    this->BuildTime.Modified();
    }

  // Everything is built, just have to render
Jim Miller's avatar
Style    
Jim Miller committed
901
902
  if (this->Title != NULL)
    {
903
    renderedSomething += this->TitleActor->RenderOpaqueGeometry(viewport);
Jim Miller's avatar
Style    
Jim Miller committed
904
    }
David Thompson's avatar
David Thompson committed
905
906
907
  // Draw either the scalar bar (non-indexed mode) or the annotated value boxes (indexed mode).
  vtkLookupTable* lkup = vtkLookupTable::SafeDownCast( this->LookupTable );
  if ( ! lkup || ( lkup && ! lkup->GetIndexedLookup() ) )
Jim Miller's avatar
Style    
Jim Miller committed
908
    {
David Thompson's avatar
David Thompson committed
909
910
911
912
913
914
915
916
917
    this->ScalarBarActor->RenderOpaqueGeometry(viewport);
    for (i=0; i<this->NumberOfLabels; i++)
      {
      renderedSomething += this->TextActors[i]->RenderOpaqueGeometry(viewport);
      }
    }
  else
    {
    this->AnnotationBoxesActor->RenderOpaqueGeometry( viewport );
David Thompson's avatar
David Thompson committed
918
    if ( this->DrawAnnotations )
David Thompson's avatar
David Thompson committed
919
      {
David Thompson's avatar
David Thompson committed
920
921
922
923
924
925
      if ( this->NumberOfAnnotationLabelsBuilt )
        this->AnnotationLeadersActor->RenderOpaqueGeometry( viewport );
      for ( i = 0; i < this->NumberOfAnnotationLabelsBuilt; ++ i )
        {
        renderedSomething += this->AnnotationLabels[i]->RenderOpaqueGeometry( viewport );
        }
David Thompson's avatar
David Thompson committed
926
      }
Jim Miller's avatar
Style    
Jim Miller committed
927
    }
928
929
930
931

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

  return renderedSomething;
932
933
}

934
935
936
937
//-----------------------------------------------------------------------------
// Description:
// Does this prop have some translucent polygonal geometry?
int vtkScalarBarActor::HasTranslucentPolygonalGeometry()
David Thompson's avatar
David Thompson committed
938
939
{ // TODO: Handle case when IndexedLookup is true and any colors in the palette have an alpha value,
  // as the color swatches drawn by this->AnnotationBoxesActor have 1 translucent triangle for each alpha-swatch.
940
941
942
  return 0;
}

Sebastien Barre's avatar
Sebastien Barre committed
943
//----------------------------------------------------------------------------
944
void vtkScalarBarActor::PrintSelf(ostream& os, vtkIndent indent)
945
{
Brad King's avatar
Brad King committed
946
  this->Superclass::PrintSelf(os,indent);
947
948
949
950
951
952
953
954
955
956
957

  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
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
  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";
    }

978
  os << indent << "Title: " << (this->Title ? this->Title : "(none)") << "\n";
979
  os << indent << "ComponentTitle: " << (this->ComponentTitle ? this->ComponentTitle : "(none)") << "\n";
980
  os << indent << "Maximum Number Of Colors: "
981
982
     << this->MaximumNumberOfColors << "\n";
  os << indent << "Number Of Labels: " << this->NumberOfLabels << "\n";
983
  os << indent << "Number Of Labels Built: " << this->NumberOfLabelsBuilt << "\n";
984
985

  os << indent << "Orientation: ";
Jim Miller's avatar
Style    
Jim Miller committed
986
987
988
989
990
991
992
993
  if ( this->Orientation == VTK_ORIENT_HORIZONTAL )
    {
    os << "Horizontal\n";
    }
  else
    {
    os << "Vertical\n";
    }
994
995

  os << indent << "Label Format: " << this->LabelFormat << "\n";
996
997
998
999
  os << indent << "UseOpacity: " << this->UseOpacity << "\n";
  if (this->UseOpacity)
    {
    os << indent << "TextureGridWidth: " << this->TextureGridWidth << "\n";
Karthik Krishnan's avatar
Karthik Krishnan committed
1000
1001
    os << indent << "TextureActor:\n";
    this->TextureActor->PrintSelf(os, indent.GetNextIndent());
1002
    }
1003
1004
1005
1006
1007
1008
1009
1010
  if (this->TextPosition == vtkScalarBarActor::PrecedeScalarBar)
    {
    os << indent << "TextPosition: PrecedeScalarBar\n";
    }
  else
    {
    os << indent << "TextPosition: SucceedScalarBar\n";
    }
Karthik Krishnan's avatar
Karthik Krishnan committed
1011