Cognex.VisionPro3D.Display.Controls.xml 62 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150
  1. <?xml version="1.0"?>
  2. <doc>
  3. <assembly>
  4. <name>Cognex.VisionPro3D.Display.Controls</name>
  5. </assembly>
  6. <members>
  7. <member name="T:Cognex.VisionPro3D.Cog3DDisplayV2">
  8. <summary>
  9. A WPF version of the Cog3DDisplayV2 VisionPro user control
  10. </summary>
  11. <summary>
  12. Cog3DDisplayV2
  13. </summary>
  14. </member>
  15. <member name="T:Cognex.VisionPro3D.ICog3DDisplayV2">
  16. <summary>
  17. Public interface for the Cog3DDisplayV2 user controls
  18. </summary>
  19. </member>
  20. <member name="M:Cognex.VisionPro3D.ICog3DDisplayV2.SaveAsImage(System.String)">
  21. <summary>
  22. Save the content of the display into an image file with the current resolution of the display.
  23. If the filename attribute is not set, the display will show a Save File Dialog to the user
  24. so she can specify the name and location of the file to save the image to.
  25. </summary>
  26. <param name="fileName">The name of the file to save the content of the display to.</param>
  27. </member>
  28. <member name="M:Cognex.VisionPro3D.ICog3DDisplayV2.SaveAsImage(System.Int32,System.Int32,System.String)">
  29. <summary>
  30. Save the content of the scene into an image file with the given width and height as the resolution of the resulting image.
  31. If the filename attribute is not set, the display will show a Save File Dialog to the user
  32. so she can specify the name and location of the file to save the image to.
  33. </summary>
  34. <exception cref="T:System.ArgumentException">
  35. Throws an ArgumentException if the width is 0 or negative.
  36. </exception>
  37. <exception cref="T:System.ArgumentException">
  38. Throws an ArgumentException if the height is 0 or negative.
  39. </exception>
  40. <param name="width">The width of the resulting image file</param>
  41. <param name="height">The height of the resulting image file</param>
  42. <param name="fileName">The name of the file to save the content of the display to.</param>
  43. </member>
  44. <member name="M:Cognex.VisionPro3D.ICog3DDisplayV2.ResetView">
  45. <summary>
  46. Reset the camera's location to its default: 0,0,Z, looking at 0,0,0.
  47. Zooms to an extent to fit the graphics into the view.
  48. </summary>
  49. </member>
  50. <member name="M:Cognex.VisionPro3D.ICog3DDisplayV2.FitView">
  51. <summary>
  52. Zooms in and out to fit the content of the world into the view
  53. </summary>
  54. </member>
  55. <member name="M:Cognex.VisionPro3D.ICog3DDisplayV2.SetView(Cognex.VisionPro3D.Cog3DVect3,Cognex.VisionPro3D.Cog3DVect3,Cognex.VisionPro3D.Cog3DVect3)">
  56. <summary>
  57. Change the camera's position and look direction in the 3-D space.
  58. </summary>
  59. <param name="position">New position of the camera.</param>
  60. <param name="target">New target the camera is looking at.</param>
  61. <param name="upDirection">New up direction of the camera.</param>
  62. </member>
  63. <member name="M:Cognex.VisionPro3D.ICog3DDisplayV2.Add(Cognex.VisionPro3D.Cog3DVisionDataGraphicBase,System.String)">
  64. <summary>
  65. Adds a Cog3DVisionDataGraphicBase item to the display to the given group.
  66. Throws an exception if the item is null.
  67. Throws an exception if the item has already been added to the display.
  68. Throws an exception if the groupName is null or empty string.
  69. </summary>
  70. <exception cref="T:System.ArgumentNullException">
  71. Throws an exception if the item is null
  72. </exception>
  73. <exception cref="T:System.ArgumentException">
  74. Throws an exception if the item has already been added to the display.
  75. </exception>
  76. <exception cref="T:System.ArgumentException">
  77. Throws an exception if the groupName is null or empty string.
  78. </exception>
  79. <param name="item">the Cog3DVisionDataGraphicBase item to add to the display</param>
  80. <param name="groupName">The name of the logical group to add the item to. The groupName is case insensitive.</param>
  81. </member>
  82. <member name="M:Cognex.VisionPro3D.ICog3DDisplayV2.GetVisionDataGraphic(System.Int32)">
  83. <summary>
  84. Returns a Cog3DVisionDataGraphicBase item at the given index
  85. </summary>
  86. <param name="index">the zero based index of the Cog3DVisionDataGraphicBase item to return</param>
  87. <returns>The Cog3DVisionDataGraphicBase item at the given index</returns>
  88. </member>
  89. <member name="M:Cognex.VisionPro3D.ICog3DDisplayV2.GetVisionDataGraphics">
  90. <summary>
  91. Returns all the Cog3DVisionDataGraphicBase graphic items added to the display
  92. </summary>
  93. <returns>Returns all the Cog3DVisionDataGraphicBase graphic items added to the display</returns>
  94. </member>
  95. <member name="M:Cognex.VisionPro3D.ICog3DDisplayV2.GetLostAndFoundVisionDataGraphics">
  96. <summary>
  97. Returns all the Cog3DVisionDataGraphicBase graphic items that has been added to the display
  98. but its 3D coordinate space does not hold an entry specified by DisplaySpaceName3D and therefore cannot be rendered
  99. </summary>
  100. <returns>Returns all the Cog3DVisionDataGraphicBase graphic items that has been added to the display
  101. but its 3D coordinate space does not hold an entry specified by DisplaySpaceName3D and therefore cannot be rendered
  102. </returns>
  103. </member>
  104. <member name="M:Cognex.VisionPro3D.ICog3DDisplayV2.GetVisionDataGraphics(System.String)">
  105. <summary>
  106. Returns all the Cog3DVisionDataGraphicBase from the given group
  107. </summary>
  108. <param name="groupName">The name of the group to return the Cog3DVisionDataGraphicBase from. The groupName is case insensitive.</param>
  109. <returns>Returns all the Cog3DVisionDataGraphicBase from the given group</returns>
  110. </member>
  111. <member name="M:Cognex.VisionPro3D.ICog3DDisplayV2.Remove(Cognex.VisionPro3D.Cog3DVisionDataGraphicBase)">
  112. <summary>
  113. Removes the given Cog3DVisionDataGraphicBase from the display with all of its associated geometry graphics.
  114. </summary>
  115. <exception cref="T:System.ArgumentNullException">
  116. Throws an exception if the visionDataGraphic is null.
  117. </exception>
  118. <exception cref="T:System.ArgumentException">
  119. Throws an exception if the visionDataGraphic is not on the display.
  120. </exception>
  121. <param name="visionDataGraphic"></param>
  122. </member>
  123. <member name="M:Cognex.VisionPro3D.ICog3DDisplayV2.RemoveVisionDataGraphicByIndex(System.Int32)">
  124. <summary>
  125. Removes the given Cog3DVisionDataGraphicBase from the display at the given index.
  126. The associated geometry graphics will be removed too.
  127. </summary>
  128. <exception cref="T:System.ArgumentException">
  129. Throws an exception if the index is outside of the graphic collection's boundaries.
  130. </exception>
  131. <param name="index">The zero based index of the item to remove</param>
  132. </member>
  133. <member name="M:Cognex.VisionPro3D.ICog3DDisplayV2.Add(Cognex.VisionPro3D.Cog3DGeometryGraphicBase,Cognex.VisionPro3D.Cog3DVisionDataGraphicBase,System.String)">
  134. <summary>
  135. Adds the given geometryGraphic to the display. It will be associated with the given
  136. VisionDataGraphic and the VisionDataGraphic’s 3D coordinate space tree will be used
  137. to resolve the geometry graphic’s SelectedSpaceName3D to the display’s DisplaySpaceName3D.
  138. Throws an exception if the geometryGraphic is null.
  139. Throws an exception if the geometryGraphic has already been added to the display.
  140. Throws an exception if the visionDataGraphic is null.
  141. Throws an exception if the visionDataGraphic has NOT yet been added to the display.
  142. Throws an exception if the groupName is null or empty string.
  143. </summary>
  144. <exception cref="T:System.ArgumentNullException">
  145. Throws an exception if the geometryGraphic is null.
  146. </exception>
  147. <exception cref="T:System.ArgumentException">
  148. Throws an exception if the geometryGraphic has already been added to the display.
  149. </exception>
  150. <exception cref="T:System.ArgumentNullException">
  151. Throws an exception if the visionDataGraphic is null.
  152. </exception>
  153. <exception cref="T:System.ArgumentException">
  154. Throws an exception if the visionDataGraphic has not yet been added to the display.
  155. </exception>
  156. <exception cref="T:System.ArgumentException">
  157. Throws an exception if the groupName is null or empty string.
  158. </exception>
  159. <param name="geometryGraphic">The geometry graphic to add to the display</param>
  160. <param name="visionDataGraphic">The vision data graphic to associate the geometry graphic with</param>
  161. <param name="groupName">The name of the logical group to add the geometry graphic to. The groupName is case insensitive.</param>
  162. </member>
  163. <member name="M:Cognex.VisionPro3D.ICog3DDisplayV2.GetGeometryGraphic(System.Int32)">
  164. <summary>
  165. Returns a Cog3DGeometryGraphicBase item at the given index
  166. </summary>
  167. <param name="index">the zero based index of the Cog3DGeometryGraphicBase item to return</param>
  168. <returns>The Cog3DGeometryGraphicBase item at the given index</returns>
  169. </member>
  170. <member name="M:Cognex.VisionPro3D.ICog3DDisplayV2.GetGeometryGraphics">
  171. <summary>
  172. Returns all the Cog3DGeometryGraphicBase graphic items added to the display
  173. </summary>
  174. <returns>Returns all the Cog3DGeometryGraphicBase graphic items added to the display</returns>
  175. </member>
  176. <member name="M:Cognex.VisionPro3D.ICog3DDisplayV2.GetLostAndFoundGeometryGraphics">
  177. <summary>
  178. Returns all the Cog3DGeometryGraphicBase graphic items that has been added to the display
  179. but its SelectedSpaceName3D could not be resolved because either:
  180. - the SelectedSpaceName3D of the geometry graphic can not be found in the associated VisionData's 3D coordinate space tree
  181. - or there is something wrong with the associated VisionData's 3D coordinate space tree and therefore it could not be rendered
  182. </summary>
  183. <returns>Returns all the Cog3DGeometryGraphicBase graphic items that has been added to the display but its SelectedSpaceName3D could not be resolved</returns>
  184. </member>
  185. <member name="M:Cognex.VisionPro3D.ICog3DDisplayV2.GetGeometryGraphics(System.String)">
  186. <summary>
  187. Returns all the Cog3DGeometryGraphicBase from the given group
  188. </summary>
  189. <param name="groupName">The name of the group to return the Cog3DGeometryGraphicBase from. The groupName is case insensitive.</param>
  190. <returns>Returns all the Cog3DGeometryGraphicBase from the given group</returns>
  191. </member>
  192. <member name="M:Cognex.VisionPro3D.ICog3DDisplayV2.Remove(Cognex.VisionPro3D.Cog3DGeometryGraphicBase)">
  193. <summary>
  194. Removes the given Cog3DGeometryGraphicBase from the display
  195. </summary>
  196. <exception cref="T:System.ArgumentNullException">
  197. Throws an exception if the geometryGraphic is null.
  198. </exception>
  199. <exception cref="T:System.ArgumentException">
  200. Throws an exception if the geometryGraphic is not on the display.
  201. </exception>
  202. <param name="geometryGraphic">The Cog3DGeometryGraphicBase to remove from the display</param>
  203. </member>
  204. <member name="M:Cognex.VisionPro3D.ICog3DDisplayV2.RemoveGeometryGraphicByIndex(System.Int32)">
  205. <summary>
  206. Removes the given Cog3DGeometryGraphicBase from the display at the given index
  207. </summary>
  208. <exception cref="T:System.ArgumentException">
  209. Throws an exception if the index is outside of the graphic collection's boundaries.
  210. </exception>
  211. <param name="index">The zero based index of the item to remove</param>
  212. </member>
  213. <member name="M:Cognex.VisionPro3D.ICog3DDisplayV2.Remove(System.String)">
  214. <summary>
  215. Removes all the Cog3DVisionDataGraphicBase and Cog3DGeometryGraphicBase graphics
  216. from the display from the specified group.
  217. NOTE: when it removes a Cog3DVisionDataGraphicBase all of its associated geometry graphics
  218. will be removed regardless of which group they are in.
  219. </summary>
  220. <param name="groupName">The name of the logical group to add the item to. The groupName is case insensitive.</param>
  221. </member>
  222. <member name="M:Cognex.VisionPro3D.ICog3DDisplayV2.Clear">
  223. <summary>
  224. Cleras the contents of the display
  225. </summary>
  226. </member>
  227. <member name="P:Cognex.VisionPro3D.ICog3DDisplayV2.BackColor">
  228. <summary>
  229. The background color of the display
  230. </summary>
  231. </member>
  232. <member name="P:Cognex.VisionPro3D.ICog3DDisplayV2.EnableDrawing">
  233. <summary>
  234. Gets or sets whether draqing the content of the display is enabled or not.
  235. When not enabled, no actual refresh of the display will happen inserting/updating/removing items
  236. If adding/updateing/removing multiple items it is advised to disable drawing so no redraw will happen after each individual operation
  237. </summary>
  238. </member>
  239. <member name="P:Cognex.VisionPro3D.ICog3DDisplayV2.DisplaySpaceName3D">
  240. <summary>
  241. Gets or sets the name of the coordinate space that needs to be used forrendering
  242. RangeImage, PointCloud and any other 3D graphics that is being added to the display
  243. NOTE: this is the name of the common shared physical space
  244. </summary>
  245. <exception cref="T:Cognex.VisionPro.Exceptions.CogSpaceTreeInvalidNameSyntaxException">
  246. Throws an CogSpaceTreeInvalidNameSyntaxException if the DisplaySpaceName3D doesn't have a valid space name syntax.
  247. </exception>
  248. </member>
  249. <member name="P:Cognex.VisionPro3D.ICog3DDisplayV2.MouseCoordinatesTracked">
  250. <summary>
  251. Gets or sets whether the mouse’s coordinates are tracked in the display.
  252. It has to be set to true to figure out the 3D coordinates under the mouse's position.
  253. If set to false, mouse coordinates are not tracked and always reported as null.
  254. </summary>
  255. </member>
  256. <member name="P:Cognex.VisionPro3D.ICog3DDisplayV2.MouseCoordinates">
  257. <summary>
  258. Returns the 3D coordinates of the mouse pointer. If there is no valid 3D coordinates of the mouse it returns null.
  259. The MouseCoordinatesTracked property has to be set to true otherwise mouse coordinates are not tracked at all and will always return null.
  260. </summary>
  261. </member>
  262. <member name="E:Cognex.VisionPro3D.ICog3DDisplayV2.MouseCoordinatesChanged">
  263. <summary>
  264. Event to signal the change of MouseCoordinates
  265. </summary>
  266. </member>
  267. <member name="P:Cognex.VisionPro3D.ICog3DDisplayV2.CameraPosition">
  268. <summary>
  269. Returns the camera's position in the world space
  270. </summary>
  271. </member>
  272. <member name="P:Cognex.VisionPro3D.ICog3DDisplayV2.CameraTarget">
  273. <summary>
  274. Returns the camera's target position (look at) in the world space
  275. </summary>
  276. </member>
  277. <member name="P:Cognex.VisionPro3D.ICog3DDisplayV2.CameraUpDirection">
  278. <summary>
  279. Returns the camera's up direction in the world space
  280. </summary>
  281. </member>
  282. <member name="P:Cognex.VisionPro3D.ICog3DDisplayV2.VisionDataGraphicsCount">
  283. <summary>
  284. Return the number of Cog3DVisionDataGraphicBase items in the display
  285. </summary>
  286. </member>
  287. <member name="P:Cognex.VisionPro3D.ICog3DDisplayV2.GeometryGraphicsCount">
  288. <summary>
  289. Return the number of Cog3DGeometryGraphicBase items in the display
  290. </summary>
  291. </member>
  292. <member name="P:Cognex.VisionPro3D.ICog3DDisplayV2.DisplayMode">
  293. <summary>
  294. Gets or sets the current rendering mode of the display
  295. NOTE: Setting the mode to DisplayModes.Vertices may lead to runtime error on Intel HD3000 with the latest Intel grpahics driver (VC5 hardware)
  296. </summary>
  297. </member>
  298. <member name="P:Cognex.VisionPro3D.ICog3DDisplayV2.AutoResolution">
  299. <summary>
  300. Gets or sets whether the display should automatically figure out the
  301. subsampling rate for the Cog3DVisionDataGraphic objects
  302. </summary>
  303. </member>
  304. <member name="P:Cognex.VisionPro3D.ICog3DDisplayV2.Resolution">
  305. <summary>
  306. Gets or sets the subsampling rate in DisplaySpaceName3D units. To make the display use this given value set AutoResolution to false
  307. </summary>
  308. </member>
  309. <member name="M:Cognex.VisionPro3D.Cog3DDisplayV2.#ctor">
  310. <summary>
  311. Default constructor for the WPF 3D display control
  312. </summary>
  313. </member>
  314. <member name="M:Cognex.VisionPro3D.Cog3DDisplayV2.Dispose">
  315. <summary>
  316. Disposes the WPF 3D display control. Needs to be called explicitely when the control needs to be disposed.
  317. </summary>
  318. </member>
  319. <member name="M:Cognex.VisionPro3D.Cog3DDisplayV2.ResetView">
  320. <inheritdoc cref="M:Cognex.VisionPro3D.ICog3DDisplayV2.ResetView"/>
  321. </member>
  322. <member name="M:Cognex.VisionPro3D.Cog3DDisplayV2.FitView">
  323. <inheritdoc cref="M:Cognex.VisionPro3D.ICog3DDisplayV2.FitView"/>
  324. </member>
  325. <member name="M:Cognex.VisionPro3D.Cog3DDisplayV2.Clear">
  326. <inheritdoc cref="M:Cognex.VisionPro3D.ICog3DDisplayV2.Clear"/>
  327. </member>
  328. <member name="F:Cognex.VisionPro3D.Cog3DDisplayV2.EnableDrawingProperty">
  329. <summary>
  330. Identifies the <see cref="P:Cognex.VisionPro3D.Cog3DDisplayV2.EnableDrawing"/> dependency property.
  331. </summary>
  332. </member>
  333. <member name="F:Cognex.VisionPro3D.Cog3DDisplayV2.DisplaySpaceName3DProperty">
  334. <summary>
  335. Identifies the <see cref="P:Cognex.VisionPro3D.Cog3DDisplayV2.DisplaySpaceName3D"/> dependency property.
  336. </summary>
  337. </member>
  338. <member name="M:Cognex.VisionPro3D.Cog3DDisplayV2.SaveAsImage(System.String)">
  339. <inheritdoc cref="M:Cognex.VisionPro3D.ICog3DDisplayV2.SaveAsImage(System.String)"/>
  340. </member>
  341. <member name="M:Cognex.VisionPro3D.Cog3DDisplayV2.SaveAsImage(System.Int32,System.Int32,System.String)">
  342. <inheritdoc cref="M:Cognex.VisionPro3D.ICog3DDisplayV2.SaveAsImage(System.Int32,System.Int32,System.String)"/>
  343. </member>
  344. <member name="F:Cognex.VisionPro3D.Cog3DDisplayV2.AutoResolutionProperty">
  345. <summary>
  346. Identifies the <see cref="P:Cognex.VisionPro3D.Cog3DDisplayV2.AutoResolution"/> dependency property.
  347. </summary>
  348. </member>
  349. <member name="F:Cognex.VisionPro3D.Cog3DDisplayV2.ResolutionProperty">
  350. <summary>
  351. Identifies the <see cref="P:Cognex.VisionPro3D.Cog3DDisplayV2.Resolution"/> dependency property.
  352. </summary>
  353. </member>
  354. <member name="M:Cognex.VisionPro3D.Cog3DDisplayV2.SetView(Cognex.VisionPro3D.Cog3DVect3,Cognex.VisionPro3D.Cog3DVect3,Cognex.VisionPro3D.Cog3DVect3)">
  355. <inheritdoc cref="M:Cognex.VisionPro3D.ICog3DDisplayV2.SetView(Cognex.VisionPro3D.Cog3DVect3,Cognex.VisionPro3D.Cog3DVect3,Cognex.VisionPro3D.Cog3DVect3)"/>
  356. </member>
  357. <member name="F:Cognex.VisionPro3D.Cog3DDisplayV2.DisplayModeProperty">
  358. <summary>
  359. Identifies the <see cref="P:Cognex.VisionPro3D.Cog3DDisplayV2.DisplayMode"/> dependency property.
  360. </summary>
  361. </member>
  362. <member name="F:Cognex.VisionPro3D.Cog3DDisplayV2.MouseCoordinatesTrackedProperty">
  363. <summary>
  364. Identifies the <see cref="P:Cognex.VisionPro3D.Cog3DDisplayV2.MouseCoordinatesTracked"/> dependency property.
  365. </summary>
  366. </member>
  367. <member name="M:Cognex.VisionPro3D.Cog3DDisplayV2.Add(Cognex.VisionPro3D.Cog3DVisionDataGraphicBase,System.String)">
  368. <inheritdoc cref="M:Cognex.VisionPro3D.ICog3DDisplayV2.Add(Cognex.VisionPro3D.Cog3DVisionDataGraphicBase,System.String)"/>
  369. </member>
  370. <member name="M:Cognex.VisionPro3D.Cog3DDisplayV2.GetVisionDataGraphic(System.Int32)">
  371. <inheritdoc cref="M:Cognex.VisionPro3D.ICog3DDisplayV2.GetVisionDataGraphic(System.Int32)"/>
  372. </member>
  373. <member name="M:Cognex.VisionPro3D.Cog3DDisplayV2.GetVisionDataGraphics">
  374. <inheritdoc cref="M:Cognex.VisionPro3D.ICog3DDisplayV2.GetVisionDataGraphics"/>
  375. </member>
  376. <member name="M:Cognex.VisionPro3D.Cog3DDisplayV2.GetLostAndFoundVisionDataGraphics">
  377. <inheritdoc cref="M:Cognex.VisionPro3D.ICog3DDisplayV2.GetLostAndFoundVisionDataGraphics"/>
  378. </member>
  379. <member name="M:Cognex.VisionPro3D.Cog3DDisplayV2.GetVisionDataGraphics(System.String)">
  380. <inheritdoc cref="M:Cognex.VisionPro3D.ICog3DDisplayV2.GetVisionDataGraphics(System.String)"/>
  381. </member>
  382. <member name="M:Cognex.VisionPro3D.Cog3DDisplayV2.Remove(Cognex.VisionPro3D.Cog3DVisionDataGraphicBase)">
  383. <inheritdoc cref="M:Cognex.VisionPro3D.ICog3DDisplayV2.Remove(Cognex.VisionPro3D.Cog3DVisionDataGraphicBase)"/>
  384. </member>
  385. <member name="M:Cognex.VisionPro3D.Cog3DDisplayV2.RemoveVisionDataGraphicByIndex(System.Int32)">
  386. <inheritdoc cref="M:Cognex.VisionPro3D.ICog3DDisplayV2.RemoveVisionDataGraphicByIndex(System.Int32)"/>
  387. </member>
  388. <member name="M:Cognex.VisionPro3D.Cog3DDisplayV2.Add(Cognex.VisionPro3D.Cog3DGeometryGraphicBase,Cognex.VisionPro3D.Cog3DVisionDataGraphicBase,System.String)">
  389. <inheritdoc cref="M:Cognex.VisionPro3D.ICog3DDisplayV2.Add(Cognex.VisionPro3D.Cog3DGeometryGraphicBase,Cognex.VisionPro3D.Cog3DVisionDataGraphicBase,System.String)"/>
  390. </member>
  391. <member name="M:Cognex.VisionPro3D.Cog3DDisplayV2.GetGeometryGraphic(System.Int32)">
  392. <inheritdoc cref="M:Cognex.VisionPro3D.ICog3DDisplayV2.GetGeometryGraphic(System.Int32)"/>
  393. </member>
  394. <member name="M:Cognex.VisionPro3D.Cog3DDisplayV2.GetGeometryGraphics">
  395. <inheritdoc cref="M:Cognex.VisionPro3D.ICog3DDisplayV2.GetGeometryGraphics"/>
  396. </member>
  397. <member name="M:Cognex.VisionPro3D.Cog3DDisplayV2.GetLostAndFoundGeometryGraphics">
  398. <inheritdoc cref="M:Cognex.VisionPro3D.ICog3DDisplayV2.GetLostAndFoundGeometryGraphics"/>
  399. </member>
  400. <member name="M:Cognex.VisionPro3D.Cog3DDisplayV2.GetGeometryGraphics(System.String)">
  401. <inheritdoc cref="M:Cognex.VisionPro3D.ICog3DDisplayV2.GetGeometryGraphics(System.String)"/>
  402. </member>
  403. <member name="M:Cognex.VisionPro3D.Cog3DDisplayV2.Remove(Cognex.VisionPro3D.Cog3DGeometryGraphicBase)">
  404. <inheritdoc cref="M:Cognex.VisionPro3D.ICog3DDisplayV2.Remove(Cognex.VisionPro3D.Cog3DGeometryGraphicBase)"/>
  405. </member>
  406. <member name="M:Cognex.VisionPro3D.Cog3DDisplayV2.RemoveGeometryGraphicByIndex(System.Int32)">
  407. <inheritdoc cref="M:Cognex.VisionPro3D.ICog3DDisplayV2.RemoveGeometryGraphicByIndex(System.Int32)"/>
  408. </member>
  409. <member name="M:Cognex.VisionPro3D.Cog3DDisplayV2.Remove(System.String)">
  410. <inheritdoc cref="M:Cognex.VisionPro3D.ICog3DDisplayV2.Remove(System.String)"/>
  411. </member>
  412. <member name="M:Cognex.VisionPro3D.Cog3DDisplayV2.InitializeComponent">
  413. <summary>
  414. InitializeComponent
  415. </summary>
  416. </member>
  417. <member name="E:Cognex.VisionPro3D.Cog3DDisplayV2.MouseCoordinatesChanged">
  418. <inheritdoc cref="E:Cognex.VisionPro3D.ICog3DDisplayV2.MouseCoordinatesChanged"/>
  419. </member>
  420. <member name="P:Cognex.VisionPro3D.Cog3DDisplayV2.BackColor">
  421. <inheritdoc cref="P:Cognex.VisionPro3D.ICog3DDisplayV2.BackColor"/>
  422. </member>
  423. <member name="P:Cognex.VisionPro3D.Cog3DDisplayV2.EnableDrawing">
  424. <inheritdoc cref="P:Cognex.VisionPro3D.ICog3DDisplayV2.EnableDrawing"/>
  425. </member>
  426. <member name="P:Cognex.VisionPro3D.Cog3DDisplayV2.DisplaySpaceName3D">
  427. <inheritdoc cref="P:Cognex.VisionPro3D.ICog3DDisplayV2.DisplaySpaceName3D"/>
  428. </member>
  429. <member name="P:Cognex.VisionPro3D.Cog3DDisplayV2.MouseCoordinates">
  430. <inheritdoc cref="P:Cognex.VisionPro3D.ICog3DDisplayV2.MouseCoordinates"/>
  431. </member>
  432. <member name="P:Cognex.VisionPro3D.Cog3DDisplayV2.AutoResolution">
  433. <inheritdoc cref="P:Cognex.VisionPro3D.ICog3DDisplayV2.AutoResolution"/>
  434. </member>
  435. <member name="P:Cognex.VisionPro3D.Cog3DDisplayV2.Resolution">
  436. <inheritdoc cref="P:Cognex.VisionPro3D.ICog3DDisplayV2.Resolution"/>
  437. </member>
  438. <member name="P:Cognex.VisionPro3D.Cog3DDisplayV2.CameraPosition">
  439. <inheritdoc cref="P:Cognex.VisionPro3D.ICog3DDisplayV2.CameraPosition"/>
  440. </member>
  441. <member name="P:Cognex.VisionPro3D.Cog3DDisplayV2.CameraTarget">
  442. <inheritdoc cref="P:Cognex.VisionPro3D.ICog3DDisplayV2.CameraTarget"/>
  443. </member>
  444. <member name="P:Cognex.VisionPro3D.Cog3DDisplayV2.CameraUpDirection">
  445. <inheritdoc cref="P:Cognex.VisionPro3D.ICog3DDisplayV2.CameraUpDirection"/>
  446. </member>
  447. <member name="P:Cognex.VisionPro3D.Cog3DDisplayV2.DisplayMode">
  448. <inheritdoc cref="P:Cognex.VisionPro3D.ICog3DDisplayV2.DisplayMode"/>
  449. </member>
  450. <member name="P:Cognex.VisionPro3D.Cog3DDisplayV2.MouseCoordinatesTracked">
  451. <inheritdoc cref="P:Cognex.VisionPro3D.ICog3DDisplayV2.MouseCoordinatesTracked"/>
  452. </member>
  453. <member name="P:Cognex.VisionPro3D.Cog3DDisplayV2.VisionDataGraphicsCount">
  454. <inheritdoc cref="P:Cognex.VisionPro3D.ICog3DDisplayV2.VisionDataGraphicsCount"/>
  455. </member>
  456. <member name="P:Cognex.VisionPro3D.Cog3DDisplayV2.GeometryGraphicsCount">
  457. <inheritdoc cref="P:Cognex.VisionPro3D.ICog3DDisplayV2.GeometryGraphicsCount"/>
  458. </member>
  459. <member name="T:Cognex.VisionPro3D.Cog3DDisplayV2StatusBar">
  460. <summary>
  461. Cog3DDisplayV2StatusBar provides statusbar features and functionalities for ICog3DDisplayV2 display controls.
  462. </summary>
  463. <summary>
  464. Cog3DDisplayV2StatusBar
  465. </summary>
  466. </member>
  467. <member name="M:Cognex.VisionPro3D.Cog3DDisplayV2StatusBar.#ctor">
  468. <summary>
  469. Creates an instance of the 3D display's status bar control
  470. </summary>
  471. </member>
  472. <member name="F:Cognex.VisionPro3D.Cog3DDisplayV2StatusBar.MouseCoordinatesProperty">
  473. <summary>
  474. Identifies the <see cref="P:Cognex.VisionPro3D.Cog3DDisplayV2StatusBar.MouseCoordinates"/> dependency property.
  475. </summary>
  476. </member>
  477. <member name="M:Cognex.VisionPro3D.Cog3DDisplayV2StatusBar.OnMouseCoordinatesChanged(System.Windows.DependencyObject,System.Windows.DependencyPropertyChangedEventArgs)">
  478. <summary>
  479. Raises the mouse position changed event.
  480. </summary>
  481. </member>
  482. <member name="F:Cognex.VisionPro3D.Cog3DDisplayV2StatusBar.MouseCoordinatesSpaceNameProperty">
  483. <summary>
  484. Identifies the <see cref="P:Cognex.VisionPro3D.Cog3DDisplayV2StatusBar.MouseCoordinatesSpaceName"/> dependency property.
  485. </summary>
  486. </member>
  487. <member name="M:Cognex.VisionPro3D.Cog3DDisplayV2StatusBar.OnMouseCoordinatesSpaceNameChanged(System.Windows.DependencyObject,System.Windows.DependencyPropertyChangedEventArgs)">
  488. <summary>
  489. Raises the mouse position changed event.
  490. </summary>
  491. </member>
  492. <member name="M:Cognex.VisionPro3D.Cog3DDisplayV2StatusBar.Destroy">
  493. <summary>
  494. Use this function to explicitly clean up the control.
  495. Call this only from the thread the control was created on, if the method is called from any other thread it does nothing.
  496. You may call this function multiple times without any ill effects but only the first call - from the appropriate thread - has effect.
  497. </summary>
  498. </member>
  499. <member name="M:Cognex.VisionPro3D.Cog3DDisplayV2StatusBar.ApplicationThreadExit(System.Object,System.EventArgs)">
  500. <summary>
  501. Handles the event which occurs when the control hosted in Windows Forms and the application is closing
  502. </summary>
  503. <param name="sender">The sender.</param>
  504. <param name="e">The <see cref="T:System.EventArgs"/> instance containing the event data.</param>
  505. </member>
  506. <member name="M:Cognex.VisionPro3D.Cog3DDisplayV2StatusBar.DispatcherShutdownStarted(System.Object,System.EventArgs)">
  507. <summary>
  508. Handles the event which occurs when the control hosted in WPF and the application closing
  509. </summary>
  510. <param name="sender">The sender.</param>
  511. <param name="e">The <see cref="T:System.EventArgs"/> instance containing the event data.</param>
  512. </member>
  513. <member name="M:Cognex.VisionPro3D.Cog3DDisplayV2StatusBar.CogWPFUserControlUnloaded(System.Object,System.Windows.RoutedEventArgs)">
  514. <summary>
  515. Handles the event which occurs when the control closed, but the application still running
  516. </summary>
  517. <param name="sender">The sender.</param>
  518. <param name="e">The <see cref="T:System.Windows.RoutedEventArgs"/> instance containing the event data.</param>
  519. </member>
  520. <member name="M:Cognex.VisionPro3D.Cog3DDisplayV2StatusBar.CleanUp">
  521. <summary>
  522. Cleans up the control.
  523. </summary>
  524. </member>
  525. <member name="M:Cognex.VisionPro3D.Cog3DDisplayV2StatusBar.OnParentWindowClosed">
  526. <summary>
  527. Derived classes should override this method to handle the parent closed event.
  528. </summary>
  529. </member>
  530. <member name="M:Cognex.VisionPro3D.Cog3DDisplayV2StatusBar.InitializeComponent">
  531. <summary>
  532. InitializeComponent
  533. </summary>
  534. </member>
  535. <member name="P:Cognex.VisionPro3D.Cog3DDisplayV2StatusBar.Display">
  536. <summary>
  537. Gets or sets the <see cref="T:Cognex.VisionPro3D.ICog3DDisplayV2"/> control for this status bar.
  538. </summary>
  539. </member>
  540. <member name="P:Cognex.VisionPro3D.Cog3DDisplayV2StatusBar.MouseCoordinates">
  541. <summary>
  542. Gets the actual mouse position in the 3-D space.
  543. </summary>
  544. </member>
  545. <member name="P:Cognex.VisionPro3D.Cog3DDisplayV2StatusBar.MouseCoordinatesSpaceName">
  546. <summary>
  547. Gets the actual mouse position in the 3-D space.
  548. </summary>
  549. </member>
  550. <member name="T:Cognex.VisionPro3D.Implementation.Internal.Cog3DModel">
  551. <summary>
  552. 3D model class. Internal use only.
  553. </summary>
  554. </member>
  555. <member name="F:Cognex.VisionPro3D.Implementation.Internal.Cog3DModel._resolution">
  556. <summary>
  557. Gets or sets the rendering resolution. If AutoResolution is false,
  558. this value will determine the rendering resolution.
  559. </summary>
  560. </member>
  561. <member name="F:Cognex.VisionPro3D.Implementation.Internal.Cog3DModel._brush">
  562. <summary>
  563. Gets or sets the color of the model.
  564. </summary>
  565. </member>
  566. <member name="F:Cognex.VisionPro3D.Implementation.Internal.Cog3DModel._renderMissingPixels">
  567. <summary>
  568. Wheter true or false, the missing pixels will be rendered
  569. </summary>
  570. </member>
  571. <member name="F:Cognex.VisionPro3D.Implementation.Internal.Cog3DModel._isModelLeftHanded">
  572. <summary>
  573. Tells whether the currently displayed model is left-handed or not.
  574. </summary>
  575. </member>
  576. <member name="M:Cognex.VisionPro3D.Implementation.Internal.Cog3DModel.GetContent">
  577. <summary>
  578. Returns the content of the model
  579. </summary>
  580. <returns></returns>
  581. </member>
  582. <member name="M:Cognex.VisionPro3D.Implementation.Internal.Cog3DModel.Update">
  583. <summary>
  584. Update (re-render) model
  585. </summary>
  586. </member>
  587. <member name="T:Cognex.VisionPro3D.Cog3DDisplayV2WF">
  588. <summary>
  589. The Windows Forms version of the Cog3DDisplayV2 VisionPro user control
  590. </summary>
  591. </member>
  592. <member name="F:Cognex.VisionPro3D.Cog3DDisplayV2WF.components">
  593. <summary>
  594. Required designer variable.
  595. </summary>
  596. </member>
  597. <member name="M:Cognex.VisionPro3D.Cog3DDisplayV2WF.Dispose(System.Boolean)">
  598. <summary>
  599. Clean up any resources being used.
  600. </summary>
  601. <param name="disposing">true if managed resources should be disposed; otherwise, false.</param>
  602. </member>
  603. <member name="M:Cognex.VisionPro3D.Cog3DDisplayV2WF.InitializeComponent">
  604. <summary>
  605. Required method for Designer support - do not modify
  606. the contents of this method with the code editor.
  607. </summary>
  608. </member>
  609. <member name="M:Cognex.VisionPro3D.Cog3DDisplayV2WF.#ctor">
  610. <summary>
  611. Default contsructor for the WinForms version of the 3D display control
  612. </summary>
  613. </member>
  614. <member name="M:Cognex.VisionPro3D.Cog3DDisplayV2WF.ResetView">
  615. <inheritdoc cref="M:Cognex.VisionPro3D.ICog3DDisplayV2.ResetView"/>
  616. </member>
  617. <member name="M:Cognex.VisionPro3D.Cog3DDisplayV2WF.FitView">
  618. <inheritdoc cref="M:Cognex.VisionPro3D.ICog3DDisplayV2.FitView"/>
  619. </member>
  620. <member name="M:Cognex.VisionPro3D.Cog3DDisplayV2WF.Clear">
  621. <inheritdoc cref="M:Cognex.VisionPro3D.ICog3DDisplayV2.Clear"/>
  622. </member>
  623. <member name="M:Cognex.VisionPro3D.Cog3DDisplayV2WF.SaveAsImage(System.String)">
  624. <inheritdoc cref="M:Cognex.VisionPro3D.ICog3DDisplayV2.SaveAsImage(System.String)"/>
  625. </member>
  626. <member name="M:Cognex.VisionPro3D.Cog3DDisplayV2WF.SaveAsImage(System.Int32,System.Int32,System.String)">
  627. <inheritdoc cref="M:Cognex.VisionPro3D.ICog3DDisplayV2.SaveAsImage(System.Int32,System.Int32,System.String)"/>
  628. </member>
  629. <member name="M:Cognex.VisionPro3D.Cog3DDisplayV2WF.SetView(Cognex.VisionPro3D.Cog3DVect3,Cognex.VisionPro3D.Cog3DVect3,Cognex.VisionPro3D.Cog3DVect3)">
  630. <inheritdoc cref="M:Cognex.VisionPro3D.ICog3DDisplayV2.SetView(Cognex.VisionPro3D.Cog3DVect3,Cognex.VisionPro3D.Cog3DVect3,Cognex.VisionPro3D.Cog3DVect3)"/>
  631. </member>
  632. <member name="M:Cognex.VisionPro3D.Cog3DDisplayV2WF.Add(Cognex.VisionPro3D.Cog3DVisionDataGraphicBase,System.String)">
  633. <inheritdoc cref="M:Cognex.VisionPro3D.ICog3DDisplayV2.Add(Cognex.VisionPro3D.Cog3DVisionDataGraphicBase,System.String)"/>
  634. </member>
  635. <member name="M:Cognex.VisionPro3D.Cog3DDisplayV2WF.GetVisionDataGraphic(System.Int32)">
  636. <inheritdoc cref="M:Cognex.VisionPro3D.ICog3DDisplayV2.GetVisionDataGraphic(System.Int32)"/>
  637. </member>
  638. <member name="M:Cognex.VisionPro3D.Cog3DDisplayV2WF.GetVisionDataGraphics">
  639. <inheritdoc cref="M:Cognex.VisionPro3D.ICog3DDisplayV2.GetVisionDataGraphics"/>
  640. </member>
  641. <member name="M:Cognex.VisionPro3D.Cog3DDisplayV2WF.GetLostAndFoundVisionDataGraphics">
  642. <inheritdoc cref="M:Cognex.VisionPro3D.ICog3DDisplayV2.GetLostAndFoundVisionDataGraphics"/>
  643. </member>
  644. <member name="M:Cognex.VisionPro3D.Cog3DDisplayV2WF.GetVisionDataGraphics(System.String)">
  645. <inheritdoc cref="M:Cognex.VisionPro3D.ICog3DDisplayV2.GetVisionDataGraphics(System.String)"/>
  646. </member>
  647. <member name="M:Cognex.VisionPro3D.Cog3DDisplayV2WF.Remove(Cognex.VisionPro3D.Cog3DVisionDataGraphicBase)">
  648. <inheritdoc cref="M:Cognex.VisionPro3D.ICog3DDisplayV2.Remove(Cognex.VisionPro3D.Cog3DVisionDataGraphicBase)"/>
  649. </member>
  650. <member name="M:Cognex.VisionPro3D.Cog3DDisplayV2WF.RemoveVisionDataGraphicByIndex(System.Int32)">
  651. <inheritdoc cref="M:Cognex.VisionPro3D.ICog3DDisplayV2.RemoveVisionDataGraphicByIndex(System.Int32)"/>
  652. </member>
  653. <member name="M:Cognex.VisionPro3D.Cog3DDisplayV2WF.Add(Cognex.VisionPro3D.Cog3DGeometryGraphicBase,Cognex.VisionPro3D.Cog3DVisionDataGraphicBase,System.String)">
  654. <inheritdoc cref="M:Cognex.VisionPro3D.ICog3DDisplayV2.Add(Cognex.VisionPro3D.Cog3DGeometryGraphicBase,Cognex.VisionPro3D.Cog3DVisionDataGraphicBase,System.String)"/>
  655. </member>
  656. <member name="M:Cognex.VisionPro3D.Cog3DDisplayV2WF.GetGeometryGraphic(System.Int32)">
  657. <inheritdoc cref="M:Cognex.VisionPro3D.ICog3DDisplayV2.GetGeometryGraphic(System.Int32)"/>
  658. </member>
  659. <member name="M:Cognex.VisionPro3D.Cog3DDisplayV2WF.GetGeometryGraphics">
  660. <inheritdoc cref="M:Cognex.VisionPro3D.ICog3DDisplayV2.GetGeometryGraphics"/>
  661. </member>
  662. <member name="M:Cognex.VisionPro3D.Cog3DDisplayV2WF.GetLostAndFoundGeometryGraphics">
  663. <inheritdoc cref="M:Cognex.VisionPro3D.ICog3DDisplayV2.GetLostAndFoundGeometryGraphics"/>
  664. </member>
  665. <member name="M:Cognex.VisionPro3D.Cog3DDisplayV2WF.GetGeometryGraphics(System.String)">
  666. <inheritdoc cref="M:Cognex.VisionPro3D.ICog3DDisplayV2.GetGeometryGraphics(System.String)"/>
  667. </member>
  668. <member name="M:Cognex.VisionPro3D.Cog3DDisplayV2WF.Remove(Cognex.VisionPro3D.Cog3DGeometryGraphicBase)">
  669. <inheritdoc cref="M:Cognex.VisionPro3D.ICog3DDisplayV2.Remove(Cognex.VisionPro3D.Cog3DGeometryGraphicBase)"/>
  670. </member>
  671. <member name="M:Cognex.VisionPro3D.Cog3DDisplayV2WF.RemoveGeometryGraphicByIndex(System.Int32)">
  672. <inheritdoc cref="M:Cognex.VisionPro3D.ICog3DDisplayV2.RemoveGeometryGraphicByIndex(System.Int32)"/>
  673. </member>
  674. <member name="M:Cognex.VisionPro3D.Cog3DDisplayV2WF.Remove(System.String)">
  675. <inheritdoc cref="M:Cognex.VisionPro3D.ICog3DDisplayV2.Remove(System.String)"/>
  676. </member>
  677. <member name="E:Cognex.VisionPro3D.Cog3DDisplayV2WF.MouseCoordinatesChanged">
  678. <inheritdoc cref="E:Cognex.VisionPro3D.ICog3DDisplayV2.MouseCoordinatesChanged"/>
  679. </member>
  680. <member name="P:Cognex.VisionPro3D.Cog3DDisplayV2WF.BackColor">
  681. <inheritdoc cref="P:Cognex.VisionPro3D.ICog3DDisplayV2.BackColor"/>
  682. </member>
  683. <member name="P:Cognex.VisionPro3D.Cog3DDisplayV2WF.EnableDrawing">
  684. <inheritdoc cref="P:Cognex.VisionPro3D.ICog3DDisplayV2.EnableDrawing"/>
  685. </member>
  686. <member name="P:Cognex.VisionPro3D.Cog3DDisplayV2WF.DisplaySpaceName3D">
  687. <inheritdoc cref="P:Cognex.VisionPro3D.ICog3DDisplayV2.DisplaySpaceName3D"/>
  688. </member>
  689. <member name="P:Cognex.VisionPro3D.Cog3DDisplayV2WF.MouseCoordinatesTracked">
  690. <inheritdoc cref="P:Cognex.VisionPro3D.ICog3DDisplayV2.MouseCoordinatesTracked"/>
  691. </member>
  692. <member name="P:Cognex.VisionPro3D.Cog3DDisplayV2WF.MouseCoordinates">
  693. <inheritdoc cref="P:Cognex.VisionPro3D.ICog3DDisplayV2.MouseCoordinates"/>
  694. </member>
  695. <member name="P:Cognex.VisionPro3D.Cog3DDisplayV2WF.AutoResolution">
  696. <inheritdoc cref="P:Cognex.VisionPro3D.ICog3DDisplayV2.AutoResolution"/>
  697. </member>
  698. <member name="P:Cognex.VisionPro3D.Cog3DDisplayV2WF.Resolution">
  699. <inheritdoc cref="P:Cognex.VisionPro3D.ICog3DDisplayV2.Resolution"/>
  700. </member>
  701. <member name="P:Cognex.VisionPro3D.Cog3DDisplayV2WF.CameraPosition">
  702. <inheritdoc cref="P:Cognex.VisionPro3D.ICog3DDisplayV2.CameraPosition"/>
  703. </member>
  704. <member name="P:Cognex.VisionPro3D.Cog3DDisplayV2WF.CameraTarget">
  705. <inheritdoc cref="P:Cognex.VisionPro3D.ICog3DDisplayV2.CameraTarget"/>
  706. </member>
  707. <member name="P:Cognex.VisionPro3D.Cog3DDisplayV2WF.CameraUpDirection">
  708. <inheritdoc cref="P:Cognex.VisionPro3D.ICog3DDisplayV2.CameraUpDirection"/>
  709. </member>
  710. <member name="P:Cognex.VisionPro3D.Cog3DDisplayV2WF.DisplayMode">
  711. <inheritdoc cref="P:Cognex.VisionPro3D.ICog3DDisplayV2.DisplayMode"/>
  712. </member>
  713. <member name="P:Cognex.VisionPro3D.Cog3DDisplayV2WF.VisionDataGraphicsCount">
  714. <inheritdoc cref="P:Cognex.VisionPro3D.ICog3DDisplayV2.VisionDataGraphicsCount"/>
  715. </member>
  716. <member name="P:Cognex.VisionPro3D.Cog3DDisplayV2WF.GeometryGraphicsCount">
  717. <inheritdoc cref="P:Cognex.VisionPro3D.ICog3DDisplayV2.GeometryGraphicsCount"/>
  718. </member>
  719. <member name="T:Cognex.VisionPro3D.Display.Controls.Properties.Resources">
  720. <summary>
  721. A strongly-typed resource class, for looking up localized strings, etc.
  722. </summary>
  723. </member>
  724. <member name="P:Cognex.VisionPro3D.Display.Controls.Properties.Resources.ResourceManager">
  725. <summary>
  726. Returns the cached ResourceManager instance used by this class.
  727. </summary>
  728. </member>
  729. <member name="P:Cognex.VisionPro3D.Display.Controls.Properties.Resources.Culture">
  730. <summary>
  731. Overrides the current thread's CurrentUICulture property for all
  732. resource lookups using this strongly typed resource class.
  733. </summary>
  734. </member>
  735. <member name="M:Cognex.VisionPro3D.Cog3DDisplayV2Impl.ResetView">
  736. <summary>
  737. Resets the view to the default initial camera position and view direction.
  738. Looking at the scene from the top along the Z axis in a way to fit the whole scene
  739. </summary>
  740. </member>
  741. <member name="M:Cognex.VisionPro3D.Cog3DDisplayV2Impl.SaveAsImage(System.String)">
  742. <summary>
  743. Renders the content of the display to a PNG with the actual resolution.
  744. </summary>
  745. <param name="fileName">The path to the file. If null or emptry string, a SaveFileDialog window will be shown to the user to set the filename.</param>
  746. </member>
  747. <member name="M:Cognex.VisionPro3D.Cog3DDisplayV2Impl.SaveAsImage(System.Int32,System.Int32,System.String)">
  748. <summary>
  749. Renders the contents of the display to a PNG with the given resolution.
  750. </summary>
  751. <param name="width">The given width.</param>
  752. <param name="height">The given height.</param>
  753. <param name="fileName">The path to the file. If null or emptry string, a SaveFileDialog window will be shown to the user to set the filename.</param>
  754. </member>
  755. <member name="M:Cognex.VisionPro3D.Cog3DDisplayV2Impl.InitializeDisplayImpl(Cognex.VisionPro3D.Cog3DDisplayV2Impl.DisplayImplType,System.Windows.Forms.Control,System.Windows.Controls.Grid)">
  756. <summary>
  757. Instantiates the class to be used for the current display based on the impl value
  758. </summary>
  759. </member>
  760. <member name="M:Cognex.VisionPro3D.Cog3DDisplayV2Impl.InitializeDisplayProperties">
  761. <summary>
  762. Sets the initial display properties, like background color, etc
  763. </summary>
  764. </member>
  765. <member name="M:Cognex.VisionPro3D.Cog3DDisplayV2Impl.SetDisplayImplBackgroundColor">
  766. <summary>
  767. Sets the background color of the display under the hood
  768. </summary>
  769. </member>
  770. <member name="M:Cognex.VisionPro3D.Cog3DDisplayV2Impl.OnDisplaySpaceName3DChanged">
  771. <summary>
  772. Called when the DisplaySpaceName3D changed
  773. All the existing visiondata needs to be redrawn in the new space
  774. </summary>
  775. </member>
  776. <member name="P:Cognex.VisionPro3D.Cog3DDisplayV2Impl.EnableDrawing">
  777. <summary>
  778. Gets or sets whether updating the screen is enabled or not
  779. </summary>
  780. </member>
  781. <member name="T:Cognex.VisionPro3D.Cog3DDisplayHost">
  782. <summary>
  783. This class is a host for the WPF implementation of the <see cref="T:Cognex.VisionPro3D.Cog3DDisplay"/>
  784. </summary>
  785. </member>
  786. <member name="M:Cognex.VisionPro3D.Cog3DDisplayHost.#ctor">
  787. <summary>
  788. Creates a new Instance of the <see cref="T:Cognex.VisionPro3D.Cog3DDisplayHost"/>.
  789. </summary>
  790. </member>
  791. <member name="M:Cognex.VisionPro3D.Cog3DDisplayHost.Dispose(System.Boolean)">
  792. <summary>
  793. Clean up any resources being used.
  794. </summary>
  795. <param name="disposing">true if managed resources should be disposed; otherwise, false.</param>
  796. </member>
  797. <member name="P:Cognex.VisionPro3D.Cog3DDisplayHost.HostedDisplay">
  798. <summary>
  799. Gets the underlying <see cref="T:Cognex.VisionPro3D.Cog3DDisplay"/> WPF control.
  800. </summary>
  801. </member>
  802. <member name="T:Cognex.VisionPro3D.Cog3DDisplay">
  803. <summary>
  804. A 3D Display Control for rendering 3D Range Images
  805. </summary>
  806. <summary>
  807. Cog3DDisplay
  808. </summary>
  809. </member>
  810. <member name="M:Cognex.VisionPro3D.Cog3DDisplay.#ctor">
  811. <summary>
  812. Creates an instance of the <see cref="T:Cognex.VisionPro3D.Cog3DDisplay"/> class
  813. </summary>
  814. </member>
  815. <member name="F:Cognex.VisionPro3D.Cog3DDisplay.MouseCoordinatesVisibleProperty">
  816. <summary>
  817. Identifies the <see cref="P:Cognex.VisionPro3D.Cog3DDisplay.MouseCoordinatesVisible"/> dependency property.
  818. </summary>
  819. </member>
  820. <member name="F:Cognex.VisionPro3D.Cog3DDisplay.StatusBarVisibleProperty">
  821. <summary>
  822. Identifies the <see cref="P:Cognex.VisionPro3D.Cog3DDisplay.StatusBarVisible"/> dependency property.
  823. </summary>
  824. </member>
  825. <member name="F:Cognex.VisionPro3D.Cog3DDisplay.BrushProperty">
  826. <summary>
  827. Identifies the <see cref="P:Cognex.VisionPro3D.Cog3DDisplay.Brush"/> dependency property.
  828. </summary>
  829. </member>
  830. <member name="F:Cognex.VisionPro3D.Cog3DDisplay.BrushChangedEvent">
  831. <summary>
  832. The brush changed event.
  833. </summary>
  834. </member>
  835. <member name="M:Cognex.VisionPro3D.Cog3DDisplay.OnBrushChanged(System.Windows.DependencyObject,System.Windows.DependencyPropertyChangedEventArgs)">
  836. <summary>
  837. Raises the brush changed event.
  838. </summary>
  839. </member>
  840. <member name="M:Cognex.VisionPro3D.Cog3DDisplay.OnBrushChanged(System.Windows.RoutedPropertyChangedEventArgs{System.Windows.Media.Brush})">
  841. <summary>
  842. Raises the brush changed event.
  843. </summary>
  844. </member>
  845. <member name="F:Cognex.VisionPro3D.Cog3DDisplay.ImageProperty">
  846. <summary>
  847. Identifies the <see cref="P:Cognex.VisionPro3D.Cog3DDisplay.Image"/> dependency property.
  848. </summary>
  849. </member>
  850. <member name="F:Cognex.VisionPro3D.Cog3DDisplay.ImageChangedEvent">
  851. <summary>
  852. The image changed event.
  853. </summary>
  854. </member>
  855. <member name="M:Cognex.VisionPro3D.Cog3DDisplay.OnImageChanged(System.Windows.DependencyObject,System.Windows.DependencyPropertyChangedEventArgs)">
  856. <summary>
  857. Raises the image changed event.
  858. </summary>
  859. </member>
  860. <member name="M:Cognex.VisionPro3D.Cog3DDisplay.OnImageChanged(System.Windows.RoutedPropertyChangedEventArgs{Cognex.VisionPro.ICogImage})">
  861. <summary>
  862. Raises the image changed event.
  863. </summary>
  864. </member>
  865. <member name="F:Cognex.VisionPro3D.Cog3DDisplay.MouseModeProperty">
  866. <summary>
  867. Identifies the <see cref="P:Cognex.VisionPro3D.Cog3DDisplay.MouseMode"/> dependency property.
  868. </summary>
  869. </member>
  870. <member name="F:Cognex.VisionPro3D.Cog3DDisplay.MouseModeChangedEvent">
  871. <summary>
  872. The mouse mode changed event.
  873. </summary>
  874. </member>
  875. <member name="M:Cognex.VisionPro3D.Cog3DDisplay.OnMouseModeChanged(System.Windows.DependencyObject,System.Windows.DependencyPropertyChangedEventArgs)">
  876. <summary>
  877. Raises the mouse mode changed event.
  878. </summary>
  879. </member>
  880. <member name="M:Cognex.VisionPro3D.Cog3DDisplay.OnMouseModeChanged(System.Windows.RoutedPropertyChangedEventArgs{Cognex.VisionPro3D.Cog3DDisplayMouseModeConstants})">
  881. <summary>
  882. Raises the moude mode changed event.
  883. </summary>
  884. </member>
  885. <member name="F:Cognex.VisionPro3D.Cog3DDisplay.MousePositionProperty">
  886. <summary>
  887. Identifies the <see cref="P:Cognex.VisionPro3D.Cog3DDisplay.MousePosition"/> dependency property.
  888. </summary>
  889. </member>
  890. <member name="F:Cognex.VisionPro3D.Cog3DDisplay.MousePositionChangedEvent">
  891. <summary>
  892. The mouse position changed event.
  893. </summary>
  894. </member>
  895. <member name="M:Cognex.VisionPro3D.Cog3DDisplay.OnMousePositionChanged(System.Windows.DependencyObject,System.Windows.DependencyPropertyChangedEventArgs)">
  896. <summary>
  897. Raises the mouse position changed event.
  898. </summary>
  899. </member>
  900. <member name="M:Cognex.VisionPro3D.Cog3DDisplay.OnMousePositionChanged(System.Windows.RoutedPropertyChangedEventArgs{Cognex.VisionPro3D.Cog3DVect3})">
  901. <summary>
  902. Raises the mouse position changed event.
  903. </summary>
  904. </member>
  905. <member name="F:Cognex.VisionPro3D.Cog3DDisplay.RenderNonVisiblePixelsProperty">
  906. <summary>
  907. Identifies the <see cref="P:Cognex.VisionPro3D.Cog3DDisplay.RenderNonVisiblePixels"/> dependency property.
  908. </summary>
  909. </member>
  910. <member name="F:Cognex.VisionPro3D.Cog3DDisplay.RenderNonVisiblePixelsChangedEvent">
  911. <summary>
  912. The render non visible pixels changed event.
  913. </summary>
  914. </member>
  915. <member name="M:Cognex.VisionPro3D.Cog3DDisplay.OnRenderNonVisiblePixelsChanged(System.Windows.DependencyObject,System.Windows.DependencyPropertyChangedEventArgs)">
  916. <summary>
  917. Raises the render non visible pixels changed event.
  918. </summary>
  919. </member>
  920. <member name="M:Cognex.VisionPro3D.Cog3DDisplay.OnRenderNonVisiblePixelsChanged(System.Windows.RoutedPropertyChangedEventArgs{System.Boolean})">
  921. <summary>
  922. Raises the render non visible pixels changed event.
  923. </summary>
  924. </member>
  925. <member name="F:Cognex.VisionPro3D.Cog3DDisplay.RotateAroundMouseDownProperty">
  926. <summary>
  927. Identifies the <see cref="P:Cognex.VisionPro3D.Cog3DDisplay.RotateAroundMouseDown"/> dependency property.
  928. </summary>
  929. </member>
  930. <member name="F:Cognex.VisionPro3D.Cog3DDisplay.RotateAroundMouseDownChangedEvent">
  931. <summary>
  932. The rotate around mouse down changed event.
  933. </summary>
  934. </member>
  935. <member name="M:Cognex.VisionPro3D.Cog3DDisplay.OnRotateAroundMouseDownChanged(System.Windows.DependencyObject,System.Windows.DependencyPropertyChangedEventArgs)">
  936. <summary>
  937. Raises the rotate around mouse down changed event.
  938. </summary>
  939. </member>
  940. <member name="M:Cognex.VisionPro3D.Cog3DDisplay.OnRotateAroundMouseDownChanged(System.Windows.RoutedPropertyChangedEventArgs{System.Boolean})">
  941. <summary>
  942. Raises the rotate around mouse down changed event.
  943. </summary>
  944. </member>
  945. <member name="F:Cognex.VisionPro3D.Cog3DDisplay.SamplingRateProperty">
  946. <summary>
  947. Identifies the <see cref="P:Cognex.VisionPro3D.Cog3DDisplay.SamplingRate"/> dependency property.
  948. </summary>
  949. </member>
  950. <member name="F:Cognex.VisionPro3D.Cog3DDisplay.SamplingRateChangedEvent">
  951. <summary>
  952. The sampling rate changed event.
  953. </summary>
  954. </member>
  955. <member name="M:Cognex.VisionPro3D.Cog3DDisplay.OnSamplingRateChanged(System.Windows.DependencyObject,System.Windows.DependencyPropertyChangedEventArgs)">
  956. <summary>
  957. Raises the sampling rate changed event.
  958. </summary>
  959. </member>
  960. <member name="M:Cognex.VisionPro3D.Cog3DDisplay.OnSamplingRateChanged(System.Windows.RoutedPropertyChangedEventArgs{System.Int32})">
  961. <summary>
  962. Raises the sampling rate changed event.
  963. </summary>
  964. </member>
  965. <member name="F:Cognex.VisionPro3D.Cog3DDisplay.ZoomAroundMouseDownProperty">
  966. <summary>
  967. Identifies the <see cref="P:Cognex.VisionPro3D.Cog3DDisplay.ZoomAroundMouseDown"/> dependency property.
  968. </summary>
  969. </member>
  970. <member name="F:Cognex.VisionPro3D.Cog3DDisplay.ZoomAroundMouseDownChangedEvent">
  971. <summary>
  972. The zoom around mouse down changed event.
  973. </summary>
  974. </member>
  975. <member name="M:Cognex.VisionPro3D.Cog3DDisplay.OnZoomAroundMouseDownChanged(System.Windows.DependencyObject,System.Windows.DependencyPropertyChangedEventArgs)">
  976. <summary>
  977. Raises the zoom around mouse down changed event.
  978. </summary>
  979. </member>
  980. <member name="M:Cognex.VisionPro3D.Cog3DDisplay.OnZoomAroundMouseDownChanged(System.Windows.RoutedPropertyChangedEventArgs{System.Boolean})">
  981. <summary>
  982. Raises the zoom around mouse down changed event.
  983. </summary>
  984. </member>
  985. <member name="M:Cognex.VisionPro3D.Cog3DDisplay.Fit(System.Boolean)">
  986. <summary>
  987. Zooms to the extents of the sceen.
  988. </summary>
  989. <param name="resetView">A value indicating whether to reset the view to the initial state.</param>
  990. </member>
  991. <member name="M:Cognex.VisionPro3D.Cog3DDisplay.RenderScene">
  992. <summary>
  993. Renders the content of the display to a bitmap with the actual resolution.
  994. </summary>
  995. <returns>The rendered content.</returns>
  996. </member>
  997. <member name="M:Cognex.VisionPro3D.Cog3DDisplay.RenderScene(System.Int32,System.Int32)">
  998. <summary>
  999. Renders the content of the display to a bitmap with the given resolution.
  1000. </summary>
  1001. <param name="width">The given width.</param>
  1002. <param name="height">The given height.</param>
  1003. <returns>The rendered content.</returns>
  1004. </member>
  1005. <member name="M:Cognex.VisionPro3D.Cog3DDisplay.SetView(Cognex.VisionPro3D.Cog3DVect3,Cognex.VisionPro3D.Cog3DVect3,Cognex.VisionPro3D.Cog3DVect3)">
  1006. <summary>
  1007. Change the viewport's position and direction in the 3-D space.
  1008. </summary>
  1009. <param name="newPosition">New position of the viewport.</param>
  1010. <param name="newDirection">New looking direction of the viewport.</param>
  1011. <param name="upDirection">New up direction of the viewport.</param>
  1012. </member>
  1013. <member name="M:Cognex.VisionPro3D.Cog3DDisplay.InitializeComponent">
  1014. <summary>
  1015. InitializeComponent
  1016. </summary>
  1017. </member>
  1018. <member name="P:Cognex.VisionPro3D.Cog3DDisplay.MouseCoordinatesVisible">
  1019. <summary>
  1020. Gets or sets whether the coordinates of the object under the mouse cursor are visible on the Display
  1021. </summary>
  1022. </member>
  1023. <member name="P:Cognex.VisionPro3D.Cog3DDisplay.StatusBarVisible">
  1024. <summary>
  1025. Gets or sets whether the coordinates of the object under the mouse cursor are visible on the Statusbar
  1026. </summary>
  1027. </member>
  1028. <member name="P:Cognex.VisionPro3D.Cog3DDisplay.Brush">
  1029. <summary>
  1030. Gets or sets the brush to be applied as a material to the 3-D model.
  1031. </summary>
  1032. </member>
  1033. <member name="E:Cognex.VisionPro3D.Cog3DDisplay.BrushChanged">
  1034. <summary>
  1035. Occurs when the brush changed.
  1036. </summary>
  1037. </member>
  1038. <member name="P:Cognex.VisionPro3D.Cog3DDisplay.Image">
  1039. <summary>
  1040. Gets or sets the image currently in the display.
  1041. </summary>
  1042. <exception cref="T:Cognex.VisionPro3D.Cog3DImageRenderException">Thrown when the image cannot be rendered.</exception>
  1043. </member>
  1044. <member name="E:Cognex.VisionPro3D.Cog3DDisplay.ImageChanged">
  1045. <summary>
  1046. Occurs when the image changed.
  1047. </summary>
  1048. </member>
  1049. <member name="P:Cognex.VisionPro3D.Cog3DDisplay.MouseMode">
  1050. <summary>
  1051. Gets or sets the behavior of the display control in response to mouse input.
  1052. </summary>
  1053. </member>
  1054. <member name="E:Cognex.VisionPro3D.Cog3DDisplay.MouseModeChanged">
  1055. <summary>
  1056. Occurs when the mouse mode changed.
  1057. </summary>
  1058. </member>
  1059. <member name="P:Cognex.VisionPro3D.Cog3DDisplay.MousePosition">
  1060. <summary>
  1061. Gets the actual mouse position in the 3-D space.
  1062. </summary>
  1063. </member>
  1064. <member name="E:Cognex.VisionPro3D.Cog3DDisplay.MousePositionChanged">
  1065. <summary>
  1066. Occurs when the mouse position changed.
  1067. </summary>
  1068. </member>
  1069. <member name="P:Cognex.VisionPro3D.Cog3DDisplay.RenderNonVisiblePixels">
  1070. <summary>
  1071. Gets or sets a value indicating whether to render not visible pixels.
  1072. </summary>
  1073. </member>
  1074. <member name="E:Cognex.VisionPro3D.Cog3DDisplay.RenderNonVisiblePixelsChanged">
  1075. <summary>
  1076. Occurs when the render non visible pixels property changed.
  1077. </summary>
  1078. </member>
  1079. <member name="P:Cognex.VisionPro3D.Cog3DDisplay.RotateAroundMouseDown">
  1080. <summary>
  1081. Gets or sets a value indicating whether to rotate around mouse down point.
  1082. </summary>
  1083. </member>
  1084. <member name="E:Cognex.VisionPro3D.Cog3DDisplay.RotateAroundMouseDownChanged">
  1085. <summary>
  1086. Occurs when the rotate around mouse down property changed.
  1087. </summary>
  1088. </member>
  1089. <member name="P:Cognex.VisionPro3D.Cog3DDisplay.SamplingRate">
  1090. <summary>
  1091. Gets or sets the sampling rate of the model. The higher this value is, the lower the rendering quality will be.
  1092. For auto-sampling, use 0.
  1093. </summary>
  1094. <exception cref="T:System.ArgumentOutOfRangeException">
  1095. Thrown when the given value is smaller than 0.
  1096. </exception>
  1097. </member>
  1098. <member name="E:Cognex.VisionPro3D.Cog3DDisplay.SamplingRateChanged">
  1099. <summary>
  1100. Occurs when the sampling rate changed.
  1101. </summary>
  1102. </member>
  1103. <member name="P:Cognex.VisionPro3D.Cog3DDisplay.ZoomAroundMouseDown">
  1104. <summary>
  1105. Gets or sets a value indicating whether to zoom around mouse down point.
  1106. </summary>
  1107. </member>
  1108. <member name="E:Cognex.VisionPro3D.Cog3DDisplay.ZoomAroundMouseDownChanged">
  1109. <summary>
  1110. Occurs when the zoom around mouse down property changed.
  1111. </summary>
  1112. </member>
  1113. <member name="P:Cognex.VisionPro3D.Cog3DDisplay.CamraPosition">
  1114. <summary>
  1115. Returns the current camera position
  1116. </summary>
  1117. </member>
  1118. <member name="P:Cognex.VisionPro3D.Cog3DDisplay.LookDirection">
  1119. <summary>
  1120. Returns the camera's look direction
  1121. </summary>
  1122. </member>
  1123. <member name="P:Cognex.VisionPro3D.Cog3DDisplay.UpDirection">
  1124. <summary>
  1125. Returns the vector which represents the upward direction for the camera.
  1126. </summary>
  1127. </member>
  1128. <member name="M:Cognex.VisionPro3D.Cog3DGeometryGraphicContainer.Add(Cognex.VisionPro3D.Cog3DGeometryGraphicBase,Cognex.VisionPro3D.Cog3DVisionDataGraphicBase,System.String)">
  1129. <summary>
  1130. Add a graphic item to the display.
  1131. </summary>
  1132. <param name="geometry">The graphic item to add.</param>
  1133. <param name="visionData">The Cog3DVisionDataGraphicBase item that holds the 3D coordinate space to resolve the SelectedSpaceName of the item</param>
  1134. <param name="groupName">The name of the group the graphic item shall be added to.</param>
  1135. </member>
  1136. <member name="M:Cognex.VisionPro3D.Cog3DGeometryGraphicContainer.UpdateByVisionData(Cognex.VisionPro3D.Cog3DVisionDataGraphicBase)">
  1137. <summary>
  1138. updates the geometries that belong to the vision data
  1139. </summary>
  1140. <param name="visionDataGraphic"></param>
  1141. </member>
  1142. <member name="M:Cognex.VisionPro3D.Cog3DVisionDataGraphicContainer.Add(Cognex.VisionPro3D.Cog3DVisionDataGraphicBase,System.String)">
  1143. <summary>
  1144. Add a graphic item to the display.
  1145. </summary>
  1146. <param name="item">The graphic item to add.</param>
  1147. <param name="groupName">The name of the group the graphic item shall be added to.</param>
  1148. </member>
  1149. </members>
  1150. </doc>