Hide Table of Contents
SOLIDWORKS Electrical API  2022.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 
7 import "oaidl.idl";
8 import "ocidl.idl";
9 
10 import "EnumDefinition.idl";
11 import "EwProjectManufacturerPartObjects.idl";
12 import "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 ]
28 interface IEwProjectEntity3DX : IEwObjectX
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  */
51  EwErrorCode setEwProjectFileID (LONG lFileID);
52 
53 
62  EwEntity3DType getEwEntity3DType (EwErrorCode* errorCode);
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 
108  LONG getEwProjectFileID (EwErrorCode* errorCode);
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  */
119  EwErrorCode suppress ();
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  */
130  EwErrorCode resume ();
131 
132 
133  /*
134  * \return True if the entity has one of suppressed types
135  */
136  BOOL isSuppressed ();
137 
138 };
139 
144 [
145  object,
146  uuid(d8eb2100-23ba-11e5-b696-feff819cdc9f),
147  dual,
148  oleautomation,
149  nonextensible,
150  helpstring("IEwProjectEntity3DManagerX Interface"),
151  hidden,
152  pointer_default(unique)
153 ]
154 interface IEwProjectEntity3DManagerX : IDispatch{
158  LONG getCount ();
159 
160 
165  IEwProjectEntity3DX newEwProjectEntity3D ();
166 
167 
176  IEwProjectEntity3DX findEwProjectEntity3DByID (long lObjectID, EwErrorCode* errorCode);
177 
178 
188  IEwProjectEntity3DX findEwProjectEntity3DBy3DID (BSTR strID, LONG lFileID , EwErrorCode* errorCode);
189 
190 
194  VARIANT getEwProjectEntity3DArray (EwErrorCode* errorCode);
195 
196 
208  VARIANT getChildrenEwProjectEntity3DArray (BSTR str3DID, LONG lFileID , EwErrorCode* errorCode);
209 
210 };
IEwProjectEntity3DX
Use this interface to manage an Entity3D inside a project.
Definition: EwProjectEntity3DObjects.idl:29
IEwProjectEntity3DManagerX
Use this interface to manage EwProjectEntity3D objects.
Definition: EwProjectEntity3DObjects.idl:154
IEwProjectEntity3DX::get3DID
BSTR get3DID(EwErrorCode *errorCode)
return the 3D ID
IEwObjectX
This interface is a generic interface for standard methods.
Definition: EwObjectBase.idl:82
EwErrorCode
EwErrorCode
All errors codes for this API.
Definition: EnumDefinition.idl:21
IEwProjectEntity3DX::getEwObjectID
LONG getEwObjectID(EwErrorCode *errorCode)
return the object ID
IEwProjectEntity3DManagerX::findEwProjectEntity3DBy3DID
IEwProjectEntity3DX findEwProjectEntity3DBy3DID(BSTR strID, LONG lFileID, EwErrorCode *errorCode)
Return an IEwProjectEntity3DX according to a 3D ID.
IEwProjectEntity3DManagerX::newEwProjectEntity3D
IEwProjectEntity3DX newEwProjectEntity3D()
Create a IEwProjectEntity3DX object from the associated project.
IEwProjectEntity3DX::suppress
EwErrorCode suppress()
IEwProjectEntity3DX::getEwProjectFileID
LONG getEwProjectFileID(EwErrorCode *errorCode)
return the ID where the object is inserted
IEwProjectEntity3DManagerX::getEwProjectEntity3DArray
VARIANT getEwProjectEntity3DArray(EwErrorCode *errorCode)
return the array of IEwProjectEntity3DX
EwEntity3DType
EwEntity3DType
All Entity 3D types.
Definition: EwEnumeration.idl:299
IEwProjectEntity3DX::resume
EwErrorCode resume()
IEwProjectEntity3DX::setEwProjectFileID
EwErrorCode setEwProjectFileID(LONG lFileID)
IEwProjectEntity3DX::set3DID
EwErrorCode set3DID(BSTR strID)
IEwProjectEntity3DX::getEwEntity3DType
EwEntity3DType getEwEntity3DType(EwErrorCode *errorCode)
return entity type of the entity
IEwProjectEntity3DManagerX::getChildrenEwProjectEntity3DArray
VARIANT getChildrenEwProjectEntity3DArray(BSTR str3DID, LONG lFileID, EwErrorCode *errorCode)
Get all the IEwProjectEntity3DX which are inserted as components or added as features inside the targ...
IEwProjectEntity3DX::setEwObjectID
EwErrorCode setEwObjectID(LONG lID, EwEntity3DType eEntity3DType)
IEwProjectEntity3DManagerX::findEwProjectEntity3DByID
IEwProjectEntity3DX findEwProjectEntity3DByID(long lObjectID, EwErrorCode *errorCode)
return an IEwProjectEntity3DX according to an object ID
Generated on Wed Aug 18 2021 10:34:10 for SOLIDWORKS Electrical API by   doxygen 1.8.18


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) 2022 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.

0.20.46