mirror of
https://github.com/Kitware/CMake.git
synced 2026-01-04 04:40:56 -06:00
3d97b95400
- Modules documentation updated and synced. - Internal comments about headers moved to the modules introduction section. - Added examples sections. - Used the `<PackageName>_FOUND` variables (CMake 3.3). The uppercased `<PACKAGENAME>_FOUND` are also set to the same value. - Mention of CMake 2.6.3 removed as these version notes are now being cleaned in the CMake 4 documentation (CMake docs are at this point considering the 2.8.12.2 as the initial state upon which new and changed items are documented through versions). - Added notes that these modules are not intended anymore to be used directly except for advanced case scenarios. The FindOpenSceneGraph module should be used. - Fixed osgQt description in FindOpenSceneGraph and synced it a bit.
121 lines
3.4 KiB
CMake
121 lines
3.4 KiB
CMake
# Distributed under the OSI-approved BSD 3-Clause License. See accompanying
|
|
# file LICENSE.rst or https://cmake.org/licensing for details.
|
|
|
|
#[=======================================================================[.rst:
|
|
FindosgFX
|
|
---------
|
|
|
|
Finds the osgFX NodeKit from the OpenSceneGraph toolkit.
|
|
|
|
.. note::
|
|
|
|
In most cases, it's recommended to use the :module:`FindOpenSceneGraph` module
|
|
instead and list osgFX as a component. This will automatically handle
|
|
dependencies such as the OpenThreads and core osg libraries:
|
|
|
|
.. code-block:: cmake
|
|
|
|
find_package(OpenSceneGraph COMPONENTS osgFX)
|
|
|
|
This module is used internally by :module:`FindOpenSceneGraph` to find the
|
|
osgFX NodeKit. It is not intended to be included directly during typical
|
|
use of the :command:`find_package` command. However, it is available as a
|
|
standalone module for advanced use cases where finer control over detection is
|
|
needed. For example, to find the osgFX explicitly or bypass automatic
|
|
component detection:
|
|
|
|
.. code-block:: cmake
|
|
|
|
find_package(osgFX)
|
|
|
|
OpenSceneGraph and osgFX headers are intended to be included in C++ project
|
|
source code as:
|
|
|
|
.. code-block:: c++
|
|
:caption: ``example.cxx``
|
|
|
|
#include <osg/PositionAttitudeTransform>
|
|
#include <osgFX/BumpMapping>
|
|
// ...
|
|
|
|
When working with the OpenSceneGraph toolkit, other libraries such as OpenGL may
|
|
also be required.
|
|
|
|
Result Variables
|
|
^^^^^^^^^^^^^^^^
|
|
|
|
This module defines the following variables:
|
|
|
|
``osgFX_FOUND``
|
|
Boolean indicating whether the osgFX NodeKit of the OpenSceneGraph toolkit
|
|
is found. For backward compatibility, the ``OSGFX_FOUND`` variable is also
|
|
set to the same value.
|
|
|
|
``OSGFX_LIBRARIES``
|
|
The libraries needed to link against to use osgFX.
|
|
|
|
``OSGFX_LIBRARY``
|
|
A result variable that is set to the same value as the ``OSGFX_LIBRARIES``
|
|
variable.
|
|
|
|
Cache Variables
|
|
^^^^^^^^^^^^^^^
|
|
|
|
The following cache variables may also be set:
|
|
|
|
``OSGFX_INCLUDE_DIR``
|
|
The include directory containing headers needed to use osgFX.
|
|
|
|
``OSGFX_LIBRARY_DEBUG``
|
|
The path to the osgFX debug library.
|
|
|
|
Hints
|
|
^^^^^
|
|
|
|
This module accepts the following variables:
|
|
|
|
``OSGDIR``
|
|
Environment variable that can be set to help locate the OpenSceneGraph
|
|
toolkit, including its osgFX NodeKit, when installed in a custom
|
|
location. It should point to the OpenSceneGraph installation prefix used when
|
|
it was configured, built, and installed: ``./configure --prefix=$OSGDIR``.
|
|
|
|
Examples
|
|
^^^^^^^^
|
|
|
|
Finding osgFX explicitly with this module and creating an interface
|
|
:ref:`imported target <Imported Targets>` that encapsulates its usage
|
|
requirements for linking it to a project target:
|
|
|
|
.. code-block:: cmake
|
|
|
|
find_package(osgFX)
|
|
|
|
if(osgFX_FOUND AND NOT TARGET osgFX::osgFX)
|
|
add_library(osgFX::osgFX INTERFACE IMPORTED)
|
|
set_target_properties(
|
|
osgFX::osgFX
|
|
PROPERTIES
|
|
INTERFACE_INCLUDE_DIRECTORIES "${OSGFX_INCLUDE_DIR}"
|
|
INTERFACE_LINK_LIBRARIES "${OSGFX_LIBRARIES}"
|
|
)
|
|
endif()
|
|
|
|
target_link_libraries(example PRIVATE osgFX::osgFX)
|
|
|
|
See Also
|
|
^^^^^^^^
|
|
|
|
* The :module:`FindOpenSceneGraph` module to find OpenSceneGraph toolkit.
|
|
#]=======================================================================]
|
|
|
|
# Created by Eric Wing.
|
|
|
|
include(${CMAKE_CURRENT_LIST_DIR}/Findosg_functions.cmake)
|
|
OSG_FIND_PATH (OSGFX osgFX/BumpMapping)
|
|
OSG_FIND_LIBRARY(OSGFX osgFX)
|
|
|
|
include(FindPackageHandleStandardArgs)
|
|
find_package_handle_standard_args(osgFX DEFAULT_MSG
|
|
OSGFX_LIBRARY OSGFX_INCLUDE_DIR)
|