CFx SDK Documentation
2024 SP0
Loading...
Searching...
No Matches
SDK
CFx
dd_inc
Tr
render
TrRndRenderModule.h
Go to the documentation of this file.
1
2
// Copyright (C) 2002-2022, Open Design Alliance (the "Alliance").
3
// All rights reserved.
4
//
5
// This software and its documentation and related materials are owned by
6
// the Alliance. The software may only be incorporated into application
7
// programs owned by members of the Alliance, subject to a signed
8
// Membership Agreement and Supplemental Software License Agreement with the
9
// Alliance. The structure and organization of this software are the valuable
10
// trade secrets of the Alliance and its suppliers. The software is also
11
// protected by copyright law and international treaty provisions. Application
12
// programs incorporating this software must include the following statement
13
// with their copyright notices:
14
//
15
// This application incorporates Open Design Alliance software pursuant to a license
16
// agreement with Open Design Alliance.
17
// Open Design Alliance Copyright (C) 2002-2022 by Open Design Alliance.
18
// All rights reserved.
19
//
20
// By use of this software, its documentation or related materials, you
21
// acknowledge and accept the above terms.
23
// Rendering module interface
24
25
#ifndef ODTRRNDRENDERMODULE
26
#define ODTRRNDRENDERMODULE
27
28
#include "
TD_PackPush.h
"
29
30
#include "
RxModule.h
"
31
#include "
TrRndLocalViewer.h
"
32
36
class
OdTrRndRenderModule
:
public
OdRxModule
37
{
38
public
:
39
// Create new rendition
40
virtual
OdTrVisRenditionPtr
createRendition
(
OdTrRndLocalRenditionClient
*pRenderClient) = 0;
41
// Create new rendition data accessor
42
virtual
OdTrRndLocalRenditionHostPtr
createRenditionHost
(
OdTrVisRendition
*pRendition) = 0;
43
// Create new rendition context
44
virtual
OdTrRndLocalContextPtr
createLocalContext
(
OdTrVisRenderClient
*pDevice) = 0;
45
46
// Create new standalone renderer
47
virtual
OdTrRndLocalRendererPtr
createLocalRenderer
(
OdTrRndLocalRenditionClient
*pRenderClient,
OdTrRndLocalRenditionHost
*pRenditionHost = NULL) = 0;
48
// Create new standalone viewer
49
virtual
OdTrRndLocalViewerPtr
createLocalViewer
(
OdTrRndLocalRenditionClient
*pRenderClient,
OdTrRndLocalRenditionHost
*pRenditionHost = NULL) = 0;
50
51
// Check renderer version
52
virtual
OdUInt32
checkRendererVersion
(
OdTrVisRenderClient
*pDevice,
OdUInt32
nCheckVersion = 0,
OdTrVisRendition
*pRendition = NULL)
const
= 0;
53
};
54
55
typedef
OdSmartPtr<OdTrRndRenderModule>
OdTrRndRenderModulePtr
;
56
60
class
OdTrRndRenderModuleStub
:
public
OdTrRndRenderModule
61
{
62
public
:
63
// Create new rendition data accessor
64
virtual
OdTrRndLocalRenditionHostPtr
createRenditionHost
(
OdTrVisRendition
*
/*pRendition*/
)
65
{
return
OdTrRndLocalRenditionHostPtr
(); }
66
// Create new rendition context
67
virtual
OdTrRndLocalContextPtr
createLocalContext
(
OdTrVisRenderClient
*
/*pDevice*/
)
68
{
return
OdTrRndLocalContextPtr
(); }
69
70
// Create new standalone renderer
71
virtual
OdTrRndLocalRendererPtr
createLocalRenderer
(
OdTrRndLocalRenditionClient
*
/*pRenderClient*/
,
OdTrRndLocalRenditionHost
*
/*pRenditionHost*/
= NULL)
72
{
return
OdTrRndLocalRendererPtr
(); }
73
// Create new standalone viewer
74
virtual
OdTrRndLocalViewerPtr
createLocalViewer
(
OdTrRndLocalRenditionClient
*
/*pRenderClient*/
,
OdTrRndLocalRenditionHost
*
/*pRenditionHost*/
= NULL)
75
{
return
OdTrRndLocalViewerPtr
(); }
76
77
// Check renderer version
78
virtual
OdUInt32
checkRendererVersion
(
OdTrVisRenderClient
*
/*pDevice*/
,
OdUInt32
/*nCheckVersion*/
= 0,
OdTrVisRendition
*
/*pRendition*/
= NULL)
const
79
{
return
0; }
80
};
81
85
class
OdTrRndLocalRenderModule
:
public
OdTrRndRenderModuleStub
86
{
87
public
:
88
// Create new rendition context
89
virtual
OdTrRndLocalContextPtr
createLocalContext
(
OdTrVisRenderClient
*pDevice);
90
91
// Create new standalone renderer
92
virtual
OdTrRndLocalRendererPtr
createLocalRenderer
(
OdTrRndLocalRenditionClient
*pRenderClient,
OdTrRndLocalRenditionHost
*pRenditionHost = NULL);
93
// Create new standalone viewer
94
virtual
OdTrRndLocalViewerPtr
createLocalViewer
(
OdTrRndLocalRenditionClient
*pRenderClient,
OdTrRndLocalRenditionHost
*pRenditionHost = NULL);
95
};
96
97
98
#include "
TD_PackPop.h
"
99
100
#endif
// ODTRRNDRENDERMODULE
OdUInt32
unsigned int OdUInt32
Definition:
OdPlatformSettings.h:814
RxModule.h
TD_PackPop.h
TD_PackPush.h
OdTrRndLocalContextPtr
OdSmartPtr< OdTrRndLocalContext > OdTrRndLocalContextPtr
Definition:
TrRndLocalContext.h:108
TrRndLocalViewer.h
OdTrRndRenderModulePtr
OdSmartPtr< OdTrRndRenderModule > OdTrRndRenderModulePtr
Definition:
TrRndRenderModule.h:55
OdRxModule
Definition:
RxModule.h:45
OdSmartPtr< OdTrVisRendition >
OdTrRndLocalRenderModule
Definition:
TrRndRenderModule.h:86
OdTrRndLocalRenderModule::createLocalRenderer
virtual OdTrRndLocalRendererPtr createLocalRenderer(OdTrRndLocalRenditionClient *pRenderClient, OdTrRndLocalRenditionHost *pRenditionHost=NULL)
OdTrRndLocalRenderModule::createLocalViewer
virtual OdTrRndLocalViewerPtr createLocalViewer(OdTrRndLocalRenditionClient *pRenderClient, OdTrRndLocalRenditionHost *pRenditionHost=NULL)
OdTrRndLocalRenderModule::createLocalContext
virtual OdTrRndLocalContextPtr createLocalContext(OdTrVisRenderClient *pDevice)
OdTrRndLocalRendererPtr
Definition:
TrRndLocalRenderer.h:218
OdTrRndLocalRenditionClient
Definition:
TrRndLocalRenditionHost.h:83
OdTrRndLocalRenditionHost
Definition:
TrRndLocalRenditionHost.h:44
OdTrRndLocalRenditionHostPtr
Definition:
TrRndLocalRenditionHost.h:116
OdTrRndLocalViewerPtr
Definition:
TrRndLocalViewer.h:143
OdTrRndRenderModule
Definition:
TrRndRenderModule.h:37
OdTrRndRenderModule::createRendition
virtual OdTrVisRenditionPtr createRendition(OdTrRndLocalRenditionClient *pRenderClient)=0
OdTrRndRenderModule::checkRendererVersion
virtual OdUInt32 checkRendererVersion(OdTrVisRenderClient *pDevice, OdUInt32 nCheckVersion=0, OdTrVisRendition *pRendition=NULL) const =0
OdTrRndRenderModule::createLocalRenderer
virtual OdTrRndLocalRendererPtr createLocalRenderer(OdTrRndLocalRenditionClient *pRenderClient, OdTrRndLocalRenditionHost *pRenditionHost=NULL)=0
OdTrRndRenderModule::createLocalContext
virtual OdTrRndLocalContextPtr createLocalContext(OdTrVisRenderClient *pDevice)=0
OdTrRndRenderModule::createLocalViewer
virtual OdTrRndLocalViewerPtr createLocalViewer(OdTrRndLocalRenditionClient *pRenderClient, OdTrRndLocalRenditionHost *pRenditionHost=NULL)=0
OdTrRndRenderModule::createRenditionHost
virtual OdTrRndLocalRenditionHostPtr createRenditionHost(OdTrVisRendition *pRendition)=0
OdTrRndRenderModuleStub
Definition:
TrRndRenderModule.h:61
OdTrRndRenderModuleStub::checkRendererVersion
virtual OdUInt32 checkRendererVersion(OdTrVisRenderClient *, OdUInt32=0, OdTrVisRendition *=NULL) const
Definition:
TrRndRenderModule.h:78
OdTrRndRenderModuleStub::createLocalContext
virtual OdTrRndLocalContextPtr createLocalContext(OdTrVisRenderClient *)
Definition:
TrRndRenderModule.h:67
OdTrRndRenderModuleStub::createRenditionHost
virtual OdTrRndLocalRenditionHostPtr createRenditionHost(OdTrVisRendition *)
Definition:
TrRndRenderModule.h:64
OdTrRndRenderModuleStub::createLocalViewer
virtual OdTrRndLocalViewerPtr createLocalViewer(OdTrRndLocalRenditionClient *, OdTrRndLocalRenditionHost *=NULL)
Definition:
TrRndRenderModule.h:74
OdTrRndRenderModuleStub::createLocalRenderer
virtual OdTrRndLocalRendererPtr createLocalRenderer(OdTrRndLocalRenditionClient *, OdTrRndLocalRenditionHost *=NULL)
Definition:
TrRndRenderModule.h:71
OdTrVisRenderClient
Definition:
TrVisRenderClient.h:53
OdTrVisRendition
Definition:
TrVisRendition.h:62
Generated on Wed Apr 5 2023 17:29:24