Class: Vtk::TkRenderWidget

Inherits:
TkWindow
  • Object
show all
Defined in:
lib/VTK/tk/vtkTkRenderWidget.rb

Constant Summary collapse

TkCommandNames =

A vtkTkRenderWidget for Ruby

Use GetRenderWindow to get the vtkRenderWindow.

Create with the keyword stereo=1 in order to generate a
stereo-capable window.

Create with the keyword focus_on_enter=1 to enable
focus-follows-mouse.  The default is for a click-to-focus mode.

['vtkTkRenderWidget'.freeze].freeze

Instance Method Summary collapse

Constructor Details

#initialize(master, kw = {}) ⇒ TkRenderWidget

Returns a new instance of TkRenderWidget.



51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
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
 
# File 'lib/VTK/tk/vtkTkRenderWidget.rb', line 51

def initialize( master, kw={} )
=begin
      Constructor.

      Keyword arguments:

        rw -- Use passed render window instead of creating a new one.

        stereo -- If True, generate a stereo-capable window.
        Defaults to False.

        focus_on_enter -- If True, use a focus-follows-mouse mode.
        Defaults to False where the widget will use a click-to-focus
        mode.
=end
  # load the necessary extensions into tk
  Vtk.LoadRubyTkWidgets

  _symbolkey2str(kw)

  if kw['rw']
    renderWindow = kw['rw']
  else
    renderWindow = Vtk::RenderWindow.new
  end

  if kw['stereo']
    renderWindow.StereoCapableWindowOn
    kw.delete('stereo')
  end

  # check if focus should follow mouse
  if kw['focus_on_enter']
    @FocusOnEnter = true
    kw.delete('focus_on_enter')
  else
    @FocusOnEnter = false
  end

  kw['rw'] = renderWindow.GetAddressAsString("vtkRenderWindow")
  kw['widgetname'] = 'vtkTkRenderWidget'
  super(master, kw)
  renderWindow.UnRegister(nil)

  @CurrentRenderer = nil
  @CurrentCamera = nil
  @CurrentZoom = 1.0
  @CurrentLight = nil

  @ViewportCenterX = 0
  @ViewportCenterY = 0

  @Picker = Vtk::CellPicker.new
  @PickedAssembly = nil
  @PickedProperty = Vtk::Property.new
  @PickedProperty.SetColor(1,0,0)
  @PrePickedProperty = nil

  @OldFocus = nil

  # used by the LOD actors
  @DesiredUpdateRate = 15
  @StillUpdateRate = 0.0001

  # these record the previous mouse position
  @LastX = 0
  @LastY = 0

  # private attributes
  @InExpose = false

  # create the Tk bindings
  self.BindTkRenderWidget
end

Instance Method Details

#BindTkRenderWidget ⇒ Object 



126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
 
# File 'lib/VTK/tk/vtkTkRenderWidget.rb', line 126

def BindTkRenderWidget
=begin
      Bind some default actions.
=end
  self.bind("ButtonPress"){|e,s| s||s=self; s.StartMotion(e.x,e.y) }
  self.bind("ButtonRelease"){|e,s| s||s=self; s.EndMotion(e.x,e.y) }
  self.bind("B1-Motion"){|e,s| s||s=self; s.Rotate(e.x,e.y) }
  self.bind("B2-Motion"){|e,s| s||s=self; s.Pan(e.x,e.y) }
  self.bind("B3-Motion"){|e,s| s||s=self; s.Zoom(e.x,e.y) }
  self.bind("Shift-B1-Motion"){|e,s| s||s=self; s.Pan(e.x,e.y) }
  self.bind("KeyPress-r"){|e,s| s||s=self; s.Reset(e.x,e.y) }
  self.bind("KeyPress-u"){|e,s| s||s=self; s.deiconify }
  self.bind("KeyPress-w"){|e,s| s||s=self; s.Wireframe }
  self.bind("KeyPress-s"){|e,s| s||s=self; s.Surface }
  self.bind("KeyPress-p"){|e,s| s||s=self; s.PickActor(e.x,e.y) }
  if @FocusOnEnter
    self.bind("Enter"){|e,s| s||s=self; s.Enter(e.x,e.y) }
    self.bind("Leave"){|e,s| s||s=self; s.Leave(e.x,e.y) }
  else
    self.bind("ButtonPress"){|e,s| s||s=self; s.Enter(e.x,e.y) }
    self.bind("Expose"){|e,s| s||s=self; s.Expose }
  end
end

#EndMotion(x, y) ⇒ Object 



277
278
279
280
281
282
 
# File 'lib/VTK/tk/vtkTkRenderWidget.rb', line 277

def EndMotion(x,y)
  self.GetRenderWindow.SetDesiredUpdateRate(@StillUpdateRate)
  if @CurrentRenderer
    self.Render
  end
end

#Enter(x, y) ⇒ Object 



260
261
262
263
264
 
# File 'lib/VTK/tk/vtkTkRenderWidget.rb', line 260

def Enter(x,y)
  @OldFocus = self.focus
  self.focus
  self.StartMotion(x, y)
end

#Expose ⇒ Object 



197
198
199
200
201
202
203
204
 
# File 'lib/VTK/tk/vtkTkRenderWidget.rb', line 197

def Expose
  if ! @InExpose
    @InExpose = true
    self.update
    self.GetRenderWindow.Render
    @InExpose = false
  end
end

#GetCurrentRenderer ⇒ Object 



256
257
258
 
# File 'lib/VTK/tk/vtkTkRenderWidget.rb', line 256

def GetCurrentRenderer
  return @CurrentRenderer
end

#GetDesiredUpdateRate ⇒ Object 



162
163
164
165
166
167
168
 
# File 'lib/VTK/tk/vtkTkRenderWidget.rb', line 162

def GetDesiredUpdateRate
=begin
      Mirrors the method with the same name in
      vtkRenderWindowInteractor.
=end
  return @DesiredUpdateRate 
end

#GetPicker ⇒ Object 



193
194
195
 
# File 'lib/VTK/tk/vtkTkRenderWidget.rb', line 193

def GetPicker
  return @Picker
end

#GetRenderWindow ⇒ Object 



186
187
188
189
190
191
 
# File 'lib/VTK/tk/vtkTkRenderWidget.rb', line 186

def GetRenderWindow
  addr = Tk.tk_call(self, 'GetRenderWindow')[5..-1]
  renderWindow = Vtk::RenderWindow.new('_%s_vtkRenderWindow_p' % addr)
  renderWindow.UnRegister(nil)
  return renderWindow
end

#GetStillUpdateRate ⇒ Object 



178
179
180
181
182
183
184
 
# File 'lib/VTK/tk/vtkTkRenderWidget.rb', line 178

def GetStillUpdateRate
=begin
     Mirrors the method with the same name in
      vtkRenderWindowInteractor.
=end
  return @StillUpdateRate 
end

#GetZoomFactor ⇒ Object 



150
151
152
 
# File 'lib/VTK/tk/vtkTkRenderWidget.rb', line 150

def GetZoomFactor
  return @CurrentZoom
end

#Leave(x, y) ⇒ Object 



266
267
268
269
270
 
# File 'lib/VTK/tk/vtkTkRenderWidget.rb', line 266

def Leave(x,y)
  if (@OldFocus != nil)
    @OldFocus.focus
  end
end

#Pan(x, y) ⇒ Object 



299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
 
# File 'lib/VTK/tk/vtkTkRenderWidget.rb', line 299

def Pan(x,y)
  if @CurrentRenderer

    renderer = @CurrentRenderer
    camera = @CurrentCamera
    pPoint0,pPoint1,pPoint2 = camera.GetPosition
    fPoint0,fPoint1,fPoint2 = camera.GetFocalPoint

    if (camera.GetParallelProjection)
      renderer.SetWorldPoint(fPoint0,fPoint1,fPoint2,1.0)
      renderer.WorldToDisplay
      fx,fy,fz = renderer.GetDisplayPoint
      renderer.SetDisplayPoint(fx-x+@LastX,
                               fy+y-@LastY,
                               fz)
      renderer.DisplayToWorld
      fx,fy,fz,fw = renderer.GetWorldPoint
      camera.SetFocalPoint(fx,fy,fz)

      renderer.SetWorldPoint(pPoint0,pPoint1,pPoint2,1.0)
      renderer.WorldToDisplay
      fx,fy,fz = renderer.GetDisplayPoint
      renderer.SetDisplayPoint(fx-x+@LastX,
                               fy+y-@LastY,
                               fz)
      renderer.DisplayToWorld
      fx,fy,fz,fw = renderer.GetWorldPoint
      camera.SetPosition(fx,fy,fz)

    else
      (fPoint0,fPoint1,fPoint2) = camera.GetFocalPoint
      # Specify a point location in world coordinates
      renderer.SetWorldPoint(fPoint0,fPoint1,fPoint2,1.0)
      renderer.WorldToDisplay
      # Convert world point coordinates to display coordinates
      dPoint = renderer.GetDisplayPoint
      focalDepth = dPoint[2]

      aPoint0 = @ViewportCenterX + (x - @LastX)
      aPoint1 = @ViewportCenterY - (y - @LastY)

      renderer.SetDisplayPoint(aPoint0,aPoint1,focalDepth)
      renderer.DisplayToWorld

      (rPoint0,rPoint1,rPoint2,rPoint3) = renderer.GetWorldPoint
      if (rPoint3 != 0.0)
        rPoint0 = rPoint0/rPoint3
        rPoint1 = rPoint1/rPoint3
        rPoint2 = rPoint2/rPoint3
      end

      camera.SetFocalPoint((fPoint0 - rPoint0) + fPoint0, 
                           (fPoint1 - rPoint1) + fPoint1,
                           (fPoint2 - rPoint2) + fPoint2) 

      camera.SetPosition((fPoint0 - rPoint0) + pPoint0, 
                         (fPoint1 - rPoint1) + pPoint1,
                         (fPoint2 - rPoint2) + pPoint2)
    end

    @LastX = x
    @LastY = y

    self.Render
  end
end

#PickActor(x, y) ⇒ Object 



422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
 
# File 'lib/VTK/tk/vtkTkRenderWidget.rb', line 422

def PickActor(x,y)
  if @CurrentRenderer

    renderer = @CurrentRenderer
    picker = @Picker
    windowY = self.winfo_height
    picker.Pick(x,(windowY - y - 1),0.0,renderer)
    assembly = picker.GetAssembly

    if (@PickedAssembly != nil && @PrePickedProperty != nil)
      @PickedAssembly.SetProperty(@PrePickedProperty)
      # release hold of the property
      @PrePickedProperty.UnRegister(@PrePickedProperty)
      @PrePickedProperty = nil
    end

    if (assembly != nil)
      @PickedAssembly = assembly
      @PrePickedProperty = @PickedAssembly.GetProperty
      # hold onto the property
      @PrePickedProperty.Register(@PrePickedProperty)
      @PickedAssembly.SetProperty(@PickedProperty)
    end

    self.Render
  end
end

#Render ⇒ Object 



206
207
208
209
210
211
212
213
214
 
# File 'lib/VTK/tk/vtkTkRenderWidget.rb', line 206

def Render
  if (@CurrentLight)
    light = @CurrentLight
    light.SetPosition(@CurrentCamera.GetPosition)
    light.SetFocalPoint(@CurrentCamera.GetFocalPoint)
  end

  self.GetRenderWindow.Render
end

#Reset(x, y) ⇒ Object 



390
391
392
393
394
395
396
 
# File 'lib/VTK/tk/vtkTkRenderWidget.rb', line 390

def Reset(x,y)
  if @CurrentRenderer
    @CurrentRenderer.ResetCamera
  end

  self.Render
end

#Rotate(x, y) ⇒ Object 



284
285
286
287
288
289
290
291
292
293
294
295
296
297
 
# File 'lib/VTK/tk/vtkTkRenderWidget.rb', line 284

def Rotate(x,y)
  if @CurrentRenderer

    @CurrentCamera.Azimuth(@LastX - x)
    @CurrentCamera.Elevation(y - @LastY)
    @CurrentCamera.OrthogonalizeViewUp

    @LastX = x
    @LastY = y

    @CurrentRenderer.ResetCameraClippingRange
    self.Render
  end
end

#SetDesiredUpdateRate(rate) ⇒ Object 



154
155
156
157
158
159
160
 
# File 'lib/VTK/tk/vtkTkRenderWidget.rb', line 154

def SetDesiredUpdateRate(rate)
=begin
      Mirrors the method with the same name in
      vtkRenderWindowInteractor.
=end
  @DesiredUpdateRate = rate
end

#SetStillUpdateRate(rate) ⇒ Object 



170
171
172
173
174
175
176
 
# File 'lib/VTK/tk/vtkTkRenderWidget.rb', line 170

def SetStillUpdateRate(rate)
=begin
      Mirrors the method with the same name in
      vtkRenderWindowInteractor.
=end
  @StillUpdateRate = rate
end

#StartMotion(x, y) ⇒ Object 



272
273
274
275
 
# File 'lib/VTK/tk/vtkTkRenderWidget.rb', line 272

def StartMotion(x,y)
  self.GetRenderWindow.SetDesiredUpdateRate(@DesiredUpdateRate)
  self.UpdateRenderer(x,y)
end

#Surface ⇒ Object 



410
411
412
413
414
415
416
417
418
419
420
 
# File 'lib/VTK/tk/vtkTkRenderWidget.rb', line 410

def Surface
  actors = @CurrentRenderer.GetActors
  numActors = actors.GetNumberOfItems
  actors.InitTraversal
  for i in 0...numActors
    actor = actors.GetNextItem
    actor.GetProperty.SetRepresentationToSurface
  end

  self.Render
end

#UpdateRenderer(x, y) ⇒ Object 



216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
 
# File 'lib/VTK/tk/vtkTkRenderWidget.rb', line 216

def UpdateRenderer(x,y)
=begin
      UpdateRenderer will identify the renderer under the mouse && set
      up _CurrentRenderer, _CurrentCamera, && _CurrentLight.
=end
  windowX = self.winfo_width
  windowY = self.winfo_height

  renderers = self.GetRenderWindow.GetRenderers
  numRenderers = renderers.GetNumberOfItems

  @CurrentRenderer = nil
  renderers.InitTraversal
  for i in 0...numRenderers
    renderer = renderers.GetNextItem
    vx,vy = [0,0]
    if (windowX > 1)
      vx = x.to_f/(windowX-1)
    end
    if (windowY > 1)
      vy = (windowY-y.to_f-1)/(windowY-1)
    end
    vpxmin,vpymin,vpxmax,vpymax = renderer.GetViewport

    if (vx >= vpxmin && vx <= vpxmax && vy >= vpymin && vy <= vpymax)
      @CurrentRenderer = renderer
      @ViewportCenterX = windowX.to_f*(vpxmax-vpxmin)/2.0 +vpxmin
      @ViewportCenterY = windowY.to_f*(vpymax-vpymin)/2.0 +vpymin
      @CurrentCamera = @CurrentRenderer.GetActiveCamera
      lights = @CurrentRenderer.GetLights
      lights.InitTraversal
      @CurrentLight = lights.GetNextItem
      break
    end
  end

  @LastX = x
  @LastY = y
end

#Wireframe ⇒ Object 



398
399
400
401
402
403
404
405
406
407
408
 
# File 'lib/VTK/tk/vtkTkRenderWidget.rb', line 398

def Wireframe
  actors = @CurrentRenderer.GetActors
  numActors = actors.GetNumberOfItems
  actors.InitTraversal
  for i in 0...numActors
    actor = actors.GetNextItem
    actor.GetProperty.SetRepresentationToWireframe
  end

  self.Render
end

#Zoom(x, y) ⇒ Object 



366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
 
# File 'lib/VTK/tk/vtkTkRenderWidget.rb', line 366

def Zoom(x,y)
  if @CurrentRenderer

    renderer = @CurrentRenderer
    camera = @CurrentCamera

    zoomFactor = 1.02**(0.5*(@LastY - y))
    @CurrentZoom = @CurrentZoom * zoomFactor

    if camera.GetParallelProjection != 0
      parallelScale = camera.GetParallelScale/zoomFactor
      camera.SetParallelScale(parallelScale)
    else
      camera.Dolly(zoomFactor)
      renderer.ResetCameraClippingRange
    end

    @LastX = x
    @LastY = y

    self.Render
  end
end