Hide Table of Contents
SOLIDWORKS Electrical API 2024.0.0
Electrical API
EwProjectEntity3DObjects.idl
Go to the documentation of this file.
1#pragma once
2
3#if (__midl >= 501)
4 midl_pragma warning(disable:2111) /* Disable warning MIDL2111 regarding identifier lengths exceeding 31 chars. */
5#endif
6
7import "oaidl.idl";
8import "ocidl.idl";
9
10import "EnumDefinition.idl";
11import "EwProjectManufacturerPartObjects.idl";
12import "EwProjectLocationObjects.idl";
13
18[
19 object,
20 uuid(6c084ea8-1fcf-11e5-b5f7-727283247c7f),
21 dual,
22 oleautomation,
23 nonextensible,
24 helpstring("IEwProjectEntity3DX Interface"),
25 hidden,
26 pointer_default(unique)
27]
29{
30
31 /*
32 * Set the associated 3DObject ID
33 * param[in] strID ID of the associated 3D Object
34 * \return EwErrorCode enum type, can be:
35 * \li EW_NO_ERROR if no error detected
36 * \li EW_UNDEFINED_ERROR if another error occurred
37 * \li EW_INVALID_OBJECT if object is not initialized
38 */
39 EwErrorCode set3DID (BSTR strID);
40
41
42 /*
43 * Set the associated 3DObject ID
44 * param[in] lFileID ID of file associated 3D Object
45 * \return EwErrorCode enum type, can be:
46 * \li EW_NO_ERROR if no error detected
47 * \li EW_UNDEFINED_ERROR if another error occurred
48 * \li EW_INVALID_ID the ID is not associated to any object
49 * \li EW_INVALID_OBJECT if object is not initialized
50 */
52
53
63
64
73 BSTR get3DID (EwErrorCode* errorCode);
74
75
84 LONG getEwObjectID (EwErrorCode* errorCode);
85
86
87 /*
88 * Set the Object ID
89 * param[in] lID ID of the object
90 * para[in] eEntity3DType Type of the entity. If unknown, the tye will be automatically searched with a performance penalty
91 * \return EwErrorCode enum type, can be:
92 * \li EW_NO_ERROR if no error detected
93 * \li EW_UNDEFINED_ERROR if another error occurred
94 * \li EW_INVALID_ID the ID is not associated to any object
95 * \li EW_INVALID_OBJECT if object is not initialized
96 */
97 EwErrorCode setEwObjectID (LONG lID, EwEntity3DType eEntity3DType);
98
99
109
110
111 /*
112 * Suppress the entity3D inside the current project. Changes object type to "suppressed" one.
113 * \return EwErrorCode enum type, can be:
114 * \li EW_NO_ERROR if no error detected
115 * \li EW_UNDEFINED_ERROR if another error occurred
116 * \li EW_INVALID_ID Object type wrong or cannot be suspended.
117 * \li EW_INVALID_OBJECT if object is not initialized
118 */
120
121
122 /*
123 * Resume suppressed entity3D inside the current project. Reverts "suppressed" object type.
124 * \return EwErrorCode enum type, can be:
125 * \li EW_NO_ERROR if no error detected
126 * \li EW_UNDEFINED_ERROR if another error occurred
127 * \li EW_INVALID_ID Object type wrong or object not found.
128 * \li EW_INVALID_OBJECT if object is not initialized
129 */
131
132
133 /*
134 * \return True if the entity has one of suppressed types
135 */
137
138
139 /*
140 * Set the ID of the component in SOLIDWORKS.
141 * param[in] strID ID of the component in SOLIDWORKS
142 * \return EwErrorCode enum type, can be:
143 * \li EW_NO_ERROR if no error detected
144 * \li EW_UNDEFINED_ERROR if another error occurred
145 * \li EW_INVALID_OBJECT if object is not initialized
146 */
147 EwErrorCode setSWID (BSTR strID);
148
149
158 BSTR getSWID (EwErrorCode* errorCode);
159
160
161 /*
162 * Set the Physical ID of the physical product associated on the Platform.
163 * param[in] strID Physical Id of the physical product associated.
164 * \return EwErrorCode enum type, can be:
165 * \li EW_NO_ERROR if no error detected
166 * \li EW_UNDEFINED_ERROR if another error occurred
167 * \li EW_INVALID_OBJECT if object is not initialized
168 */
170
171
180 BSTR getPhysicalID (EwErrorCode* errorCode);
181
182
183};
184
189[
190 object,
191 uuid(d8eb2100-23ba-11e5-b696-feff819cdc9f),
192 dual,
193 oleautomation,
194 nonextensible,
195 helpstring("IEwProjectEntity3DManagerX Interface"),
196 hidden,
197 pointer_default(unique)
198]
199interface IEwProjectEntity3DManagerX : IDispatch{
203 LONG getCount ();
204
205
211
212
222
223
233 IEwProjectEntity3DX findEwProjectEntity3DBy3DID (BSTR strID, LONG lFileID , EwErrorCode* errorCode);
234
235
240
241
253 VARIANT getChildrenEwProjectEntity3DArray (BSTR str3DID, LONG lFileID , EwErrorCode* errorCode);
254
265
266};
EwErrorCode
All errors codes for this API.
Definition: EnumDefinition.idl:24
EwEntity3DType
All Entity 3D types.
Definition: EwEnumeration.idl:311
This interface is a generic interface for standard object methods.
Definition: EwObjectBaseObjects.idl:97
Use this interface to manage EwProjectEntity3D objects.
Definition: EwProjectEntity3DObjects.idl:199
IEwProjectEntity3DX findEwProjectEntity3DByID(long lObjectID, EwErrorCode *errorCode)
return an IEwProjectEntity3DX according to an ID
VARIANT getChildrenEwProjectEntity3DArray(BSTR str3DID, LONG lFileID, EwErrorCode *errorCode)
Get all the IEwProjectEntity3DX which are inserted as components or added as features inside the targ...
VARIANT getEwProjectEntity3DArray(EwErrorCode *errorCode)
return the array of IEwProjectEntity3DX
IEwProjectEntity3DX newEwProjectEntity3D()
Create a IEwProjectEntity3DX object from the associated project.
IEwProjectEntity3DX findEwProjectEntity3DBy3DID(BSTR strID, LONG lFileID, EwErrorCode *errorCode)
Return an IEwProjectEntity3DX according to a 3D ID.
IEwProjectEntity3DX findEwProjectEntity3DByObjectID(long lObjectID, EwEntity3DType eEntity3DType, EwErrorCode *errorCode)
return an IEwProjectEntity3DX according to an object ID
Use this interface to manage an Entity3D inside a project.
Definition: EwProjectEntity3DObjects.idl:29
BSTR getSWID(EwErrorCode *errorCode)
Return the ID of the component in SOLIDWORKS.
EwErrorCode set3DID(BSTR strID)
EwErrorCode setEwObjectID(LONG lID, EwEntity3DType eEntity3DType)
BSTR getPhysicalID(EwErrorCode *errorCode)
Return the physical ID of the physical product associated on the Platform.
LONG getEwProjectFileID(EwErrorCode *errorCode)
return the ID where the object is inserted
EwErrorCode setEwProjectFileID(LONG lFileID)
EwErrorCode setSWID(BSTR strID)
BSTR get3DID(EwErrorCode *errorCode)
return the 3D ID
EwErrorCode setPhysicalID(BSTR strID)
LONG getEwObjectID(EwErrorCode *errorCode)
return the object ID
EwErrorCode resume()
EwErrorCode suppress()
EwEntity3DType getEwEntity3DType(EwErrorCode *errorCode)
return entity type of the entity


Provide feedback on this topic

SOLIDWORKS welcomes your feedback concerning the presentation, accuracy, and thoroughness of the documentation. Use the form below to send your comments and suggestions about this topic directly to our documentation team. The documentation team cannot answer technical support questions. Click here for information about technical support.

* Required

 
*Email:  
Subject:   Feedback on Help Topics
Page:   SOLIDWORKS Electrical API: idl_converted/EwProjectEntity3DObjects.idl Source File
*Comment:  
*   I acknowledge I have read and I hereby accept the privacy policy under which my Personal Data will be used by Dassault Systèmes

Print Topic

Select the scope of content to print:

x

We have detected you are using a browser version older than Internet Explorer 7. For optimized display, we suggest upgrading your browser to Internet Explorer 7 or newer.

 Never show this message again
x

Web Help Content Version: API Help (English only) 2024 SP05

To disable Web help from within SOLIDWORKS and use local help instead, click Help > Use SOLIDWORKS Web Help.

To report problems encountered with the Web help interface and search, contact your local support representative. To provide feedback on individual help topics, use the “Feedback on this topic” link on the individual topic page.