scene.C 10.9 KB
Newer Older
1 2 3 4
/*---------------------------------------------------------------------------*\
  =========                 |
  \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
   \\    /   O peration     |
5
    \\  /    A nd           | Copyright (C) 2015-2018 OpenCFD Ltd.
6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42
     \\/     M anipulation  |
-------------------------------------------------------------------------------
License
    This file is part of OpenFOAM.

    OpenFOAM is free software: you can redistribute it and/or modify it
    under the terms of the GNU General Public License as published by
    the Free Software Foundation, either version 3 of the License, or
    (at your option) any later version.

    OpenFOAM is distributed in the hope that it will be useful, but WITHOUT
    ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
    FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
    for more details.

    You should have received a copy of the GNU General Public License
    along with OpenFOAM.  If not, see <http://www.gnu.org/licenses/>.

\*---------------------------------------------------------------------------*/

// OpenFOAM includes
#include "scene.H"
#include "Constant.H"

// VTK includes
#include "vtkCamera.h"
#include "vtkCubeSource.h"
#include "vtkLightKit.h"
#include "vtkPolyDataMapper.h"
#include "vtkPNGWriter.h"
#include "vtkRenderer.h"
#include "vtkRendererCollection.h"
#include "vtkRenderWindow.h"
#include "vtkWindowToImageFilter.h"

// * * * * * * * * * * * * * Private Member Functions  * * * * * * * * * * * //

43 44 45 46
void Foam::functionObjects::runTimePostPro::scene::readCamera
(
    const dictionary& dict
)
47 48 49 50 51
{
    if (dict.readIfPresent("nFrameTotal", nFrameTotal_))
    {
        if (nFrameTotal_ < 1)
        {
52 53
            FatalIOErrorInFunction(dict)
                << "nFrameTotal must be 1 or greater"
54 55 56 57
                << exit(FatalIOError);
        }
    }

58
    if (dict.readIfPresent("startPosition", startPosition_))
59
    {
60
        if ((startPosition_ < 0) || (startPosition_ > 1))
61
        {
62 63
            FatalIOErrorInFunction(dict)
                << "startPosition must be in the range 0-1"
64 65
                << exit(FatalIOError);
        }
66 67 68 69
        else
        {
            position_ = startPosition_;
        }
70 71 72 73 74 75 76
    }

    if (nFrameTotal_ > 1)
    {
        scalar endPosition = dict.lookupOrDefault<scalar>("endPosition", 1);
        if ((endPosition < 0) || (endPosition > 1))
        {
77 78
            FatalIOErrorInFunction(dict)
                << "endPosition must be in the range 0-1"
79 80
                << exit(FatalIOError);
        }
81
        dPosition_ = (endPosition - startPosition_)/scalar(nFrameTotal_ - 1);
82 83
    }

84 85 86
    cameraPosition_ = Function1<vector>::New("position", dict);
    cameraFocalPoint_ = Function1<point>::New("focalPoint", dict);
    cameraUp_ = Function1<vector>::New("up", dict);
87

88
    dict.readIfPresent("clipBox", clipBox_);
89
    dict.readEntry("parallelProjection", parallelProjection_);
90
    if (!parallelProjection_)
91
    {
92
        if (dict.found("viewAngle"))
93
        {
94
            cameraViewAngle_ = Function1<scalar>::New("viewAngle", dict);
95
        }
96
        else
97
        {
98
            cameraViewAngle_.reset
99
            (
100
                new Function1Types::Constant<scalar>("viewAngle", 35.0)
101 102 103 104
            );
        }
    }

105 106 107 108 109 110 111 112 113 114 115
    if (dict.found("zoom"))
    {
        cameraZoom_ = Function1<scalar>::New("zoom", dict);
    }
    else
    {
        cameraZoom_.reset
        (
            new Function1Types::Constant<scalar>("zoom", 1.0)
        );
    }
116 117 118
}


119 120 121 122
void Foam::functionObjects::runTimePostPro::scene::readColours
(
    const dictionary& dict
)
123
{
124 125
    const wordList colours(dict.toc());
    for (const word& c : colours)
126
    {
127
        colours_.insert(c, Function1<vector>::New(c, dict));
128 129 130 131
    }
}


132 133 134 135 136 137 138 139 140 141 142 143 144 145 146
void Foam::functionObjects::runTimePostPro::scene::setActorVisibility
(
    vtkRenderer* renderer,
    const bool visible
) const
{
    vtkActorCollection *actors = renderer->GetActors();
    for (int i = 0; i < actors->GetNumberOfItems(); ++i)
    {
        vtkActor *actor = vtkActor::SafeDownCast(actors->GetItemAsObject(i));
        actor->SetVisibility(visible);
    }
}


147 148 149 150 151
void Foam::functionObjects::runTimePostPro::scene::initialise
(
    vtkRenderer* renderer,
    const word& outputName
)
152 153
{
    currentFrameI_ = 0;
154
    position_ = startPosition_;
155 156 157 158

    outputName_ = outputName;

    // Set the background
159
    const vector backgroundColour = colours_["background"]->value(position_);
160 161 162 163 164 165 166 167 168 169 170
    renderer->SetBackground
    (
        backgroundColour.x(),
        backgroundColour.y(),
        backgroundColour.z()
    );

    // Apply gradient background if "background2" defined
    if (colours_.found("background2"))
    {
        renderer->GradientBackgroundOn();
171
        vector backgroundColour2 = colours_["background2"]->value(position_);
172 173 174 175 176 177 178 179 180 181 182 183 184 185 186

        renderer->SetBackground2
        (
            backgroundColour2.x(),
            backgroundColour2.y(),
            backgroundColour2.z()
        );
    }

    // Depth peeling
    renderer->SetUseDepthPeeling(true);
    renderer->SetMaximumNumberOfPeels(4);
    renderer->SetOcclusionRatio(0);

    // Set the camera
187
    auto camera = vtkSmartPointer<vtkCamera>::New();
188 189 190
    camera->SetParallelProjection(parallelProjection_);
    renderer->SetActiveCamera(camera);

191
    // Add the lights
192
    auto lightKit = vtkSmartPointer<vtkLightKit>::New();
193 194
    lightKit->AddLightsToRenderer(renderer);

195
    if (!clipBox_.empty())
196 197 198
    {
        const point& min = clipBox_.min();
        const point& max = clipBox_.max();
199
        auto clipBox = vtkSmartPointer<vtkCubeSource>::New();
200 201 202 203 204 205 206 207 208
        clipBox->SetXLength(max.x() - min.x());
        clipBox->SetYLength(max.y() - min.y());
        clipBox->SetZLength(max.z() - min.z());
        clipBox->SetCenter
        (
            min.x() + 0.5*(max.x() - min.x()),
            min.y() + 0.5*(max.y() - min.y()),
            min.z() + 0.5*(max.z() - min.z())
        );
209
        auto clipMapper = vtkSmartPointer<vtkPolyDataMapper>::New();
210 211
        clipMapper->SetInputConnection(clipBox->GetOutputPort());

212 213 214 215
        clipBoxActor_ = vtkSmartPointer<vtkActor>::New();
        clipBoxActor_->SetMapper(clipMapper);
        clipBoxActor_->VisibilityOff();
        renderer->AddActor(clipBoxActor_);
216 217 218 219
    }
}


220 221 222 223
void Foam::functionObjects::runTimePostPro::scene::setCamera
(
    vtkRenderer* renderer
) const
224
{
225 226 227
    vtkCamera* camera = renderer->GetActiveCamera();

    if (parallelProjection_)
228
    {
229 230
        // Restore parallel scale to allow application of zoom (later)
        camera->SetParallelScale(1);
231
    }
232
    else
233 234 235
    {
        // Restore viewAngle (it might be reset by clipping)
        camera->SetViewAngle(cameraViewAngle_->value(position_));
236
    }
237 238 239 240 241 242 243 244 245 246 247 248 249 250

    const vector up = cameraUp_->value(position_);
    const vector pos = cameraPosition_->value(position_);
    const point focalPoint = cameraFocalPoint_->value(position_);
    const scalar zoom = cameraZoom_->value(position_);

    camera->SetViewUp(up.x(), up.y(), up.z());
    camera->SetPosition(pos.x(), pos.y(), pos.z());
    camera->SetFocalPoint(focalPoint.x(), focalPoint.y(), focalPoint.z());


    // Apply clipping if required
    // Note: possible optimisation - if the camera is static, this only needs
    //       to be done once on initialisation
251
    if (!clipBox_.empty())
252
    {
253
        setActorVisibility(renderer, false);
254
        clipBoxActor_->VisibilityOn();
255 256

        // Call ResetCamera() to fit clip box in view
257
        renderer->ResetCamera();
258 259

        setActorVisibility(renderer, true);
260 261 262 263 264 265 266
        clipBoxActor_->VisibilityOff();
    }

    // Zoom applied after all other operations
    camera->Zoom(zoom);

    camera->Modified();
267 268 269
}


270 271
Foam::string
Foam::functionObjects::runTimePostPro::scene::frameIndexStr() const
272 273 274 275 276 277 278 279 280 281
{
    string str = Foam::name(currentFrameI_);
    str.insert(0, 4 - str.length(), '0');

    return str;
}


// * * * * * * * * * * * * * * * * Constructors  * * * * * * * * * * * * * * //

282 283 284 285 286
Foam::functionObjects::runTimePostPro::scene::scene
(
    const objectRegistry& obr,
    const word& name
)
287 288 289 290
:
    obr_(obr),
    name_(name),
    colours_(),
Andrew Heather's avatar
Andrew Heather committed
291 292 293 294
    cameraPosition_(nullptr),
    cameraFocalPoint_(nullptr),
    cameraUp_(nullptr),
    cameraViewAngle_(nullptr),
295
    cameraZoom_(nullptr),
296
    clipBox_(boundBox::invertedBox),
297
    clipBoxActor_(),
298 299
    parallelProjection_(true),
    nFrameTotal_(1),
300
    startPosition_(0),
301 302 303 304 305 306 307 308 309
    position_(0),
    dPosition_(0),
    currentFrameI_(0),
    outputName_("unknown")
{}


// * * * * * * * * * * * * * * * * Destructor  * * * * * * * * * * * * * * * //

310
Foam::functionObjects::runTimePostPro::scene::~scene()
311 312 313 314 315
{}


// * * * * * * * * * * * * * * * Member Functions  * * * * * * * * * * * * * //

316
const Foam::HashPtrTable<Foam::Function1<Foam::vector>, Foam::word>&
317
Foam::functionObjects::runTimePostPro::scene::colours() const
318 319 320 321 322
{
    return colours_;
}


323
Foam::label Foam::functionObjects::runTimePostPro::scene::frameIndex() const
324 325 326 327 328
{
    return currentFrameI_;
}


329
Foam::scalar Foam::functionObjects::runTimePostPro::scene::position() const
330 331 332 333 334
{
    return position_;
}


335 336 337 338
void Foam::functionObjects::runTimePostPro::scene::read
(
    const dictionary& dict
)
339 340 341 342 343 344
{
    readCamera(dict.subDict("camera"));
    readColours(dict.subDict("colours"));
}


345
bool Foam::functionObjects::runTimePostPro::scene::loop(vtkRenderer* renderer)
346 347
{
    static bool initialised = false;
348
    setCamera(renderer);
349 350 351 352 353 354 355

    if (!initialised)
    {
        initialised = true;
        return true;
    }

356 357 358 359
    // Ensure that all objects can be seen without clipping
    // Note: can only be done after all objects have been added!
    renderer->ResetCameraClippingRange();

360 361 362 363 364
    // Save image from last iteration
    saveImage(renderer->GetRenderWindow());

    currentFrameI_++;

365
    position_ = startPosition_ + currentFrameI_*dPosition_;
366

367 368 369 370 371 372
    if (currentFrameI_ < nFrameTotal_)
    {
        return true;
    }
    else
    {
373
        initialised = false;
374 375 376 377 378
        return false;
    }
}


379 380 381 382
void Foam::functionObjects::runTimePostPro::scene::saveImage
(
    vtkRenderWindow* renderWindow
) const
383 384 385 386 387 388
{
    if (!renderWindow)
    {
        return;
    }

389 390
    const Time& runTime = obr_.time();

391
    const fileName prefix
392
    (
393 394 395 396
        runTime.globalPath()
      / functionObject::outputPrefix
      / name_
      / runTime.timeName()
397
    );
398

399 400 401 402 403
    mkDir(prefix);

    renderWindow->Render();

    // Set up off-screen rendering
404
    auto windowToImageFilter = vtkSmartPointer<vtkWindowToImageFilter>::New();
405 406 407 408 409 410 411 412 413 414 415

    windowToImageFilter->SetInput(renderWindow);

    //// Add alpha channel for transparency
    // windowToImageFilter->SetInputBufferTypeToRGBA();
    windowToImageFilter->SetInputBufferTypeToRGB();

//    windowToImageFilter->ReadFrontBufferOff();
    windowToImageFilter->Update();

    // Save the image
416
    auto writer = vtkSmartPointer<vtkPNGWriter>::New();
417 418 419 420 421 422 423 424 425 426 427
    fileName fName(prefix/outputName_ + '.' + frameIndexStr() + ".png");
    writer->SetFileName(fName.c_str());
    writer->SetInputConnection(windowToImageFilter->GetOutputPort());

    Info<< "    Generating image: " << fName << endl;

    writer->Write();
}


// ************************************************************************* //