mirror of
https://git.dev.opencascade.org/repos/occt.git
synced 2025-04-04 18:06:22 +03:00
0027218: Add information about porting from earlier versions in update guide
Added: - porting notes for earlier versions starting with 6.5; - section about zoom persistent selection
This commit is contained in:
ysn
abv
parent
72c3745808
commit
1454243292
@ -24,8 +24,301 @@ The automatic upgrade tool is provided as is, without warranty of any kind, and
|
||||
It is your responsibility to ensure that the changes you made in your code are correct.
|
||||
When you upgrade the code by an automatic script, make sure to carefully review the introduced changes at each step before committing them.
|
||||
|
||||
|
||||
@section upgrade_65 Upgrade to OCCT 6.5.0
|
||||
|
||||
Porting of user applications from an earlier OCCT version to version 6.5 requires taking into account the following major changes:
|
||||
* If you are not comfortable with dependence on Intel TBB, FreeImage, or Gl2Ps libraries, you will need to (re)build OCCT with these dependencies disabled.
|
||||
* The low-level format version of OCAF binary and XML persistence has been incremented. Hence, the files saved by OCCT 6.5 to OCAF binary or XML format will not be readable by previous versions of OCCT.
|
||||
* The *BRepMesh* triangulation algorithm has been seriously revised and now tries hard to fulfill the requested deflection and angular tolerance parameters. If you experience any problems with performance or triangulation quality (in particular, display of shapes in shading mode), consider revising the values of these parameters used in your application.
|
||||
* If you were using method *ToPixMap()* of class *V3d_View* to get a buffer for passing to Windows API functions (e.g. *BitBlt*), this will not work anymore. You will need to use method *Image_PixMap::AccessBuffer()* to get the raw buffer data that can be further passed to WinAPI functions.
|
||||
* As the processing of message gravity parameter in *Message* package has been improved, some application messages (especially the ones generated by IGES or STEP translators) can be suppressed or new messages appear in the application. Use relevant message level parameter to tune this behavior.
|
||||
|
||||
@section upgrade_651 Upgrade to OCCT 6.5.1
|
||||
|
||||
Porting of user applications from an earlier OCCT version to version 6.5.1 requires taking into account the following major changes:
|
||||
|
||||
* Method *Graphic3d_Structure::Groups()* now returns *Graphic3d_SequenceOfGroup*. If this method has been used, the application code should be updated to iterate another collection type or, if *Graphic3d_HSetOfGroup* is required, to fill its own collection:
|
||||
~~~~
|
||||
const Graphic3d_SequenceOfGroup& aGroupsSeq = theStructure.Groups();
|
||||
Handle(Graphic3d_HSetOfGroup) aGroupSet = new Graphic3d_HSetOfGroup();
|
||||
Standard_Integer aLen = aGroupsSeq.Length();
|
||||
for (Standard_Integer aGr = 1; aGr <= aLen; ++aGr)
|
||||
{
|
||||
aGroupSet->Add (aGroupsSeq.Value (aGr));
|
||||
}
|
||||
~~~~
|
||||
|
||||
* All occurrences of *Select3D_Projector* in the application code (if any) should be replaced with *Handle(Select3D_Projector)*.
|
||||
* The code of inheritors of *Select3D_SensitiveEntity* should be updated if they override <i>::Matches()</i> (this is probable, if clipping planes are used).
|
||||
* Constructor for *V3d_Plane* has been changed, so the extra argument should be removed if used in the application. It is necessary to add a new plane using method *V3d_Viewer::AddPlane()* if *V3d_Viewer* has been used to manage clipping planes list (this does not affect clipping planes representation). Please, have a look at the source code for new DRAWEXE *vclipplane* command in *ViewerTest_ObjectsCommands.cxx, VClipPlane* to see how clipping planes can be managed in the application.
|
||||
|
||||
@section upgrade_652 Upgrade to OCCT 6.5.2
|
||||
|
||||
Porting of user applications from an earlier OCCT version to version 6.5.2 requires taking into account the following major changes:
|
||||
* Any code that has been generated by WOK from CDL generic classes *Tcollection_DataMap* and *Tcollection_IndexedDataMap* needs to be regenerated by WOK to take into account the change in the interface of these classes.
|
||||
* The enumerations *CDF_StoreStatus* and *CDF_RetrievableStatus* have been replaced by the enumerations *PCDM_StoreStatus* and *PCDM_ReaderStatus*. Correspondingly, the methods *Open, Save* and *SaveAs* of the class *TDocStd_Application* have changed their return value. Any code, which uses these enumerations, needs to be updated.
|
||||
* *BRepLib_MakeFace* has been modified to accept tolerance value for resolution of degenerated edges. This tolerance parameter has no default value to ensure that the client code takes care of passing a meaningful value, not just *Precision::Confusion*, so some porting overheads are expected.
|
||||
* If the callback mechanism in call_togl_redraw function was used in the application code, it is necessary to revise it to take into account the new callback execution and provide a check of reason value of Aspect_GraphicCallbackStruct in callback methods to confirm that the callback code is executed at the right moment. Now the callbacks are executed before redrawing the underlayer, before redrawing the overlayer and at the end of redrawing. The information about the moment when the callback is invoked is provided with the reason value in form of an additional bit flag <i>(OCC_PRE_REDRAW, OCC_PRE_OVERLAY)</i>. The state of OpenGl changed in callback methods will not be restored automatically, which might lead to unwanted behavior in redrawing procedure.
|
||||
* The print method used in the application code might need to be revised to take into account the ability to choose between print algorithms: tile and stretch. The stretch algorithm will be selected by default during porting.
|
||||
* It is recommended to *BRepMesh_DiscretFactory* users, to check *BRepMesh_DiscretFactory::SetDefault()* return value to determine plugin availability / validity. *BRepMesh_DiscretFactory::Discret()* method now returns handle instead of pointer. The code should be updated in the following manner:
|
||||
~~~~
|
||||
Handle(BRepMesh_DiscretRoot) aMeshAlgo = BRepMesh_DiscretFactory::Get().Discret (theShape, theDeflection, theAngularToler);
|
||||
if (!aMeshAlgo.IsNull()) {}
|
||||
~~~~
|
||||
|
||||
* The default state of *BRepMesh* parallelization has been turned off. The user should switch this flag explicitly:
|
||||
* by using methods *BRepMesh_IncrementalMesh::SetParallel(Standard_True)* for each *BRepMesh_IncrementalMesh* instance before <i>::Preform()</i>;
|
||||
* by calling *BRepMesh_IncrementalMesh::SetParallelDefault(Standard_True)* when *BRepMesh_DiscretFactory* is used to retrieve the meshing tool (this also affects auto-triangulation in *AIS*).
|
||||
|
||||
@section upgrade_653 Upgrade to OCCT 6.5.3
|
||||
|
||||
Porting of user applications from an earlier OCCT version to version 6.5.3 requires taking into account the following major changes:
|
||||
* As a result of code clean-up and redesign of *TKOpenGl* driver, some obsolete functions and rendering primitives <i>(TriangleMesh, TriangleSet, Bezier, Polyline, Polygon, PolygonHoles, QuadrangleMesh</i> and *QuadrangleSet*) have been removed. Instead, the application developers should use primitive arrays that provide the same functionality but are hardware-accelerated. The details can be found in OCCT Visualization User's Guide, “Primitive Arrays” chapter.
|
||||
* Applications should not call *AIS_InteractiveObject::SetPolygonOffsets()* method for an instance of *AIS_TexturedShape* class after it has been added to *AIS_InteractiveContext*. More generally, modification of *Graphic3d_AspectFillArea3d* parameters for the computed groups of any *AIS_InteractiveObject* subclass that uses texture mapping should be avoided, because this results in broken texture mapping (see issue 23118). It is still possible to apply non-default polygon offsets to *AIS_TexturedShape* by calling *SetPolygonOffsets()* before displaying the shape.
|
||||
* The applications that might have used internal functions provided by *TKOpenGl* or removed primitives will need to be updated.
|
||||
* In connection with the implementation of Z-layers it might be necessary to revise the application code or revise the custom direct descendant classes of *Graphic3d_GraphicDriver* and *Graphic3d_StructureManager* to use the Z-layer feature.
|
||||
* Global variables *Standard_PI* and *PI* have been eliminated (use macro *M_PI* instead).
|
||||
* Method *HashCode()* has been removed from class *Standard_Transient*. It is advisable to use global function <i>::HashCode()</i> for Handle objects instead.
|
||||
* Declaration of operators new/delete for classes has become consistent and is encapsulated in macros.
|
||||
* Memory management has been changed to use standard heap <i>(MMGT_OPT=0)</i> and reentrant mode <i>(MMGT_REENTRANT=1)</i> by default.
|
||||
* Map classes in *NCollection* package now accept one more argument defining a hash tool.
|
||||
|
||||
@section upgrade_654 Upgrade to OCCT 6.5.4
|
||||
|
||||
Porting of user applications from an earlier OCCT version to version 6.5.4 requires taking into account the following major changes:
|
||||
* The code using obsolete classes *Aspect_PixMap, Xw_PixMap* and *WNT_PixMap* should be rewritten implementing class *Image_PixMap*, which is now retrieved by *ToPixMap* methods as argument. A sample code using *ToPixMap* is given below:
|
||||
~~~~
|
||||
#include <Image_AlienPixMap.hxx>
|
||||
void dump (Handle(V3d_View)& theView3D)
|
||||
{
|
||||
Standard_Integer aWndSizeX = 0;
|
||||
Standard_Integer aWndSizeY = 0;
|
||||
theView3D->Window()->Size (aWndSizeX, aWndSizeY);
|
||||
Image_AlienPixMap aPixMap;
|
||||
theView3D->ToPixMap (aPixMap, aWndSizeX, aWndSizeY);
|
||||
aPixMap.Save ("c:\\image.png");
|
||||
}
|
||||
~~~~
|
||||
* Now OpenGL resources related to Interactive Objects are automatically freed when the last view (window) is removed from graphical driver.
|
||||
To avoid presentation data loss, the application should replace an old view with a new one in the proper order: first the new view is created and activated and only then the old one is detached and removed.
|
||||
* It is recommended to use *NCollection* containers with hasher parameter (introduced in 6.5.3) instead of global definition <i>IsEqual()/HashCode()</i> as well as to use explicit namespaces to avoid name collision.
|
||||
|
||||
|
||||
@section upgrade_660 Upgrade to OCCT 6.6.0
|
||||
|
||||
Porting of user applications from an earlier OCCT version to version 6.6.0 requires taking into account the following major changes:
|
||||
* Due to the changes in the implementation of Boolean Operations, the order of sub-shapes resulting from the same operation performed with OCCT 6.5.x and OCCT 6.6.0 can be different.
|
||||
It is necessary to introduce the corresponding changes in the applications for which the order of sub-shapes resulting from a Boolean operation is important. It is strongly recommended to use identification methods not relying on the order of sub-shapes (e.g. OCAF naming).
|
||||
* If you need to use OCCT on Mac OS X with X11 (without Cocoa), build OCCT with defined pre-processor macro *CSF_MAC_USE_GLX11*. XLib front-end (previously the only way for unofficial OCCT builds on Mac OS X) is now disabled by default on this platform. If your application has no support for Cocoa framework you may build OCCT with XLib front-end adding *MACOSX_USE_GLX* macro to compiler options (you may check the appropriate option in WOK configuration GUI and in CMake configuration). Notice that XQuartz (XLib implementation for Mac OS X) now is an optional component and does not provide a sufficient level of integrity with native (Cocoa-based) applications in the system. It is not possible to build OCCT with both XLib and Cocoa at the same time due to symbols conflict in OpenGL functions.
|
||||
* Animation mode and degeneration presentation mode (simplified presentation for animation) and associated methods have been removed from 3D viewer functionality.
|
||||
Correspondingly, the code using methods *SetAnimationModeOn(), SetAnimationModeOff(), AnimationModeIsOn(), AnimationMode(), Tumble(), SetDegenerateModeOn(), SetDegenerateModeOff()* and *DegenerateModeIsOn()* of classes *V3d_View* and *Visual3d_View* will need to be removed or redesigned. Please, notice that Hidden Line Removal presentation was not affected; however, the old code that used methods *V3d_View::SetDegenerateModeOn* or *V3d_View::SetDegenerateModeOff* to control HLR presentation should be updated to use *V3d_View::SetComputedMode* method instead.
|
||||
* Calls of *Graphic3d_Group::BeginPrimitives()* and *Graphic3d_Group::EndPrimitives()* should be removed from the application code.
|
||||
* Application functionality for drawing 2D graphics that was formerly based on *TKV2d* API should be migrated to *TKV3d* API. The following changes are recommended for this migration:
|
||||
* A 2D view can be implemented as a *V3d_View* instance belonging to *V3d_Viewer* managed by *AIS_InteractiveContext* instance. To turn *V3d_View* into a 2D view, the necessary view orientation should be set up at the view initialization stage using *V3d_View::SetProj()* method, and view rotation methods simply should not be called.
|
||||
* Any 2D graphic entity (formerly represented with *AIS2D_InteractiveObject*) should become a class derived from *AIS_InteractiveObject* base. These entities should be manipulated in a view using *AIS_InteractiveContext* class API.
|
||||
* All drawing code should be put into *Compute()* virtual method of a custom interactive object class and use API of *Graphic3d* package. In particular, all geometry should be drawn using class hierarchy derived from *Graphic3d_ArrayOfPrimitives*. Normally, the Z coordinate for 2D geometry should be constant, unless the application implements some advanced 2D drawing techniques like e.g. multiple "Z layers" of drawings.
|
||||
* Interactive selection of 2D presentations should be set up inside *ComputeSelection()* virtual method of a custom interactive object class, using standard sensitive entities from *Select3D* package and standard or custom entity owners derived from *SelectMgr_EntityOwner* base.
|
||||
Please refer to the Visualization User's Guide for further details concerning OCCT 3D visualization and selection classes. See also *Viewer2D* OCCT sample application, which shows how 2D drawing can be implemented using TKV3d API.
|
||||
* Run-time graphic driver library loading mechanism based on *CSF_GraphicShr* environment variable usage has been replaced by explicit linking against *TKOpenGl* library. The code sample below shows how the graphic driver should be created and initialized in the application code:
|
||||
~~~~
|
||||
// initialize a new viewer with OpenGl graphic driver
|
||||
Handle(Graphic3d_GraphicDriver) aGraphicDriver =
|
||||
new OpenGl_GraphicDriver ("TKOpenGl");
|
||||
aGraphicDriver->Begin (new Aspect_DisplayConnection());
|
||||
TCollection_ExtendedString aNameOfViewer ("Visu3D");
|
||||
Handle(V3d_Viewer) aViewer
|
||||
= new V3d_Viewer (aGraphicDriver, aNameOfViewer.ToExtString());
|
||||
aViewer->Init();
|
||||
|
||||
// create a new window or a wrapper over the existing window,
|
||||
// provided by a 3rd-party framework (Qt, MFC, C# or Cocoa)
|
||||
#if defined(_WIN32) || defined(__WIN32__)
|
||||
Aspect_Handle aWindowHandle = (Aspect_Handle )winId();
|
||||
Handle(WNT_Window) aWindow = new WNT_Window (winId());
|
||||
#elif defined(__APPLE__) && !defined(MACOSX_USE_GLX)
|
||||
NSView* aViewHandle = (NSView* )winId();
|
||||
Handle(Cocoa_Window) aWindow = new Cocoa_Window (aViewHandle);
|
||||
#else
|
||||
Aspect_Handle aWindowHandle = (Aspect_Handle )winId();
|
||||
Handle(Xw_Window) aWindow =
|
||||
new Xw_Window (aGraphicDriver->GetDisplayConnection(), aWindowHandle);
|
||||
#endif // WNT
|
||||
|
||||
// setup the window for a new view
|
||||
Handle(V3d_View) aView = aViewer->CreateView();
|
||||
aView->SetWindow (aWindow);
|
||||
~~~~
|
||||
|
||||
* The following changes should be made in the application-specific implementations of texture aspect:
|
||||
* *Graphic3d_TextureRoot* inheritors now should return texture image by overloading of *Graphic3d_TextureRoot::GetImage()* method instead of the old logic.
|
||||
* Now you can decide if the application should store the image copy as a field of property or reload it dynamically each time (to optimize the memory usage). The default implementation (which loads the image content from the provided file path) does not hold an extra copy since it will be uploaded to the graphic memory when first used.
|
||||
* Notice that the image itself should be created within *Image_PixMap* class from *AlienImage* package, while *Image_Image* class is no more supported and will be removed in the next OCCT release.
|
||||
|
||||
@section upgrade_670 Upgrade to OCCT 6.7.0
|
||||
|
||||
Porting of user applications from an earlier OCCT version to version 6.7.0 requires taking into account the following major changes.
|
||||
|
||||
@subsection upgrade_670_clipping Object-level clipping and capping algorithm.
|
||||
|
||||
* It might be necessary to revise and port code related to management of view-level clipping to use *Graphic3d_ClipPlane* instead of *V3d_Plane* instances. Please note that *V3d_Plane* class has been preserved -- as previously, it can be used as plane representation. Another approach to represent *Graphic3d_ClipPlane* in a view is to use custom presentable object.
|
||||
* The list of arguments of *Select3D_SensitiveEntity::Matches()* method for picking detection has changed. Since now, for correct selection clipping, the implementations should perform a depth clipping check and return (as output argument) minimum depth value found at the detected part of sensitive. Please refer to CDL / Doxygen documentation to find descriptive hints and snippets.
|
||||
* *Select3D_SensitiveEntity::ComputeDepth()* abstract method has been removed. Custom implementations should provide depth checks by method *Matches()* instead -- all data required for it is available within a scope of single method.
|
||||
* It might be necessary to revise the code of custom sensitive entities and port *Matches()* and *ComputeDepth()* methods to ensure proper selection clipping. Please note that obsolete signature of *Matches* is not used anymore by the selector. If your class inheriting *Select3D_SensitiveEntity* redefines the method with old signature the code should not compile as the return type has been changed. This is done to prevent override of removed methods.
|
||||
|
||||
@subsection upgrade_670_markers Redesign of markers presentation
|
||||
|
||||
* Due to the redesign of *Graphic3d_AspectMarker3d* class the code of custom markers initialization should be updated. Notice that you can reuse old markers definition code as *TColStd_HArray1OfByte*; however, *Image_PixMap* is now the preferred way (and supports full-color images on modern hardware).
|
||||
* Logics and arguments of methods *AIS_InteractiveContext::Erase()* and *AIS_InteractiveContext::EraseAll()* have been changed. Now these methods do not remove resources from *Graphic3d_Structure*; they simply change the visibility flag in it. Therefore, the code that deletes and reсomputes resources should be revised.
|
||||
* *Graphic3d_Group::MarkerSet()* has been removed. *Graphic3d_Group::AddPrimitiveArray()* should be used instead to specify marker(s) array.
|
||||
|
||||
@subsection upgrade_670_views Default views are not created automatically
|
||||
|
||||
As the obsolete methods *Init(), DefaultOrthographicView()* and *DefaultPerspectiveView()* have been removed from *V3d_Viewer* class, the two default views are no longer created automatically. It is obligatory to create *V3d_View* instances explicitly, either directly by operator new or by calling *V3d_Viewer::CreateView()*.
|
||||
|
||||
The call *V3d_Viewer::SetDefaultLights()* should also be done explicitly at the application level, if the application prefers to use the default light source configuration. Otherwise, the application itself should set up the light sources to obtain a correct 3D scene.
|
||||
|
||||
@subsection upgrade_670_dimensions Improved dimensions implementation
|
||||
|
||||
* It might be necessary to revise and port code related to management of *AIS_LengthDimension, AIS_AngleDimension* and *AIS_DiameterDimension* presentations. There is no more need to compute value of dimension and pass it as string to constructor argument. The value is computed internally. The custom value can be set with *SetCustomValue()* method.
|
||||
* The definition of units and general aspect properties is now provided by *Prs3d_DimensionUnits* and *Prs3d_DimensionApsect* classes.
|
||||
* It might be also necessary to revise code of your application related to usage of *AIS_DimensionDisplayMode enumeration*. If it used for specifying the selection mode, then it should be replaced by a more appropriate enumeration *AIS_DimensionSelectionMode*.
|
||||
|
||||
@subsection upgrade_670_list_collection NCollection_Set replaced by List collection
|
||||
|
||||
It might be necessary to revise your application code, which uses non-ordered *Graphic3d_SetOfHClipPlane* collection type and replace its occurrences by ordered *Graphic3d_SequenceOfHClipPlane* collection type.
|
||||
|
||||
|
||||
@section upgrade_680 Upgrade to OCCT 6.8.0
|
||||
|
||||
Porting of user applications from an earlier OCCT version to version 6.8.0 requires taking into account the following major changes.
|
||||
|
||||
@subsection upgrade_680_ncollection Changes in NCollection classes
|
||||
|
||||
Method *Assign()* in *NCollection* classes does not allow any more copying between different collection types. Such copying should be done manually.
|
||||
|
||||
List and map classes in *NCollection* package now require that their items be copy-constructible, but do not require items to have default constructor. Thus the code using *NCollection* classes for non-copy-constructible objects needs be updated. One option is to provide copy constructor; another possibility is to use Handle or other smart pointer.
|
||||
|
||||
@subsection upgrade_680_view_camera 3D View Camera
|
||||
|
||||
If *ViewMapping* and *ViewOrientation* were used directly, this functionality has to be ported to the new camera model. The following methods should be considered as an alternative to the obsolete *Visual3d* services (all points and directions are supposed to be in world coordinates):
|
||||
* *Graphic3d_Camera::ViewDimensions()* or *V3d_View::Size()/ZSize()* -- returns view width, height and depth (or "Z size"). Since the view is symmetric now, you can easily compute top, bottom, left and right limits. *Graphic3d_Camera::ZNear()/ZFar()* can be used to obtain the near and far clipping distances with respect to the eye.
|
||||
* *Graphic3d_Camera::Up()* or *V3d_View::Up()* -- returns Y direction of the view.
|
||||
* *Graphic3d_Camera::Direction()* returns the reverse view normal directed from the eye, *V3d_View::Proj()* returns the old-style view normal.
|
||||
* *Graphic3d_Camera::Eye()* or *V3d_View::Eye()* -- returns the camera position (same as projection reference point in old implementation).
|
||||
* *Graphic3d_Camera::Center()* or *V3d_View::At()* -- returns the point the camera looks at (or view reference point according to old terminology).
|
||||
|
||||
The current perspective model is not fully backward compatible, so the old perspective-related functionality needs to be reviewed.
|
||||
|
||||
Please revise application-specific custom presentations to provide proper bounding box. Otherwise object might become erroneously clipped by automatic *ZFit* or frustum culling algorithms enabled by default.
|
||||
|
||||
@subsection upgrade_680_connected_objects Redesign of Connected Interactive Objects
|
||||
|
||||
The new implementation of connected Interactive Objects makes it necessary to take the following steps if you use connected Interactive Objects in your application.
|
||||
* Use new *PrsMgr_PresentableObject* transformation API.
|
||||
* Call *RemoveChild()* from the original object after connect if you need the original object and *AIS_ConnectedInteractive* to move independently.
|
||||
* Access instances of objects connected to *AIS_MultiplyConnectedInteractive* with *Children()* method.
|
||||
* For *PrsMgr_PresentableObject* transformation:
|
||||
* *SetLocation (TopLoc_Location) -> SetLocalTransformation (gp_Trsf)*
|
||||
* *Location -> LocalTransformation*
|
||||
* *HasLocation -> HasTransformation*
|
||||
* *ResetLocation -> ResetTransformation*
|
||||
|
||||
@subsection upgrade_680_unicode Support of UNICODE Characters
|
||||
|
||||
Support of UNICODE characters introduced in OCCT breaks backward compatibility with applications, which currently use filenames in extended ASCII encoding bound to the current locale. Such applications should be updated to convert such strings to UTF-8 format.
|
||||
|
||||
The conversion from UTF-8 to wchar_t is made using little-endian approach. Thus, this code will not work correctly on big-endian platforms. It is needed to complete this in the way similar as it is done for binary persistence (see the macro *DO_INVERSE* in *FSD_FileHeader.hxx).*
|
||||
|
||||
@subsection upgrade_680_projection_shift Elimination of Projection Shift Concept
|
||||
|
||||
It might be necessary to revise the application code, which deals with *Center()* method of *V3d_View*.
|
||||
|
||||
This method was used to pan a *V3d* view by virtually moving the screen center with respect to the projection ray passed through Eye and At points. There is no more need to derive the panning from the Center parameter to get a camera-like eye position and look at the coordinates. *Eye()* and *At()* now return these coordinates directly. When porting code dealing with *Center()*, the parameters *Eye()* and *At()* can be adjusted instead. Also *V3d_View::SetCenter(Xpix, Ypix)* method can be used instead of *V3d_View::Center(X, Y)* to center the view at the given point. However, if the center coordinates X and Y come from older OCCT releases, calling *V3d_View::Panning(-X, -Y)* can be recommended to compensate missing projection shift effect.
|
||||
|
||||
There are several changes introduced to *Graphic3d_Camera*. The internal data structure of the camera is based on *Standard_Real* data types to avoid redundant application-level conversions and precision errors. The transformation matrices now can be evaluated both for *Standard_Real* and *Standard_ShortReal* value types. *ZNear* and *ZFar* planes can be either negative or positive for orthographic camera projection, providing a trade-off between the camera distance and the range of *ZNear* or *ZFar* to reduce difference of exponents of values composing the orientation matrix - to avoid calculation errors. The negative values can be specified to avoid Z-clipping if the reference system of camera goes inside of the model when decreasing camera distance.
|
||||
|
||||
The auto z fit mode, since now, has a parameter defining Z-range margin (the one which is usually passed as argument to *ZFitAll()* method). The methods *SetAutoZFitMode(), AutoZFitScaleFactor()* and *ZFitAll()* from class *V3d_View* deal with the new parameter.
|
||||
|
||||
The class *Select3D_Projector* now supports both orientation and projection transformation matrices, which can be naturally set for the projector. The definition of projector was revised in *StdSelect_ViewerSelector3d*: perspective and orthographic projection parameters are handled properly. Orthographic projector is based only on direction of projection - no more *Center* property. This makes it possible to avoid unnecessary re-projection of sensitive while panning, zooming or moving along the projection ray of the view. These operations do not affect the orthographic projection.
|
||||
|
||||
|
||||
@section upgrade_690 Upgrade to OCCT 6.9.0
|
||||
|
||||
Porting of user applications from an earlier OCCT version to version 6.9.0 requires taking into account the following major changes.
|
||||
|
||||
|
||||
@subsection upgrade_690_selection Changes in Selection
|
||||
|
||||
Selection mechanism of 3D Viewer has been redesigned to use 3-level BVH tree traverse directly in 3D space instead of projection onto 2D screen space (updated on each rotation). This architectural redesign may require appropriate changes at application level in case if custom Interactive Objects are used.
|
||||
|
||||
#### Standard selection
|
||||
Usage of standard OCCT selection entities would require only minor updates.
|
||||
|
||||
Custom Interactive Objects should implement new virtual method *SelectMgr_SelectableObject::BoundingBox().*
|
||||
|
||||
Now the method *SelectMgr_Selection::Sensitive()* does not return *SelectBasics_SensitiveEntity*. It returns an instance of *SelectMgr_SensitiveEntity*, which belongs to a different class hierarchy (thus *DownCast()* will fail). To access base sensitive it is necessary to use method *SelectMgr_SensitiveEntity::BaseSensitive()*. For example:
|
||||
|
||||
~~~~
|
||||
Handle(SelectMgr_Selection) aSelection = anInteractiveObject->Selection (aMode);
|
||||
for (aSelection->Init(); aSelection->More(); aSelection->Next())
|
||||
{
|
||||
Handle(SelectBasics_SensitiveEntity) anEntity = aSelection->Sensitive()->BaseSensitive();
|
||||
}
|
||||
~~~~
|
||||
|
||||
#### Custom sensitive entities
|
||||
|
||||
Custom sensitive entities require more complex changes, since the selection algorithm has been redesigned and requires different output from the entities.
|
||||
|
||||
The method *SelectBasics_SensitiveEntity::Matches()* of the base class should be overridden following the new signature:
|
||||
|
||||
*Standard_Boolean Matches (SelectBasics_SelectingVolumeManager& theMgr, SelectBasics_PickResult& thePickResult)*, where *theMgr* contains information about the currently selected frustum or set of frustums (see *SelectMgr_RectangularFrustum, SelectMgr_TrangularFrustum, SelectMgr_TriangularFrustumSet)* and *SelectBasics_PickResult* is an output parameter, containing information about the depth of the detected entity and distance to its center of geometry.
|
||||
|
||||
In the overridden method it is necessary to implement an algorithm of overlap and inclusion detection (the active mode is returned by *theMgr.IsOverlapAllowed()*) with triangular and rectangular frustums.
|
||||
|
||||
The depth and distance to the center of geometry must be calculated for the 3D projection of user-picked screen point in the world space. You may use already implemented overlap and inclusion detection methods for different primitives from *SelectMgr_RectangularFrustum* and *SelectMgr_TriangularFrustum*, including triangle, point, axis-aligned box, line segment and planar polygon.
|
||||
|
||||
Here is an example of overlap/inclusion test for a box:
|
||||
|
||||
~~~~
|
||||
if (!theMgr.IsOverlapAllowed()) // check for inclusion
|
||||
{
|
||||
Standard_Boolean isInside = Standard_True;
|
||||
return theMgr.Overlaps (myBox.CornerMin(), myBox.CornerMax(), &isInside) && isInside;
|
||||
}
|
||||
|
||||
Standard_Real aDepth;
|
||||
if (!theMgr.Overlaps (myBox, aDepth)) // check for overlap
|
||||
{
|
||||
return Standard_False;
|
||||
}
|
||||
|
||||
thePickResult =
|
||||
SelectBasics_PickResult (aDepth, theMgr.DistToGeometryCenter (myCenter3d));
|
||||
~~~~
|
||||
|
||||
The interface of *SelectBasics_SensitiveEntity* now contains four new pure virtual functions that should be implemented by each custom sensitive:
|
||||
* <i>::BoundingBox()</i> – returns a bounding box of the entity;
|
||||
* <i>::Clear()</i> – clears up all the resources and memory allocated for complex sensitive entities;
|
||||
* <i>::BVH()</i> – builds a BVH tree for complex sensitive entities, if it is needed;
|
||||
* <i>::NbSubElements()</i> – returns atomic sub-entities of a complex sensitive entity, which will be used as primitives for BVH building. If the entity is simple and no BVH is required, this method returns 1.
|
||||
|
||||
Each sensitive entity now has its own tolerance, which can be overridden by method *SelectBasics_SensitiveEntity::SetSensitivityFactor()* called from constructor.
|
||||
|
||||
|
||||
@subsection upgrade_690_adaptor3d-curve Changes in Adaptor3d_Curve class
|
||||
|
||||
All classes inheriting *Adaptor3d_Curve* (directly or indirectly) must be updated in application code to use new signature of methods *Intervals()* and *NbIntervals()*. Note that no compiler warning will be generated if this is not done.
|
||||
|
||||
@subsection upgrade_690_v3d_view Changes in V3d_View class
|
||||
|
||||
The methods *V3d_View::Convert* and *V3d_View::ConvertWithProj()* have ceased to return point on the active grid. It might be necessary to revise the code of your application so that *V3d_View::ConvertToGrid()* was called explicitly for the values returned by *V3d_View::Convert* to get analogous coordinates on the grid. The methods *V3d_View::Convert* and *V3d_View::ConvertWithProj* convert point into reference plane of the view corresponding to the intersection with the projection plane of the eye/view point vector.
|
||||
|
||||
@section upgrade_700 Upgrade to OCCT 7.0.0
|
||||
|
||||
Porting of user applications from an earlier OCCT version to version 7.0.0 requires taking into account the following major changes.
|
||||
|
||||
@subsection upgrade_700_persist Removal of legacy persistence
|
||||
|
||||
Legacy persistence for shapes and OCAF data based on *Storage_Schema* (toolkits *TKShapeShcema, TLStdLSchema, TKStdSchema* and *TKXCAFSchema*) has been removed in OCCT 7.0.0.
|
||||
@ -652,20 +945,26 @@ The main functionality provided by Local Context - selection of object subparts
|
||||
|
||||
@subsection upgrade_occt700_separate_caf_visualisation Separation of visualization part from TKCAF
|
||||
|
||||
Visualization CAF attributes moved into new toolkit TKVCAF.
|
||||
If your application uses the classes from TPrsStd package then add link to TKVCAF library.
|
||||
Visualization CAF attributes have been moved into a new toolkit *TKVCAF*.
|
||||
If your application uses the classes from *TPrsStd* package then add link to *TKVCAF* library.
|
||||
|
||||
Verson numbers of BinOCAF and XmlOCAF formats are incremented; new files cannot be read by previous versions of OCCT.
|
||||
Version numbers of *BinOCAF* and *XmlOCAF* formats are incremented; new files cannot be read by earlier versions of OCCT.
|
||||
|
||||
For loading OCAF files saved by previous versions and containing attribute TPrsStd_AISPresentation it is necessary that environment variable CSF_MIGRATION_TYPES should be defined, pointing to file src/StdResources/MigrationSheet.txt.
|
||||
When using documents loaded from a file, make sure to call method TPrsStd_AISViewer::New() prior to accessing TPrsStd_AISPresentation attributes in this document (that method will create them).
|
||||
Before loading the OCAF files saved by previous versions and containing *TPrsStd_AISPresentation* attribute it is necessary to define the environment variable *CSF_MIGRATION_TYPES*, pointing to file *src/StdResources/MigrationSheet.txt*.
|
||||
When using documents loaded from a file, make sure to call method *TPrsStd_AISViewer::New()* prior to accessing *TPrsStd_AISPresentation* attributes in this document as that method creates them.
|
||||
|
||||
@subsection upgrade_euler_angles Correction of interpretation of Euler angles in gp_Quaternion
|
||||
|
||||
@subsection Correction of interpretation of Euler angles in gp_Quaternion
|
||||
Conversion of *gp_Quaternion* to and from intrinsic Tait-Bryan angles (including *gp_YawPitchRoll*) is fixed.
|
||||
|
||||
Conversion of gp_Quaternion to and from intrinsic Tait-Bryan angles (including gp_YawPitchRoll) is fixed.
|
||||
Before that fix the sequence of rotation axes was opposite to the intended; e.g. *gp_YawPitchRoll* (equivalent to *gp_Intrinsic_ZYX*) actually defined intrinsic rotations around X, then Y, then Z. Now the rotations are made in correct order.
|
||||
|
||||
Before that fix the sequence of rotation axes was opposite to intended; e.g. gp_YawPitchRoll (equivalent to gp_Intrinsic_ZYX) actually was defining intrinsic rotations around X, then Y, then Z.
|
||||
Now this is fixed, and rotations are made in correct order.
|
||||
Applications that use *gp_Quaternion* to convert Yaw-Pitch-Roll angles (or other intrinsic Tait-Bryan sequences) may need to be updated to take this change into account.
|
||||
|
||||
Applications that use gp_Quaternion to convert Yaw-Pitch-Roll angles (or other intrinsic Tait-Bryan sequences) may need to be updated to take this change into account.
|
||||
@subsection upgrade_zoom_persistent_selection Zoom Persistent Selection
|
||||
|
||||
Zoom persistent selection introduces a new structure *Graphic3d_TransformPers* for transform persistence methods and parameters and a new class *Graphic3d_WorldViewProjState* for referring camera transformation state. You might need to update your code to deal with the new classes if you were using the related features. Please, keep in mind the following:
|
||||
* *Graphic3d_Camera::ModelViewState* has been renamed to *Graphic3d_Camera::WorldViewState*.
|
||||
* Transformation matrix utilities from *OpenGl_Utils* namespace have been moved to *Graphic3d_TransformUtils* and *Graphic3d_TransformUtils.hxx* header respectively.
|
||||
* Matrix stack utilities from *OpenGl_Utils* namespace have been moved to *OpenGl_MatrixStack* class and *OpenGl_MatrixStack.hxx* header respectively.
|
||||
* *OpenGl_View* methods *Begin/EndTransformPersistence* have been removed. Please, use *Graphic3d_TransformPers::Apply()* instead to apply persistence to perspective and world-view projection matrices.
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user