Hide menu
visualization/offscreen/main.cxx

Refer to the Offscreen Rendering Example.

// ****************************************************************************
// $Id$
//
// Copyright (C) 2008-2014, Roman Lygin. All rights reserved.
// Copyright (C) 2014-2022, CADEX. All rights reserved.
//
// This file is part of the CAD Exchanger software.
//
// You may use this file under the terms of the BSD license as follows:
//
// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions are met:
// * Redistributions of source code must retain the above copyright notice,
// this list of conditions and the following disclaimer.
// * Redistributions in binary form must reproduce the above copyright notice,
// this list of conditions and the following disclaimer in the documentation
// and/or other materials provided with the distribution.
//
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
// AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
// IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
// ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
// LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
// CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
// SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
// INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
// CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
// ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
// POSSIBILITY OF SUCH DAMAGE.
//
// ****************************************************************************
#define __CADEX_PREVIEW_VISUALIZATION 1
#include <cadex/Base_Exception.hxx>
#include <cadex/Base_Settings.hxx>
#include <cadex/Base_String.hxx>
#include <cadex/LicenseManager_Activate.h>
#include <cadex/ModelData_ModelReader.hxx>
#include <cadex/ModelData_RepresentationSelector.hxx>
#include <cadex/ModelPrs_BackgroundStyle.hxx>
#include <cadex/ModelPrs_OffscreenViewPort.hxx>
#include <cadex/ModelPrs_Scene.hxx>
#include <cadex/ModelPrs_SceneNode.hxx>
#include <cadex/ModelPrs_SceneNodeFactory.hxx>
#include <cadex/ModelPrs_SceneNodeFactoryParameters.hxx>
#include <cadex/STEP_ReaderParameters.hxx>
#include <iostream>
#include "../../cadex_license.cxx"
using namespace std;
using namespace cadex;
int main (int argc, char *argv[])
{
auto aKey = LicenseKey::Value();
// Activate the license (aKey must be defined in cadex_license.cxx)
if (!CADExLicense_Activate (aKey)) {
cerr << "Failed to activate CAD Exchanger license." << endl;
return 1;
}
if (argc != 3) {
cerr << "Usage: " << argv[0] << " <input_file> <output_file>, where:" << endl;
cerr << " <input_file> is a name of the STEP file to be read" << endl;
cerr << " <output_file> is a name of the PNG file to be write" << endl;
return 1;
}
const char* aSource = argv[1];
const char* aDest = argv[2];
STEP_ReaderParameters aReaderParams;
// Let's set new parameters
aReaderParams.PreferredBRepRepresentationType() = STEP_ReaderParameters::AdvancedBRep;
aReader.SetReaderParameters (aReaderParams);
// Opening and converting the file
if (!aReader.Read (aSource, aModel)) {
cerr << "Failed to open and convert the file " << aSource << endl;
return 1;
}
// Use exceptions to get human-readable errors on fail
Base_Settings::Default()->SetValue (Base_Settings::UseExceptions, true);
try {
// Convert model into visualisation entities
auto aRootNode = aFactory.CreateGraph (aModel, ModelData_RM_Any);
// Create scene and display all entities
aScene.AddRoot (aRootNode);
// Setup offscreen viewport with transparent background and perspective camera
aViewPort.Resize (800, 600);
ModelData_Color aBackgroundColor (0x00000000);
ModelPrs_BackgroundStyle aStyle (aBackgroundColor);
aViewPort.SetBackgroundStyle (aStyle);
// Attach viewport to the scene.
if (!aViewPort.AttachToScene (aScene)) {
cerr << "Unable to attach viewport to scene" << endl;
return 1;
}
// Apply scene changes to viewport and wait until all async operations will be finished
aScene.Update();
aScene.Wait();
// Fit and center model on the image
aViewPort.FitAll();
// Grab rendered frame into image
if (!aViewPort.GrabToImage (aDest)) {
cerr << "Failed to write the file " << aDest << endl;
return 1;
}
} catch (const Base_Exception& theEx) {
cerr << theEx.What() << endl;
return 1;
}
return 0;
}
Perspective.
Definition: ModelPrs_CameraProjectionType.hxx:27
Provides CAD Exchanger visualization structure.
Definition: ModelPrs_Scene.hxx:38
Alias to ModelPrs_CameraPositionType::ModelPrs_CMT_XposYnegZpos.
Definition: ModelPrs_CameraPositionType.hxx:59
Defines an RGBA color (with alpha channel).
Definition: ModelData_Color.hxx:33
void FitAll()
Fit content to ViewPort size.
Definition: ModelPrs_OffscreenViewPort.cxx:290
void Resize(unsigned int theWidth, unsigned int theHeight)
Resizes ViewPort.
Definition: ModelPrs_OffscreenViewPort.cxx:254
Provides CAD Exchanger data model.
Definition: ModelData_Model.hxx:40
Defines background style.
Definition: ModelPrs_BackgroundStyle.hxx:31
Abstract base class for exceptions thrown from CAD Exchanger.
Definition: Base_Exception.hxx:33
const Base_UTF16String & What() const
Returns a message associated to the exception.
Definition: Base_Exception.cxx:47
Reads any format that CAD Exchanger can import.
Definition: ModelData_ModelReader.hxx:31
void SetDisplayMode(ModelPrs_DisplayMode theMode)
Sets theMode as display mode.
Definition: ModelPrs_SceneNode.cxx:879
bool Read(const Base_UTF16String &theFilePath, ModelData_Model &theModel)
Reads the file at the specified path into the specified model.
Definition: ModelData_ModelReader.cxx:120
void SetBackgroundStyle(const ModelPrs_BackgroundStyle &theStyle)
Sets a background style.
Definition: ModelPrs_OffscreenViewPort.cxx:316
Defines a viewport without any visible window (frame).
Definition: ModelPrs_OffscreenViewPort.hxx:48
void Wait()
Waiting until all changes are applied by Update method.
Definition: ModelPrs_Scene.cxx:207
Shaded with boundaries display mode.
Definition: ModelPrs_DisplayMode.hxx:32
void AddRoot(ModelPrs_SceneNode &theNode)
Adds a root scene node.
Definition: ModelPrs_Scene.cxx:138
void SetCameraProjectionType(ModelPrs_CameraProjectionType theType)
Sets a camera projection type.
Definition: ModelPrs_OffscreenViewPort.cxx:368
Defines classes, types, and global functions related to CAD Exchanger.
Definition: A3DSTestLib.hxx:22
Defines classes, types, and global functions related to standard C++ library.
Defines parameters of the STEP_Reader.
Definition: STEP_ReaderParameters.hxx:26
bool AttachToScene(const ModelPrs_Scene &theScene)
Attaches to ModelPrs_Scene.
Definition: ModelPrs_OffscreenViewPort.cxx:247
Creates a scene nodes and its children from input data model objects.
Definition: ModelPrs_SceneNodeFactory.hxx:47
void SetReaderParameters(const Base_ReaderParameters &theParameters)
Sets reader parameters.
Definition: ModelData_ModelReader.cxx:132
bool GrabToImage(const Base_UTF16String &thePath) const
Grab to image in specified thePath.
Definition: ModelPrs_OffscreenViewPort.cxx:275
void Update(const Base_ProgressStatus &theProgressStatus=Base_ProgressStatus())
Applies changes of attached Scene Nodes.
Definition: ModelPrs_Scene.cxx:188
ModelPrs_SceneNode CreateGraph(const ModelData_Model &theModel, ModelData_RepresentationMask theRepresentationMask)
Creates scene graph using ModelData_Model.
Definition: ModelPrs_SceneNodeFactory.cxx:576
BRepRepresentationType PreferredBRepRepresentationType() const
Returns the preferred type of B-Rep shape representation.
Definition: STEP_ReaderParameters.cxx:77
void SetCameraPositionType(ModelPrs_CameraPositionType theOrientation)
Sets a camera position type.
Definition: ModelPrs_OffscreenViewPort.cxx:374