Cognex.VisionPro3D.Graphic.xml 53 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247
  1. <?xml version="1.0"?>
  2. <doc>
  3. <assembly>
  4. "Cognex.VisionPro3D.Graphic"
  5. </assembly>
  6. <members>
  7. <member name="P:Cognex.VisionPro3D.Implementation.Internal.ICog3DDisplayV2Impl.DisplayMode">
  8. <summary>
  9. Gets or sets the rendering mode for the display
  10. </summary>
  11. </member>
  12. <member name="P:Cognex.VisionPro3D.Implementation.Internal.ICog3DDisplayV2Impl.CameraUpDirection">
  13. <summary>
  14. Gets the camera's current up direction in the 3D scene's world space name
  15. </summary>
  16. </member>
  17. <member name="P:Cognex.VisionPro3D.Implementation.Internal.ICog3DDisplayV2Impl.CameraTarget">
  18. <summary>
  19. Gets the camera's current target position in the 3D scene's world space name
  20. </summary>
  21. </member>
  22. <member name="P:Cognex.VisionPro3D.Implementation.Internal.ICog3DDisplayV2Impl.CameraPosition">
  23. <summary>
  24. Gets the camera's current position in the 3D scene's world space name
  25. </summary>
  26. </member>
  27. <member name="M:Cognex.VisionPro3D.Implementation.Internal.ICog3DDisplayV2Impl.SetView(Cognex.VisionPro3D.Cog3DVect3,Cognex.VisionPro3D.Cog3DVect3,Cognex.VisionPro3D.Cog3DVect3)">
  28. <summary>
  29. Change the camera's position and look direction in the 3-D space.
  30. </summary>
  31. <param name="position">New position of the camera.</param>
  32. <param name="target">New target the camera is looking at.</param>
  33. <param name="upDirection">New up direction of the camera.</param>
  34. </member>
  35. <member name="E:Cognex.VisionPro3D.Implementation.Internal.ICog3DDisplayV2Impl.MouseCoordinatesChanged">
  36. <summary>
  37. Event is fired when <see cref="P:Cognex.VisionPro3D.Implementation.Internal.ICog3DDisplayV2Impl.MouseCoordinates" /> has changed
  38. </summary>
  39. </member>
  40. <member name="P:Cognex.VisionPro3D.Implementation.Internal.ICog3DDisplayV2Impl.MouseCoordinates">
  41. <summary>
  42. Gets the current mouse coordinates in the 3D scene's world space name
  43. NOTE: if <see cref="P:Cognex.VisionPro3D.Implementation.Internal.ICog3DDisplayV2Impl.MouseCoordinatesTracked" /> has to be set to true to get the current mouse coordinates, otherwise the value is invalid and null.
  44. </summary>
  45. </member>
  46. <member name="P:Cognex.VisionPro3D.Implementation.Internal.ICog3DDisplayV2Impl.MouseCoordinatesTracked">
  47. <summary>
  48. Gets or sets whether the coordinates of the mouse cursor are tracked or not
  49. </summary>
  50. </member>
  51. <member name="M:Cognex.VisionPro3D.Implementation.Internal.ICog3DDisplayV2Impl.SaveAsImage(System.Int32,System.Int32,System.String)">
  52. <summary>
  53. Renders the contents of the display to a PNG with the given resolution.
  54. </summary>
  55. <param name="width">The given width.</param>
  56. <param name="height">The given height.</param>
  57. <param name="height">The path of the PNG file</param>
  58. </member>
  59. <member name="M:Cognex.VisionPro3D.Implementation.Internal.ICog3DDisplayV2Impl.RemoveGraphic(System.Int64)">
  60. <summary>
  61. Removes the Cog3DGraphicBase object from the display
  62. </summary>
  63. <note>
  64. If the graphic is a <see cref="T:Cognex.VisionPro3D.Cog3DVisionDataGraphicBase" /> then all of the dependent <see cref="T:Cognex.VisionPro3D.Cog3DGeometryGraphicBase" /> will be removed too.
  65. </note>
  66. <param name="graphicKey">the key of the graphic to be removed</param>
  67. </member>
  68. <member name="M:Cognex.VisionPro3D.Implementation.Internal.ICog3DDisplayV2Impl.UpdateGeometryGraphic(System.Int64,Cognex.VisionPro3D.Cog3DGeometryGraphicBase,Cognex.VisionPro3D.ICog3DTransform)">
  69. <summary>
  70. Updates the Cog3DGeometryGraphicBase object on the display
  71. </summary>
  72. <param name="graphicKey">the key of the graphic on the display</param>
  73. <param name="geometryGraphic">the Cog3DGeometryGraphicBase to update</param>
  74. <param name="transform">the transofrm to be used on the shape (map the vertices from the selected space name 3d of the shape to the displays displaySpaceName3D)</param>
  75. <param name="transform">the transofrm to be used on the geometry graphics to map the vertices from the SelectedSpaceName3D of the graphic to the display's displaySpaceName3D</param>
  76. </member>
  77. <member name="M:Cognex.VisionPro3D.Implementation.Internal.ICog3DDisplayV2Impl.AddGeometryGraphic(System.Int64,Cognex.VisionPro3D.Cog3DGeometryGraphicBase,Cognex.VisionPro3D.ICog3DTransform)">
  78. <summary>
  79. Adds a Cog3DGeometryGraphicBase to the display
  80. </summary>
  81. <param name="groupKey">the key of the group to add the Cog3DGeometryGraphicBase to</param>
  82. <param name="geometryGraphic">the ICog3DShapeGraphic to add</param>
  83. <param name="transform">the transofrm to be used on the geometry graphics to map the vertices from the SelectedSpaceName3D of the graphic to the display's displaySpaceName3D</param>
  84. <returns>the unique identifier of the graphic in the display</returns>
  85. </member>
  86. <member name="M:Cognex.VisionPro3D.Implementation.Internal.ICog3DDisplayV2Impl.CreateGeometryGraphicsGroup(System.String)">
  87. <summary>
  88. Creates a group for ICog3DShapeGraphic with the given name
  89. </summary>
  90. <param name="groupName">the name of the group</param>
  91. <returns>the unique identifier of the group in the display</returns>
  92. </member>
  93. <member name="M:Cognex.VisionPro3D.Implementation.Internal.ICog3DDisplayV2Impl.DebugDump(System.String)">
  94. <summary>
  95. Saves the content of the screen to the disk for debug purposes
  96. i.e. HOOPS will create HMF files from the model and the view objects that could be examined in HOOPS 3D Viewer
  97. </summary>
  98. <param name="filePostFix">file name postfix to use</param>
  99. </member>
  100. <member name="M:Cognex.VisionPro3D.Implementation.Internal.ICog3DDisplayV2Impl.UpdateVisionDataGraphic(System.Int64,Cognex.VisionPro3D.Cog3DVisionDataGraphicBase,System.String,System.Double,System.Boolean)">
  101. <summary>
  102. Updates the Cog3DVisionDataGraphicBase object on the display
  103. </summary>
  104. <param name="graphicKey">the key of the graphic on the display</param>
  105. <param name="item">the Cog3DVisionDataGraphicBase to update</param>
  106. <param name="displaySpaceName3D">the name of the sapce to be used for rendering</param>
  107. <param name="resolution">the resolution in displaySpaceName3D units to be used for rendering</param>
  108. <param name="updateGeometry">If true, the geometry of the VisionData will be re-rendered</param>
  109. </member>
  110. <member name="M:Cognex.VisionPro3D.Implementation.Internal.ICog3DDisplayV2Impl.AddVisionDataGraphic(System.Int64,Cognex.VisionPro3D.Cog3DVisionDataGraphicBase,System.String,System.Double)">
  111. <summary>
  112. Adds a Cog3DVisionDataGraphicBase to the display
  113. </summary>
  114. <param name="groupKey">the key of the group to add the Cog3DVisionDataGraphicBase to</param>
  115. <param name="item">the Cog3DVisionDataGraphicBase to add</param>
  116. <param name="displaySpaceName3D">the name of the sapce to be used for rendering</param>
  117. <param name="resolution">the resolution in displaySpaceName3D units to be used for rendering</param>
  118. <returns>return the unique identifier of the item on the display</returns>
  119. </member>
  120. <member name="M:Cognex.VisionPro3D.Implementation.Internal.ICog3DDisplayV2Impl.CreateVisionDataGraphicsGroup(System.String)">
  121. <summary>
  122. Creates a group for ICog3DVisionDataGraphic with the given name
  123. </summary>
  124. <param name="groupName">the name of the group</param>
  125. <returns>the unique identifier of the group in the display</returns>
  126. </member>
  127. <member name="P:Cognex.VisionPro3D.Implementation.Internal.ICog3DDisplayV2Impl.IsDrawingEnabled">
  128. <summary>
  129. Returns whether the screen refresh is enabled or not
  130. </summary>
  131. </member>
  132. <member name="M:Cognex.VisionPro3D.Implementation.Internal.ICog3DDisplayV2Impl.EnableDrawing">
  133. <summary>
  134. Enables refreshing the screen
  135. </summary>
  136. </member>
  137. <member name="M:Cognex.VisionPro3D.Implementation.Internal.ICog3DDisplayV2Impl.DisableDrawing">
  138. <summary>
  139. Disables refreshing the screen
  140. </summary>
  141. </member>
  142. <member name="M:Cognex.VisionPro3D.Implementation.Internal.ICog3DDisplayV2Impl.Clear">
  143. <summary>
  144. Clears the content of the screen
  145. </summary>
  146. </member>
  147. <member name="M:Cognex.VisionPro3D.Implementation.Internal.ICog3DDisplayV2Impl.FitView">
  148. <summary>
  149. Zooms in/out to fit all the drawn objects into the view
  150. Does not change the camera's orientation.
  151. </summary>
  152. </member>
  153. <member name="M:Cognex.VisionPro3D.Implementation.Internal.ICog3DDisplayV2Impl.ResetView">
  154. <summary>
  155. Resets the view to the default initial camera position and view direction.
  156. Looking at the scene from the top along the Z axis in a way to fit the whole scene
  157. </summary>
  158. </member>
  159. <member name="M:Cognex.VisionPro3D.Implementation.Internal.ICog3DDisplayV2Impl.Update">
  160. <summary>
  161. Updates the screen. Forces redraw.
  162. </summary>
  163. </member>
  164. <member name="M:Cognex.VisionPro3D.Implementation.Internal.ICog3DDisplayV2Impl.SetBackgroundColor(System.Drawing.Color)">
  165. <summary>
  166. Sets the background color of the display
  167. </summary>
  168. <param name="color">The color to be set</param>
  169. </member>
  170. <member name="T:Cognex.VisionPro3D.Implementation.Internal.ICog3DDisplayV2Impl">
  171. <summary>
  172. This is the interface for the 3D display implementation class. The Cog3DDisplayV2 user control holds
  173. a ICog3DDisplayImpl member that represents the actual 3D engine implementation behind the scenes...
  174. </summary>
  175. </member>
  176. <member name="T:Cognex.VisionPro3D.DisplayModes">
  177. <summary>
  178. This enum defines the available display modes for rendering 3D content
  179. </summary>
  180. </member>
  181. <member name="F:Cognex.VisionPro3D.DisplayModes.Vertices">
  182. <summary>The display will render the vertices of the 3D objects</summary>
  183. </member>
  184. <member name="F:Cognex.VisionPro3D.DisplayModes.Surface">
  185. <summary>The display will render the surfaces of the 3D objects</summary>
  186. </member>
  187. <member name="T:Cognex.VisionPro3D.Cog3DGraphicBuffer">
  188. <summary>
  189. This class is a helper class to initialize the low level 3D graphic buffer
  190. </summary>
  191. </member>
  192. <member name="M:Cognex.VisionPro3D.Cog3DGraphicFactory.CreateMultiple(Cognex.VisionPro.CogVisionDataContainer,System.Boolean)">
  193. <summary>
  194. Creates a list of Cog3DVisionDataGraphicBase graphic wrappers from the CogVisionDataContainer input if it is supported.
  195. In case the input type is not supported, it return null or throws a NotSupportedException
  196. based on the value of the throwIfNotSupported argument.
  197. The following CogVisionDataContainers are supported:
  198. <list type="bullet"><item>
  199. If it is a flat CogVisionDataContainer and all of its entries are <see cref="T:Cognex.VisionPro.CogImage16Range" />.
  200. </item><item>
  201. If its entries are CogVisionDataContainer themselves and each of those elements contains in turn
  202. exactly one <see cref="T:Cognex.VisionPro.CogImage16Range" /> and one <see cref="T:Cognex.VisionPro.CogImage16Grey" />.
  203. </item></list></summary>
  204. </member>
  205. <member name="M:Cognex.VisionPro3D.Cog3DGraphicFactory.Create(Cognex.VisionPro.ICogVisionData,System.Boolean)">
  206. <summary>
  207. Creates a Cog3DVisionDataGraphicBase graphic wrapper from the ICogVisionData input if it is supported.
  208. In case the input type is not supported, it returns null or throws a NotSupportedException
  209. based on the value of the throwIfNotSupported argument.
  210. The following types are supported:
  211. <list type="bullet"><item><see cref="T:Cognex.VisionPro.CogImage16Range" /></item><item><see cref="T:Cognex.VisionPro.CogVisionDataContainer" /> if the followings are true:
  212. <list type="bullet"><item>
  213. It has one or many <see cref="T:Cognex.VisionPro.CogImage16Range" /> entries.
  214. In this case the first one will be used to create a <see cref="T:Cognex.VisionPro3D.Cog3DRangeImageGraphic" /> from it.
  215. </item><item>
  216. It has exactly one <see cref="T:Cognex.VisionPro.CogImage16Range" /> and one <see cref="T:Cognex.VisionPro.CogImage16Grey" />.
  217. In this case the both of them will be used to create a <see cref="T:Cognex.VisionPro3D.Cog3DRangeImageGraphic" /> that has grey overlay set.
  218. </item><item>
  219. The collection contains at least one element that is itself a CogVisionDataContainer, and that element
  220. contains in turn exactly one CogImage16Range and one CogImage16Grey.
  221. In this case the first RangeImage and its grey pair will be used to create a <see cref="T:Cognex.VisionPro3D.Cog3DRangeImageGraphic" /> that has grey overlay set.
  222. </item></list></item></list></summary>
  223. </member>
  224. <member name="T:Cognex.VisionPro3D.Cog3DGraphicFactory">
  225. <summary>
  226. This class is a 3D graphic factory class that can
  227. create the graphic wrapper for ICogVisionData, Shapes, etc.
  228. </summary>
  229. </member>
  230. <member name="M:Cognex.VisionPro3D.Cog3DSphereGraphic.RealEqual(Cognex.VisionPro3D.Cog3DSphereGraphic,Cognex.VisionPro3D.Cog3DSphereGraphic,System.Double)">
  231. <summary>
  232. Compares two Cog3DSphereGraphic for equality.
  233. </summary>
  234. <param name="a">
  235. First instance of a Cog3DSphereGraphic to compare to the other.
  236. </param>
  237. <param name="a">
  238. Second instance of a Cog3DSphereGraphic to compare to the other.
  239. </param>
  240. <param name="epsilon">
  241. Tolerance when comparing number values for equality.
  242. </param>
  243. </member>
  244. <member name="P:Cognex.VisionPro3D.Cog3DSphereGraphic.Shape">
  245. <summary>
  246. Gets the underlying Cog3DSphere object of this graphic.
  247. </summary>
  248. </member>
  249. <member name="M:Cognex.VisionPro3D.Cog3DSphereGraphic.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
  250. <summary>
  251. Serialization constructor for Cog3DSphereGraphic object.
  252. </summary>
  253. <param name="info">
  254. The standard SerializationInfo argument.
  255. </param>
  256. <param name="ctxt">
  257. The standard StreamingContext argument.
  258. </param>
  259. </member>
  260. <member name="M:Cognex.VisionPro3D.Cog3DSphereGraphic.Finalize">
  261. <summary>
  262. Finalize this Cog3DSphereGraphic.
  263. </summary>
  264. </member>
  265. <member name="M:Cognex.VisionPro3D.Cog3DSphereGraphic.Dispose">
  266. <summary>
  267. Destruct this Cog3DSphereGraphic.
  268. </summary>
  269. </member>
  270. <member name="M:Cognex.VisionPro3D.Cog3DSphereGraphic.#ctor(Cognex.VisionPro3D.Cog3DSphereGraphic)">
  271. <summary>
  272. Copy constructor.
  273. </summary>
  274. <param name="other">
  275. The Cog3DSphereGraphic to copy.
  276. </param>
  277. </member>
  278. <member name="M:Cognex.VisionPro3D.Cog3DSphereGraphic.#ctor(Cognex.VisionPro3D.Cog3DSphere)">
  279. <summary>
  280. Constructor that takes <see cref="T:Cognex.VisionPro3D.Cog3DSphere" /> shape.
  281. </summary>
  282. <param name="shape">
  283. The shape to be used in the 3D graphic.
  284. </param>
  285. </member>
  286. <member name="T:Cognex.VisionPro3D.Cog3DSphereGraphic">
  287. <summary>
  288. This class defines a 3D Sphere graphic.
  289. It inherites from the <see cref="T:Cognex.VisionPro3D.Cog3DShapeGraphicBase" /> base class
  290. </summary>
  291. </member>
  292. <member name="M:Cognex.VisionPro3D.Cog3DCircleGraphic.RealEqual(Cognex.VisionPro3D.Cog3DCircleGraphic,Cognex.VisionPro3D.Cog3DCircleGraphic,System.Double)">
  293. <summary>
  294. Compares two Cog3DCircleGraphic for equality.
  295. </summary>
  296. <param name="a">
  297. First instance of a Cog3DCircleGraphic to compare to the other.
  298. </param>
  299. <param name="a">
  300. Second instance of a Cog3DCircleGraphic to compare to the other.
  301. </param>
  302. <param name="epsilon">
  303. Tolerance when comparing number values for equality.
  304. </param>
  305. </member>
  306. <member name="P:Cognex.VisionPro3D.Cog3DCircleGraphic.DisplayState">
  307. <summary>
  308. Gets/sets the DisplayState for this Cog3DCircleGraphic
  309. The default value is Cog3DDisplayStateConstants::WireFrame.
  310. Available values are Surface, SurfaceWithWireFrame and WireFrame
  311. </summary>
  312. <value>
  313. The DisplayState of this graphic object.
  314. </value>
  315. <exception cref="T:System.ArgumentException">
  316. If trying to set to anything other than Surface, SurfaceWithWireFrame or WireFreame
  317. </exception>
  318. <event cref="E:Cognex.VisionPro.ICogChangedEvent.Changed">
  319. <para>Fires when this property changes.</para>
  320. <para>The following state flags may be affected:</para>
  321. <list type="bullet">
  322. <item>SfDisplayState</item>
  323. </list>
  324. </event>
  325. </member>
  326. <member name="P:Cognex.VisionPro3D.Cog3DCircleGraphic.Shape">
  327. <summary>
  328. Gets the underlying Cog3DCircle object of this graphic.
  329. </summary>
  330. </member>
  331. <member name="M:Cognex.VisionPro3D.Cog3DCircleGraphic.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
  332. <summary>
  333. Serialization constructor for Cog3DCircleGraphic object.
  334. </summary>
  335. <param name="info">
  336. The standard SerializationInfo argument.
  337. </param>
  338. <param name="ctxt">
  339. The standard StreamingContext argument.
  340. </param>
  341. </member>
  342. <member name="M:Cognex.VisionPro3D.Cog3DCircleGraphic.Finalize">
  343. <summary>
  344. Finalize this Cog3DCircleGraphic.
  345. </summary>
  346. </member>
  347. <member name="M:Cognex.VisionPro3D.Cog3DCircleGraphic.Dispose">
  348. <summary>
  349. Destruct this Cog3DCircleGraphic.
  350. </summary>
  351. </member>
  352. <member name="M:Cognex.VisionPro3D.Cog3DCircleGraphic.#ctor(Cognex.VisionPro3D.Cog3DCircleGraphic)">
  353. <summary>
  354. Copy constructor.
  355. </summary>
  356. <param name="other">
  357. The Cog3DCircleGraphic to copy.
  358. </param>
  359. </member>
  360. <member name="M:Cognex.VisionPro3D.Cog3DCircleGraphic.#ctor(Cognex.VisionPro3D.Cog3DCircle)">
  361. <summary>
  362. Constructor that takes <see cref="T:Cognex.VisionPro3D.Cog3DCircle" /> shape.
  363. </summary>
  364. <param name="shape">
  365. The shape to be used in the 3D graphic.
  366. </param>
  367. </member>
  368. <member name="T:Cognex.VisionPro3D.Cog3DCircleGraphic">
  369. <summary>
  370. This class defines a 3D Circle graphic.
  371. It inherites from the <see cref="T:Cognex.VisionPro3D.Cog3DShapeGraphicBase" /> base class
  372. </summary>
  373. </member>
  374. <member name="M:Cognex.VisionPro3D.Cog3DPointGraphic.RealEqual(Cognex.VisionPro3D.Cog3DPointGraphic,Cognex.VisionPro3D.Cog3DPointGraphic,System.Double)">
  375. <summary>
  376. Compares two Cog3DPointGraphic for equality.
  377. </summary>
  378. <param name="a">
  379. First instance of a Cog3DPointGraphic to compare to the other.
  380. </param>
  381. <param name="a">
  382. Second instance of a Cog3DPointGraphic to compare to the other.
  383. </param>
  384. <param name="epsilon">
  385. Tolerance when comparing number values for equality.
  386. </param>
  387. </member>
  388. <member name="P:Cognex.VisionPro3D.Cog3DPointGraphic.DisplayState">
  389. <summary>
  390. Gets/sets the DisplayState for the Pointment
  391. The default value is Cog3DDisplayStateConstants::WireFrame and it cannot be changed for this Cog3DPointmentGraphic.
  392. </summary>
  393. <value>
  394. The DisplayState of this graphic object.
  395. </value>
  396. <exception cref="T:System.ArgumentException">
  397. If trying to set to anything other than WireFrame
  398. </exception>
  399. <event cref="E:Cognex.VisionPro.ICogChangedEvent.Changed">
  400. <para>Fires when this property changes.</para>
  401. <para>The following state flags may be affected:</para>
  402. <list type="bullet">
  403. <item>SfDisplayState</item>
  404. </list>
  405. </event>
  406. </member>
  407. <member name="P:Cognex.VisionPro3D.Cog3DPointGraphic.Shape">
  408. <summary>
  409. Gets the underlying Cog3DPoint object of this graphic.
  410. </summary>
  411. </member>
  412. <member name="M:Cognex.VisionPro3D.Cog3DPointGraphic.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
  413. <summary>
  414. Serialization constructor for Cog3DPointGraphic object.
  415. </summary>
  416. <param name="info">
  417. The standard SerializationInfo argument.
  418. </param>
  419. <param name="ctxt">
  420. The standard StreamingContext argument.
  421. </param>
  422. </member>
  423. <member name="M:Cognex.VisionPro3D.Cog3DPointGraphic.Finalize">
  424. <summary>
  425. Finalize this Cog3DPointGraphic.
  426. </summary>
  427. </member>
  428. <member name="M:Cognex.VisionPro3D.Cog3DPointGraphic.Dispose">
  429. <summary>
  430. Destruct this Cog3DPointGraphic.
  431. </summary>
  432. </member>
  433. <member name="M:Cognex.VisionPro3D.Cog3DPointGraphic.#ctor(Cognex.VisionPro3D.Cog3DPointGraphic)">
  434. <summary>
  435. Copy constructor.
  436. </summary>
  437. <param name="other">
  438. The Cog3DPointGraphic to copy.
  439. </param>
  440. </member>
  441. <member name="M:Cognex.VisionPro3D.Cog3DPointGraphic.#ctor(Cognex.VisionPro3D.Cog3DPoint)">
  442. <summary>
  443. Constructor that takes <see cref="T:Cognex.VisionPro3D.Cog3DPoint" /> shape.
  444. </summary>
  445. <param name="shape">
  446. The shape to be used in the 3D graphic.
  447. </param>
  448. </member>
  449. <member name="T:Cognex.VisionPro3D.Cog3DPointGraphic">
  450. <summary>
  451. This class defines a 3D Point graphic.
  452. It inherites from the <see cref="T:Cognex.VisionPro3D.Cog3DShapeGraphicBase" /> base class
  453. </summary>
  454. </member>
  455. <member name="M:Cognex.VisionPro3D.Cog3DRectangleGraphic.RealEqual(Cognex.VisionPro3D.Cog3DRectangleGraphic,Cognex.VisionPro3D.Cog3DRectangleGraphic,System.Double)">
  456. <summary>
  457. Compares two Cog3DRectangleGraphic for equality.
  458. </summary>
  459. <param name="a">
  460. First instance of a Cog3DRectangleGraphic to compare to the other.
  461. </param>
  462. <param name="a">
  463. Second instance of a Cog3DRectangleGraphic to compare to the other.
  464. </param>
  465. <param name="epsilon">
  466. Tolerance when comparing number values for equality.
  467. </param>
  468. </member>
  469. <member name="P:Cognex.VisionPro3D.Cog3DRectangleGraphic.DisplayState">
  470. <summary>
  471. Gets/sets the DisplayState for the Circle
  472. The default value is Cog3DDisplayStateConstants::WireFrame.
  473. Available values are Surface, SurfaceWithWireFrame and WireFrame
  474. </summary>
  475. <value>
  476. The DisplayState of this graphic object.
  477. </value>
  478. <exception cref="T:System.ArgumentException">
  479. If trying to set to anything other than WireFreame, SurfaceWithWireFrame or Surface
  480. </exception>
  481. <event cref="E:Cognex.VisionPro.ICogChangedEvent.Changed">
  482. <para>Fires when this property changes.</para>
  483. <para>The following state flags may be affected:</para>
  484. <list type="bullet">
  485. <item>SfDisplayState</item>
  486. </list>
  487. </event>
  488. </member>
  489. <member name="P:Cognex.VisionPro3D.Cog3DRectangleGraphic.Shape">
  490. <summary>
  491. Gets the underlying Cog3DRectangle object of this graphic.
  492. </summary>
  493. </member>
  494. <member name="M:Cognex.VisionPro3D.Cog3DRectangleGraphic.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
  495. <summary>
  496. Serialization constructor for Cog3DRectangleGraphic object.
  497. </summary>
  498. <param name="info">
  499. The standard SerializationInfo argument.
  500. </param>
  501. <param name="ctxt">
  502. The standard StreamingContext argument.
  503. </param>
  504. </member>
  505. <member name="M:Cognex.VisionPro3D.Cog3DRectangleGraphic.Finalize">
  506. <summary>
  507. Finalize this Cog3DRectangleGraphic.
  508. </summary>
  509. </member>
  510. <member name="M:Cognex.VisionPro3D.Cog3DRectangleGraphic.Dispose">
  511. <summary>
  512. Destruct this Cog3DRectangleGraphic.
  513. </summary>
  514. </member>
  515. <member name="M:Cognex.VisionPro3D.Cog3DRectangleGraphic.#ctor(Cognex.VisionPro3D.Cog3DRectangleGraphic)">
  516. <summary>
  517. Copy constructor.
  518. </summary>
  519. <param name="other">
  520. The Cog3DRectangleGraphic to copy.
  521. </param>
  522. </member>
  523. <member name="M:Cognex.VisionPro3D.Cog3DRectangleGraphic.#ctor(Cognex.VisionPro3D.Cog3DRectangle)">
  524. <summary>
  525. Constructor that takes <see cref="T:Cognex.VisionPro3D.Cog3DRectangle" /> shape.
  526. </summary>
  527. <param name="shape">
  528. The shape to be used in the 3D graphic.
  529. </param>
  530. </member>
  531. <member name="T:Cognex.VisionPro3D.Cog3DRectangleGraphic">
  532. <summary>
  533. This class defines a 3D Rectangle graphic.
  534. It inherites from the <see cref="T:Cognex.VisionPro3D.Cog3DShapeGraphicBase" /> base class
  535. </summary>
  536. </member>
  537. <member name="M:Cognex.VisionPro3D.Cog3DLineSegGraphic.RealEqual(Cognex.VisionPro3D.Cog3DLineSegGraphic,Cognex.VisionPro3D.Cog3DLineSegGraphic,System.Double)">
  538. <summary>
  539. Compares two Cog3DLineSegGraphic for equality.
  540. </summary>
  541. <param name="a">
  542. First instance of a Cog3DLineSegGraphic to compare to the other.
  543. </param>
  544. <param name="a">
  545. Second instance of a Cog3DLineSegGraphic to compare to the other.
  546. </param>
  547. <param name="epsilon">
  548. Tolerance when comparing number values for equality.
  549. </param>
  550. </member>
  551. <member name="P:Cognex.VisionPro3D.Cog3DLineSegGraphic.DisplayState">
  552. <summary>
  553. Gets/sets the DisplayState for the LineSegment
  554. The default value is Cog3DDisplayStateConstants::WireFrame and it cannot be changed for this Cog3DLineSegmentGraphic.
  555. </summary>
  556. <value>
  557. The DisplayState of this graphic object.
  558. </value>
  559. <exception cref="T:System.ArgumentException">
  560. If trying to set to anything other than WireFrame
  561. </exception>
  562. <event cref="E:Cognex.VisionPro.ICogChangedEvent.Changed">
  563. <para>Fires when this property changes.</para>
  564. <para>The following state flags may be affected:</para>
  565. <list type="bullet">
  566. <item>SfDisplayState</item>
  567. </list>
  568. </event>
  569. </member>
  570. <member name="P:Cognex.VisionPro3D.Cog3DLineSegGraphic.Shape">
  571. <summary>
  572. Gets the underlying Cog3DLineSeg object of this graphic.
  573. </summary>
  574. </member>
  575. <member name="M:Cognex.VisionPro3D.Cog3DLineSegGraphic.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
  576. <summary>
  577. Serialization constructor for Cog3DLineSegGraphic object.
  578. </summary>
  579. <param name="info">
  580. The standard SerializationInfo argument.
  581. </param>
  582. <param name="ctxt">
  583. The standard StreamingContext argument.
  584. </param>
  585. </member>
  586. <member name="M:Cognex.VisionPro3D.Cog3DLineSegGraphic.Finalize">
  587. <summary>
  588. Finalize this Cog3DLineSegGraphic.
  589. </summary>
  590. </member>
  591. <member name="M:Cognex.VisionPro3D.Cog3DLineSegGraphic.Dispose">
  592. <summary>
  593. Destruct this Cog3DLineSegGraphic.
  594. </summary>
  595. </member>
  596. <member name="M:Cognex.VisionPro3D.Cog3DLineSegGraphic.#ctor(Cognex.VisionPro3D.Cog3DLineSegGraphic)">
  597. <summary>
  598. Copy constructor.
  599. </summary>
  600. <param name="other">
  601. The Cog3DLineSegGraphic to copy.
  602. </param>
  603. </member>
  604. <member name="M:Cognex.VisionPro3D.Cog3DLineSegGraphic.#ctor(Cognex.VisionPro3D.Cog3DLineSeg)">
  605. <summary>
  606. Constructor that takes <see cref="T:Cognex.VisionPro3D.Cog3DLineSeg" /> shape.
  607. </summary>
  608. <param name="shape">
  609. The shape to be used in the 3D graphic.
  610. </param>
  611. </member>
  612. <member name="T:Cognex.VisionPro3D.Cog3DLineSegGraphic">
  613. <summary>
  614. This class defines a 3D LineSeg graphic.
  615. It inherites from the <see cref="T:Cognex.VisionPro3D.Cog3DShapeGraphicBase" /> base class
  616. </summary>
  617. </member>
  618. <member name="M:Cognex.VisionPro3D.Cog3DBoxGraphic.RealEqual(Cognex.VisionPro3D.Cog3DBoxGraphic,Cognex.VisionPro3D.Cog3DBoxGraphic,System.Double)">
  619. <summary>
  620. Compares two Cog3DBoxGraphic for equality.
  621. </summary>
  622. <param name="a">
  623. First instance of a Cog3DBoxGraphic to compare to the other.
  624. </param>
  625. <param name="a">
  626. Second instance of a Cog3DBoxGraphic to compare to the other.
  627. </param>
  628. <param name="epsilon">
  629. Tolerance when comparing number values for equality.
  630. </param>
  631. </member>
  632. <member name="P:Cognex.VisionPro3D.Cog3DBoxGraphic.Shape">
  633. <summary>
  634. Gets the underlying Cog3DBox object of this graphic.
  635. </summary>
  636. </member>
  637. <member name="M:Cognex.VisionPro3D.Cog3DBoxGraphic.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
  638. <summary>
  639. Serialization constructor for Cog3DBoxGraphic object.
  640. </summary>
  641. <param name="info">
  642. The standard SerializationInfo argument.
  643. </param>
  644. <param name="ctxt">
  645. The standard StreamingContext argument.
  646. </param>
  647. </member>
  648. <member name="M:Cognex.VisionPro3D.Cog3DBoxGraphic.Finalize">
  649. <summary>
  650. Finalize this Cog3DBoxGraphic.
  651. </summary>
  652. </member>
  653. <member name="M:Cognex.VisionPro3D.Cog3DBoxGraphic.Dispose">
  654. <summary>
  655. Destruct this Cog3DBoxGraphic.
  656. </summary>
  657. </member>
  658. <member name="M:Cognex.VisionPro3D.Cog3DBoxGraphic.#ctor(Cognex.VisionPro3D.Cog3DBoxGraphic)">
  659. <summary>
  660. Copy constructor.
  661. </summary>
  662. <param name="other">
  663. The Cog3DBoxGraphic to copy.
  664. </param>
  665. </member>
  666. <member name="M:Cognex.VisionPro3D.Cog3DBoxGraphic.#ctor(Cognex.VisionPro3D.Cog3DBox)">
  667. <summary>
  668. Constructor that takes <see cref="T:Cognex.VisionPro3D.Cog3DBox" /> shape.
  669. </summary>
  670. <param name="shape">
  671. The shape to be used in the 3D graphic.
  672. </param>
  673. </member>
  674. <member name="T:Cognex.VisionPro3D.Cog3DBoxGraphic">
  675. <summary>
  676. This class defines a 3D box graphic.
  677. It inherites from the <see cref="T:Cognex.VisionPro3D.Cog3DShapeGraphicBase" /> base class
  678. </summary>
  679. </member>
  680. <member name="P:Cognex.VisionPro3D.Cog3DShapeGraphicBase.SelectedSpaceName3D">
  681. <summary>
  682. Gets or sets the name of the three dimensional
  683. coordinate space of the underlying shape of this graphic.
  684. </summary>
  685. <event cref="E:Cognex.VisionPro.ICogChangedEvent.Changed">
  686. Fires when this property changes.
  687. </event>
  688. </member>
  689. <member name="P:Cognex.VisionPro3D.Cog3DShapeGraphicBase.ShapeBase">
  690. <summary>
  691. Gets the underlying Cog3DShapeBase object of this graphic.
  692. </summary>
  693. </member>
  694. <member name="P:Cognex.VisionPro3D.Cog3DShapeGraphicBase.DisplayState">
  695. <summary>
  696. Gets/sets the DisplayState for this graphic object.
  697. The default value is Cog3DDisplayStateConstants::DisplayDefault.
  698. It can be used to force an object to be always rendered as WireFrame or Vertices regardless of what the display settings are for rendering.
  699. </summary>
  700. <value>
  701. The DisplayState of this graphic object.
  702. </value>
  703. <exception cref="T:System.ArgumentException">
  704. If setting the DisplayState to anything other than Surface, SurfaceWithWireFrame, WireFreame
  705. DisplayState of a Cog3DShapeGeometryGraphic cannot be set to DisplayDefault or Vertices.
  706. The individual derived classes may override this restriction.
  707. </exception>
  708. <event cref="E:Cognex.VisionPro.ICogChangedEvent.Changed">
  709. <para>Fires when this property changes.</para>
  710. <para>The following state flags may be affected:</para>
  711. <list type="bullet">
  712. <item>SfDisplayState</item>
  713. </list>
  714. </event>
  715. </member>
  716. <member name="M:Cognex.VisionPro3D.Cog3DShapeGraphicBase.RealEqual(Cognex.VisionPro3D.Cog3DShapeGraphicBase,Cognex.VisionPro3D.Cog3DShapeGraphicBase,System.Double)">
  717. <summary>
  718. Compares two Cog3DShapeGraphicBase for equality.
  719. </summary>
  720. <param name="a">
  721. First instance of a Cog3DShapeGraphicBase to compare to the other.
  722. </param>
  723. <param name="a">
  724. Second instance of a Cog3DShapeGraphicBase to compare to the other.
  725. </param>
  726. <param name="epsilon">
  727. Tolerance when comparing number values for equality.
  728. </param>
  729. </member>
  730. <member name="M:Cognex.VisionPro3D.Cog3DShapeGraphicBase.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
  731. <summary>
  732. Serialization constructor for Cog3DGraphicBase object.
  733. </summary>
  734. <param name="info">
  735. The standard SerializationInfo argument.
  736. </param>
  737. <param name="ctxt">
  738. The standard StreamingContext argument.
  739. </param>
  740. </member>
  741. <member name="M:Cognex.VisionPro3D.Cog3DShapeGraphicBase.Finalize">
  742. <summary>
  743. Finalize this Cog3DShapeGraphicBase.
  744. </summary>
  745. </member>
  746. <member name="M:Cognex.VisionPro3D.Cog3DShapeGraphicBase.Dispose">
  747. <summary>
  748. Destruct this Cog3DShapeGraphicBase.
  749. </summary>
  750. </member>
  751. <member name="M:Cognex.VisionPro3D.Cog3DShapeGraphicBase.#ctor(Cognex.VisionPro3D.Cog3DShapeGraphicBase)">
  752. <summary>
  753. Copy constructor.
  754. </summary>
  755. <param name="other">
  756. The Cog3DShapeGraphicBase to copy.
  757. </param>
  758. </member>
  759. <member name="M:Cognex.VisionPro3D.Cog3DShapeGraphicBase.#ctor(Cognex.VisionPro3D.Cog3DShapeBase,Cognex.VisionPro3D.Cog3DGraphicDisplayStateConstants)">
  760. <summary>
  761. Constructor
  762. </summary>
  763. </member>
  764. <member name="T:Cognex.VisionPro3D.Cog3DShapeGraphicBase">
  765. <summary>
  766. This file defines the base class 3D ShapeGraphic Base objects
  767. It inherits from <see cref="T:Cognex.VisionPro3D.Cog3DGraphicBase" /> class
  768. </summary>
  769. </member>
  770. <member name="P:Cognex.VisionPro3D.Cog3DGeometryGraphicBase.SelectedSpaceName3D">
  771. <summary>
  772. Gets or sets the name of the three dimensional
  773. coordinate space to be used by tools which process this geometry graphic.
  774. </summary>
  775. <event cref="E:Cognex.VisionPro.ICogChangedEvent.Changed">
  776. Fires when this property changes.
  777. </event>
  778. </member>
  779. <member name="P:Cognex.VisionPro3D.Cog3DGeometryGraphicBase.DisplayState">
  780. <summary>
  781. Gets/sets the DisplayState for this geometry graphic object.
  782. </summary>
  783. <value>
  784. The DisplayState of this geometry graphic object.
  785. </value>
  786. <exception cref="T:System.ArgumentException">
  787. If a DisplayState is set to anything other than Surface, SurfaceWithWireFrame, WireFrame or Vertices
  788. DisplayState of a Cog3DGeometryGraphic by default cannot be set to DisplayDefault
  789. The individual derived classes may override this restriction
  790. </exception>
  791. <event cref="E:Cognex.VisionPro.ICogChangedEvent.Changed">
  792. <para>Fires when this property changes.</para>
  793. <para>The following state flags may be affected:</para>
  794. <list type="bullet">
  795. <item>SfDisplayState</item>
  796. </list>
  797. </event>
  798. </member>
  799. <member name="M:Cognex.VisionPro3D.Cog3DGeometryGraphicBase.RealEqual(Cognex.VisionPro3D.Cog3DGeometryGraphicBase,Cognex.VisionPro3D.Cog3DGeometryGraphicBase,System.Double)">
  800. <summary>
  801. Compares two Cog3DGeometryGraphicBase for equality.
  802. </summary>
  803. <param name="a">
  804. First instance of a Cog3DGeometryGraphicBase to compare to the other.
  805. </param>
  806. <param name="a">
  807. Second instance of a Cog3DGeometryGraphicBase to compare to the other.
  808. </param>
  809. <param name="epsilon">
  810. Tolerance when comparing number values for equality.
  811. </param>
  812. </member>
  813. <member name="M:Cognex.VisionPro3D.Cog3DGeometryGraphicBase.fireGeometryChangedEvent(System.Int64)">
  814. <summary>
  815. fire the GeometryChanged event with the approproate stateflag coming from the real geometry object
  816. </summary>
  817. </member>
  818. <member name="M:Cognex.VisionPro3D.Cog3DGeometryGraphicBase.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
  819. <summary>
  820. Serialization constructor for Cog3DGeometryGraphicBase object.
  821. </summary>
  822. <param name="info">
  823. The standard SerializationInfo argument.
  824. </param>
  825. <param name="ctxt">
  826. The standard StreamingContext argument.
  827. </param>
  828. </member>
  829. <member name="M:Cognex.VisionPro3D.Cog3DGeometryGraphicBase.Finalize">
  830. <summary>
  831. Finalize this Cog3DGeometryGraphicBase.
  832. </summary>
  833. </member>
  834. <member name="M:Cognex.VisionPro3D.Cog3DGeometryGraphicBase.Dispose">
  835. <summary>
  836. Destruct this Cog3DGeometryGraphicBase.
  837. </summary>
  838. </member>
  839. <member name="M:Cognex.VisionPro3D.Cog3DGeometryGraphicBase.#ctor(Cognex.VisionPro3D.Cog3DGeometryGraphicBase)">
  840. <summary>
  841. Copy constructor.
  842. </summary>
  843. <param name="other">
  844. The Cog3DGeometryGraphicBase instance to copy.
  845. </param>
  846. <exception cref="T:System.ArgumentException">
  847. If <paramref name="other" /> is diposed.
  848. </exception>
  849. </member>
  850. <member name="M:Cognex.VisionPro3D.Cog3DGeometryGraphicBase.#ctor(Cognex.VisionPro.CogColorConstants,Cognex.VisionPro3D.Cog3DGraphicDisplayStateConstants)">
  851. <summary>
  852. Default constructor.
  853. </summary>
  854. <param name="color">
  855. The default color of the graphic object.
  856. </param>
  857. <param name="displayState">
  858. The default display state of the graphic object.
  859. </param>
  860. </member>
  861. <member name="T:Cognex.VisionPro3D.Cog3DGeometryGraphicBase">
  862. <summary>
  863. This abstarct base class is used to specify common properties of 3D geometry related graphic objects.
  864. </summary>
  865. </member>
  866. <member name="P:Cognex.VisionPro3D.Cog3DRangeImageGraphic.ShowGreyImage">
  867. <summary>
  868. Gets/sets whether the grey data should be shown during rendering for coloring the object
  869. The default value is true. NOTE: only has an effect when the GreyImage is available
  870. </summary>
  871. <event cref="E:Cognex.VisionPro.ICogChangedEvent.Changed">
  872. <para>Fires when this property changes.</para>
  873. <para>The following state flags may be affected:</para>
  874. <list type="bullet">
  875. <item> SfShowGreyImage</item>
  876. </list>
  877. </event>
  878. </member>
  879. <member name="P:Cognex.VisionPro3D.Cog3DRangeImageGraphic.RangeWithGrey">
  880. <summary>
  881. Returns whether the grey data is available with the RangeImage constructor.
  882. </summary>
  883. </member>
  884. <member name="P:Cognex.VisionPro3D.Cog3DRangeImageGraphic.GreyImage">
  885. <summary>
  886. Gets the grey-scale pair of the range image (if available)
  887. </summary>
  888. </member>
  889. <member name="P:Cognex.VisionPro3D.Cog3DRangeImageGraphic.RangeImage">
  890. <summary>
  891. Gets the RangeImage object of the Cog3DGraphicImage16Range object
  892. </summary>
  893. </member>
  894. <member name="M:Cognex.VisionPro3D.Cog3DRangeImageGraphic.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
  895. <summary>
  896. Serialization constructor for Cog3DGraphicImage16Range object.
  897. </summary>
  898. <param name="info">
  899. The standard SerializationInfo argument.
  900. </param>
  901. <param name="ctxt">
  902. The standard StreamingContext argument.
  903. </param>
  904. </member>
  905. <member name="M:Cognex.VisionPro3D.Cog3DRangeImageGraphic.Finalize">
  906. <summary>
  907. Finalize this Cog3DRangeImageGraphic.
  908. </summary>
  909. </member>
  910. <member name="M:Cognex.VisionPro3D.Cog3DRangeImageGraphic.Dispose">
  911. <summary>
  912. Destruct this Cog3DGraphicImage16Range.
  913. </summary>
  914. </member>
  915. <member name="M:Cognex.VisionPro3D.Cog3DRangeImageGraphic.#ctor(Cognex.VisionPro3D.Cog3DRangeImageGraphic)">
  916. <summary>
  917. Copy constructor.
  918. </summary>
  919. <param name="other">
  920. The Cog3DRangeImageGraphic to copy.
  921. </param>
  922. </member>
  923. <member name="M:Cognex.VisionPro3D.Cog3DRangeImageGraphic.#ctor(Cognex.VisionPro.CogImage16Range,Cognex.VisionPro.CogImage16Grey)">
  924. <summary>
  925. Constructor that takes a CogImage16Range and a CogImage16Grey pair
  926. </summary>
  927. <param name="rangeImage">
  928. The CogImage16Range to be used as 3D Graphic. It cannot be null.
  929. </param>
  930. <param name="greyImage">
  931. The CogImage16Grey pair of the RangeImage. It cannot be null and
  932. has to have the same dimensions (width, height) as the RangeImage
  933. </param>
  934. </member>
  935. <member name="M:Cognex.VisionPro3D.Cog3DRangeImageGraphic.#ctor(Cognex.VisionPro.CogImage16Range)">
  936. <summary>
  937. Constructor that takes a CogImage16Range. This RangeImage will be handled as one that does not have grey data in it.
  938. </summary>
  939. <param name="rangeImage">
  940. The Cog3DRangeImageGraphic to be used as 3D Graphic.
  941. </param>
  942. </member>
  943. <member name="T:Cognex.VisionPro3D.Cog3DRangeImageGraphic">
  944. <summary>
  945. This class defines a RangeImage 3D graphic.
  946. It inherits from <see cref="T:Cognex.VisionPro3D.Cog3DVisionDataGraphicBase" /> class
  947. </summary>
  948. </member>
  949. <member name="M:Cognex.VisionPro3D.Cog3DVisionDataGraphicBase.fireCoordinateSpaceTree3DEvent">
  950. <summary>
  951. Common flags corresponding with properties of a 3D graphic changed
  952. </summary>
  953. </member>
  954. <member name="M:Cognex.VisionPro3D.Cog3DVisionDataGraphicBase.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
  955. <summary>
  956. Serialization constructor for Cog3DGraphicBase object.
  957. </summary>
  958. <param name="info">
  959. The standard SerializationInfo argument.
  960. </param>
  961. <param name="ctxt">
  962. The standard StreamingContext argument.
  963. </param>
  964. </member>
  965. <member name="P:Cognex.VisionPro3D.Cog3DVisionDataGraphicBase.VisionData">
  966. <summary>
  967. Gets the underlying ICogVisionData of the VisionDataGraphic object
  968. </summary>
  969. </member>
  970. <member name="P:Cognex.VisionPro3D.Cog3DVisionDataGraphicBase.CoordinateSpaceTree3D">
  971. <summary>
  972. Gets the 3D Coordinate Space Tree of the VisionDataGraphic object
  973. </summary>
  974. </member>
  975. <member name="M:Cognex.VisionPro3D.Cog3DVisionDataGraphicBase.Finalize">
  976. <summary>
  977. Finalize this Cog3DVisionDataGraphicBase.
  978. </summary>
  979. </member>
  980. <member name="M:Cognex.VisionPro3D.Cog3DVisionDataGraphicBase.Dispose">
  981. <summary>
  982. Destruct this Cog3DVisionDataGraphicBase.
  983. </summary>
  984. </member>
  985. <member name="M:Cognex.VisionPro3D.Cog3DVisionDataGraphicBase.#ctor(Cognex.VisionPro3D.Cog3DVisionDataGraphicBase)">
  986. <summary>
  987. Copy constructor.
  988. </summary>
  989. <param name="other">
  990. The Cog3DVisionDataGraphicBase to copy.
  991. </param>
  992. </member>
  993. <member name="M:Cognex.VisionPro3D.Cog3DVisionDataGraphicBase.#ctor(Cognex.VisionPro.ICogVisionData)">
  994. <summary>
  995. Constructor
  996. </summary>
  997. </member>
  998. <member name="E:Cognex.VisionPro3D.Cog3DVisionDataGraphicBase.CoordinateSpaceTree3DChanged">
  999. <summary>
  1000. Event if fired when the 3D coordinate space tree of the VisionData has changed,
  1001. or a change happened within the tree itself
  1002. </summary>
  1003. </member>
  1004. <member name="T:Cognex.VisionPro3D.Cog3DVisionDataGraphicBase">
  1005. <summary>
  1006. This file defines the base class 3D VisionDataGraphic objects
  1007. It inherits from <see cref="T:Cognex.VisionPro3D.Cog3DGraphicBase" /> class
  1008. </summary>
  1009. </member>
  1010. <member name="P:Cognex.VisionPro3D.Cog3DGraphicBase.DisplayState">
  1011. <summary>
  1012. Gets/sets the DisplayState for this graphic object.
  1013. It can be used to force an object to be always rendered as WireFrame or Vertices regardless of what the display settings are for rendering.
  1014. </summary>
  1015. <value>
  1016. The DisplayState of this graphic object.
  1017. </value>
  1018. <exception cref="T:System.ArgumentException">
  1019. If a DisplayState other than DisplayDefault, Surface, SurfaceWithWireFrame, WireFreame or Vertices
  1020. </exception>
  1021. <event cref="E:Cognex.VisionPro.ICogChangedEvent.Changed">
  1022. <para>Fires when this property changes.</para>
  1023. <para>The following state flags may be affected:</para>
  1024. <list type="bullet">
  1025. <item>SfDisplayState</item>
  1026. </list>
  1027. </event>
  1028. </member>
  1029. <member name="P:Cognex.VisionPro3D.Cog3DGraphicBase.MarkerSize">
  1030. <summary>
  1031. Gets/sets the MarkerSize for this graphic object in screen units.
  1032. Applies only if rendered as vertices
  1033. The default value is 1.0.
  1034. </summary>
  1035. <value>
  1036. The MarkerSize of this graphic object in screen units.
  1037. </value>
  1038. <exception cref="T:System.ArgumentException">
  1039. The MarkerSize for graphic objects must be greaer than 0.
  1040. </exception>
  1041. <event cref="E:Cognex.VisionPro.ICogChangedEvent.Changed">
  1042. <para>Fires when this property changes.</para>
  1043. <para>The following state flags may be affected:</para>
  1044. <list type="bullet">
  1045. <item>SfMarkerSize</item>
  1046. </list>
  1047. </event>
  1048. </member>
  1049. <member name="P:Cognex.VisionPro3D.Cog3DGraphicBase.LineWidth">
  1050. <summary>
  1051. Gets/sets the LineWidth for this graphic object in screen units.
  1052. Applies only if rendered as WireFrame or SurfaceWithWireFrame.
  1053. The default value is 1.
  1054. </summary>
  1055. <value>
  1056. The LineWidth of this graphic object in screen units.
  1057. </value>
  1058. <exception cref="T:System.ArgumentException">
  1059. The LineWidth for graphic objects must be greater or equal 1.
  1060. </exception>
  1061. <event cref="E:Cognex.VisionPro.ICogChangedEvent.Changed">
  1062. <para>Fires when this property changes.</para>
  1063. <para>The following state flags may be affected:</para>
  1064. <list type="bullet">
  1065. <item> SfLineWidth </item>
  1066. </list>
  1067. </event>
  1068. </member>
  1069. <member name="P:Cognex.VisionPro3D.Cog3DGraphicBase.Visible">
  1070. <summary>
  1071. Gets/sets the Visibility for this graphic object.
  1072. The default value is true.
  1073. </summary>
  1074. <value>
  1075. The Visibility of this graphic object.
  1076. </value>
  1077. <event cref="E:Cognex.VisionPro.ICogChangedEvent.Changed">
  1078. <para>Fires when this property changes.</para>
  1079. <para>The following state flags may be affected:</para>
  1080. <list type="bullet">
  1081. <item> SfVisible </item>
  1082. </list>
  1083. </event>
  1084. </member>
  1085. <member name="P:Cognex.VisionPro3D.Cog3DGraphicBase.Opacity">
  1086. <summary>
  1087. Gets/sets the Opacity for this graphic object.
  1088. The value range is 0.0 - 1.0, where 0.0 means full transparent
  1089. and value 1.0 means full opaque.
  1090. The default value is 1.0.
  1091. </summary>
  1092. <value>
  1093. The Opacity of this graphic object. Must be between 0 and 1.
  1094. </value>
  1095. <exception cref="T:System.ArgumentException">
  1096. The Opacity for graphic objects must be between 0 and 1.
  1097. </exception>
  1098. <event cref="E:Cognex.VisionPro.ICogChangedEvent.Changed">
  1099. <para>Fires when this property changes.</para>
  1100. <para>The following state flags may be affected:</para>
  1101. <list type="bullet">
  1102. <item> SfOpacity </item>
  1103. </list>
  1104. </event>
  1105. </member>
  1106. <member name="P:Cognex.VisionPro3D.Cog3DGraphicBase.Color">
  1107. <summary>
  1108. Gets/sets the Color for this graphic object.
  1109. </summary>
  1110. <value>
  1111. The Color of this craphic object.
  1112. </value>
  1113. <exception cref="T:System.ArgumentException">
  1114. Color cannot be set to CogColorConstants::None
  1115. </exception>
  1116. <event cref="E:Cognex.VisionPro.ICogChangedEvent.Changed">
  1117. <para>Fires when this property changes.</para>
  1118. <para>The following state flags may be affected:</para>
  1119. <list type="bullet">
  1120. <item> SfColor </item>
  1121. </list>
  1122. </event>
  1123. </member>
  1124. <member name="M:Cognex.VisionPro3D.Cog3DGraphicBase.RealEqual(Cognex.VisionPro3D.Cog3DGraphicBase,Cognex.VisionPro3D.Cog3DGraphicBase,System.Double)">
  1125. <summary>
  1126. Compares two Cog3DGraphicBase for equality.
  1127. </summary>
  1128. <param name="a">
  1129. First instance of a Cog3DGraphicBase to compare to the other.
  1130. </param>
  1131. <param name="a">
  1132. Second instance of a Cog3DGraphicBase to compare to the other.
  1133. </param>
  1134. <param name="epsilon">
  1135. Tolerance when comparing number values for equality.
  1136. </param>
  1137. </member>
  1138. <member name="M:Cognex.VisionPro3D.Cog3DGraphicBase.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
  1139. <summary>
  1140. Serialization constructor for Cog3DGraphicBase object.
  1141. </summary>
  1142. <param name="info">
  1143. The standard SerializationInfo argument.
  1144. </param>
  1145. <param name="ctxt">
  1146. The standard StreamingContext argument.
  1147. </param>
  1148. </member>
  1149. <member name="M:Cognex.VisionPro3D.Cog3DGraphicBase.Finalize">
  1150. <summary>
  1151. Finalize this Cog3DGraphicBase.
  1152. </summary>
  1153. </member>
  1154. <member name="M:Cognex.VisionPro3D.Cog3DGraphicBase.Dispose">
  1155. <summary>
  1156. Destruct this Cog3DGraphicBase.
  1157. </summary>
  1158. </member>
  1159. <member name="M:Cognex.VisionPro3D.Cog3DGraphicBase.#ctor(Cognex.VisionPro3D.Cog3DGraphicBase)">
  1160. <summary>
  1161. Copy constructor.
  1162. </summary>
  1163. <param name="other">
  1164. The Cog3DGraphicBase instance to copy.
  1165. </param>
  1166. <exception cref="T:System.ArgumentNullException">
  1167. If <paramref name="other" /> is null.
  1168. </exception>
  1169. <exception cref="T:System.ArgumentException">
  1170. If <paramref name="other" /> is diposed.
  1171. </exception>
  1172. </member>
  1173. <member name="M:Cognex.VisionPro3D.Cog3DGraphicBase.#ctor(Cognex.VisionPro.CogColorConstants,Cognex.VisionPro3D.Cog3DGraphicDisplayStateConstants)">
  1174. <summary>
  1175. Default constructor.
  1176. </summary>
  1177. <param name="color">
  1178. The default color of the graphic object.
  1179. </param>
  1180. <param name="displayState">
  1181. The default display state of the graphic object.
  1182. </param>
  1183. </member>
  1184. <member name="F:Cognex.VisionPro3D.Cog3DGraphicBase.SfDisplayState">
  1185. <summary>
  1186. This bit will be set in the EventArgs of a Changed event every time
  1187. the value returned by DisplayState may have changed.
  1188. </summary>
  1189. </member>
  1190. <member name="F:Cognex.VisionPro3D.Cog3DGraphicBase.SfMarkerSize">
  1191. <summary>
  1192. This bit will be set in the EventArgs of a Changed event every time
  1193. the value returned by MarkerSize may have changed.
  1194. </summary>
  1195. </member>
  1196. <member name="F:Cognex.VisionPro3D.Cog3DGraphicBase.SfLineWidth">
  1197. <summary>
  1198. This bit will be set in the EventArgs of a Changed event every time
  1199. the value returned by LineWidth may have changed.
  1200. </summary>
  1201. </member>
  1202. <member name="F:Cognex.VisionPro3D.Cog3DGraphicBase.SfVisible">
  1203. <summary>
  1204. This bit will be set in the EventArgs of a Changed event every time
  1205. the value returned by Visible may have changed.
  1206. </summary>
  1207. </member>
  1208. <member name="F:Cognex.VisionPro3D.Cog3DGraphicBase.SfOpacity">
  1209. <summary>
  1210. This bit will be set in the EventArgs of a Changed event every time
  1211. the value returned by Opacity may have changed.
  1212. </summary>
  1213. </member>
  1214. <member name="F:Cognex.VisionPro3D.Cog3DGraphicBase.SfColor">
  1215. <summary>
  1216. This bit will be set in the EventArgs of a Changed event every time
  1217. the value returned by Color may have changed.
  1218. </summary>
  1219. </member>
  1220. <member name="T:Cognex.VisionPro3D.Cog3DGraphicBase">
  1221. <summary>
  1222. This file defines the base class for 3D graphics objects
  1223. </summary>
  1224. </member>
  1225. <member name="T:Cognex.VisionPro3D.Cog3DGraphicDisplayStateConstants">
  1226. <summary>
  1227. This enum defines the available display states for 3D graphics.
  1228. The graphic's display state defines the way of rendering of a 3D graphics.
  1229. </summary>
  1230. </member>
  1231. <member name="F:Cognex.VisionPro3D.Cog3DGraphicDisplayStateConstants.Vertices">
  1232. <summary>The graphic's vertices will always be rendered</summary>
  1233. </member>
  1234. <member name="F:Cognex.VisionPro3D.Cog3DGraphicDisplayStateConstants.WireFrame">
  1235. <summary>The graphic's wireframe will always be rendered</summary>
  1236. </member>
  1237. <member name="F:Cognex.VisionPro3D.Cog3DGraphicDisplayStateConstants.SurfaceWithWireFrame">
  1238. <summary>The graphic's surface and wireframe will always be rendered</summary>
  1239. </member>
  1240. <member name="F:Cognex.VisionPro3D.Cog3DGraphicDisplayStateConstants.Surface">
  1241. <summary>The graphic's surface will always be rendered</summary>
  1242. </member>
  1243. <member name="F:Cognex.VisionPro3D.Cog3DGraphicDisplayStateConstants.DisplayDefault">
  1244. <summary>The graphic will follow the rendering mode of the display. Available for ICogVisionDataGraphic only</summary>
  1245. </member>
  1246. </members>
  1247. </doc>