< Home
< Table of Contents
REFERENCE MANUAL
C++ API class index
C# API class index
include
sprk_sketchup.h
1
// Copyright (c) 1998-2014 by Tech Soft 3D, Inc.
2
//
3
// The information contained herein is confidential and proprietary to Tech Soft 3D, Inc.,
4
// and considered a trade secret as defined under civil and criminal statutes.
5
// Tech Soft 3D, Inc. shall pursue its civil and criminal remedies in the event of
6
// unauthorized use or misappropriation of its trade secrets. Use of this information
7
// by anyone other than authorized employees of Tech Soft 3D, Inc. is granted only under
8
// a written non-disclosure agreement, expressly prescribing the scope and manner of such use.
9
10
#ifndef SPRK_SKETCHUP_H
11
#define SPRK_SKETCHUP_H
12
13
#include "sprk.h"
14
15
#ifdef _MSC_VER
16
#ifndef STATIC_APP
17
# ifdef SPROCKETS
18
# define SKETCHUP_API __declspec (dllexport)
19
# else
20
# define SKETCHUP_API __declspec (dllimport)
21
# endif
22
#endif
23
#else
24
# include <stddef.h>
25
#endif
26
27
#ifndef SKETCHUP_API
28
# define SKETCHUP_API
29
#endif
30
31
namespace
HPS
32
{
33
35
class
SKETCHUP_API
Sketchup
36
{
37
public
:
38
40
class
SKETCHUP_API
ImportResultsKit
:
public
Sprocket
41
{
42
public
:
44
ImportResultsKit
();
45
48
ImportResultsKit
(
ImportResultsKit
const
& in_kit);
49
53
ImportResultsKit
(
ImportResultsKit
&& in_that);
54
58
ImportResultsKit
& operator=(
ImportResultsKit
&& in_that);
59
60
virtual
~
ImportResultsKit
();
61
62
Type
ObjectType
()
const
{
return
Type::SketchupImportResultsKit; };
63
66
void
Set(
ImportResultsKit
const
& in_kit);
67
70
void
Show(
ImportResultsKit
& out_kit)
const
;
71
75
ImportResultsKit
& operator=(
ImportResultsKit
const
& in_kit);
76
79
bool
Empty()
const
;
80
84
bool
Equals(
ImportResultsKit
const
& in_kit)
const
;
85
89
bool
operator==(
ImportResultsKit
const
& in_kit)
const
;
90
94
bool
operator!=(
ImportResultsKit
const
& in_kit)
const
;
95
100
bool
ShowTarget(
SegmentKey
& out_target,
SegmentKey
& out_library)
const
;
101
105
bool
ShowTarget(
Model
& out_model)
const
;
106
110
bool
ShowPortfolio(
PortfolioKey
& out_portfolio)
const
;
111
115
bool
ShowView(
View
& out_view)
const
;
116
120
bool
ShowMainCamera(
CameraKit
& out_camera)
const
;
121
126
bool
ShowScenes(UTF8Array & out_names, CameraKitArray & out_cameras)
const
;
127
};
128
129
131
class
SKETCHUP_API
ImportNotifier
:
public
IONotifier
132
{
133
public
:
135
ImportNotifier
();
136
139
ImportNotifier
(
ImportNotifier
const
& in_that);
140
145
ImportNotifier
(
IONotifier
const
& in_that);
146
150
ImportNotifier
(
ImportNotifier
&& in_that);
151
155
ImportNotifier
& operator=(
ImportNotifier
&& in_that);
156
157
virtual
~
ImportNotifier
();
158
159
Type
ObjectType
()
const
{
return
Type::SketchupImportNotifier; };
160
164
ImportNotifier
& operator=(
ImportNotifier
const
& in_that);
165
168
void
Assign(
ImportNotifier
const
& in_that);
169
173
ImportResultsKit
GetResults()
const
;
174
};
175
177
class
SKETCHUP_API
ImportOptionsKit
:
public
Sprocket
178
{
179
public
:
181
ImportOptionsKit
();
182
185
ImportOptionsKit
(
ImportOptionsKit
const
& in_kit);
186
190
ImportOptionsKit
(
ImportOptionsKit
&& in_that);
191
195
ImportOptionsKit
& operator=(
ImportOptionsKit
&& in_that);
196
197
virtual
~
ImportOptionsKit
();
198
199
Type
ObjectType
()
const
{
return
Type::SketchupImportOptionsKit; }
200
204
static
ImportOptionsKit
GetDefault();
205
208
void
Set(
ImportOptionsKit
const
& in_kit);
209
212
void
Show(
ImportOptionsKit
& out_kit)
const
;
213
217
ImportOptionsKit
& operator=(
ImportOptionsKit
const
& in_kit);
218
221
bool
Empty()
const
;
222
226
bool
Equals(
ImportOptionsKit
const
& in_kit)
const
;
227
231
bool
operator==(
ImportOptionsKit
const
& in_kit)
const
;
232
236
bool
operator!=(
ImportOptionsKit
const
& in_kit)
const
;
237
238
244
ImportOptionsKit
& SetTarget(
SegmentKey
const
& in_target,
SegmentKey
const
& in_library);
245
249
ImportOptionsKit
& SetTarget(
Model
const
& in_model);
250
255
ImportOptionsKit
& SetPortfolio(
PortfolioKey
const
& in_portfolio);
256
261
ImportOptionsKit
& SetView(
View
const
& in_view);
262
266
ImportOptionsKit
& SetHiddenData(
bool
in_state);
267
271
ImportOptionsKit
& SetMetaData(
bool
in_state);
272
273
276
ImportOptionsKit
& UnsetTarget();
277
280
ImportOptionsKit
& UnsetPortfolio();
281
284
ImportOptionsKit
& UnsetView();
285
288
ImportOptionsKit
& UnsetHiddenData();
289
292
ImportOptionsKit
& UnsetMetaData();
293
296
ImportOptionsKit
& UnsetEverything();
297
298
304
bool
ShowTarget(
SegmentKey
& out_target,
SegmentKey
& out_library)
const
;
305
310
bool
ShowTarget(
Model
& out_model)
const
;
311
316
bool
ShowPortfolio(
PortfolioKey
& out_portfolio)
const
;
317
321
bool
ShowView(
View
& out_view)
const
;
322
326
bool
ShowHiddenData(
bool
& out_state)
const
;
327
331
bool
ShowMetaData(
bool
& out_state)
const
;
332
};
333
334
336
class
SKETCHUP_API
File
337
{
338
public
:
343
static
ImportNotifier
Import(
char
const
* in_file_name,
ImportOptionsKit
const
& in_options);
344
345
private
:
347
File
();
348
};
349
350
private
:
352
Sketchup
();
353
};
354
355
}
356
357
#endif
Sketchup::ImportResultsKit
Definition:
sprk_sketchup.h:40
View
Definition:
sprk.h:238
Sprocket
Definition:
sprk.h:69
SegmentKey
Definition:
hps.h:7139
Sketchup
Definition:
sprk_sketchup.h:35
IONotifier
Definition:
hps.h:41102
Sketchup::File
Definition:
sprk_sketchup.h:336
Model
Definition:
sprk.h:430
Sketchup::ImportNotifier::ObjectType
Type ObjectType() const
Definition:
sprk_sketchup.h:159
Sketchup::ImportOptionsKit
Definition:
sprk_sketchup.h:177
Sketchup::ImportOptionsKit::ObjectType
Type ObjectType() const
Definition:
sprk_sketchup.h:199
Sketchup::ImportNotifier
Definition:
sprk_sketchup.h:131
CameraKit
Definition:
hps.h:9808
PortfolioKey
Definition:
hps.h:35499
Sketchup::ImportResultsKit::ObjectType
Type ObjectType() const
Definition:
sprk_sketchup.h:62