Cognex.VisionPro3D.Core.xml 418 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617161816191620162116221623162416251626162716281629163016311632163316341635163616371638163916401641164216431644164516461647164816491650165116521653165416551656165716581659166016611662166316641665166616671668166916701671167216731674167516761677167816791680168116821683168416851686168716881689169016911692169316941695169616971698169917001701170217031704170517061707170817091710171117121713171417151716171717181719172017211722172317241725172617271728172917301731173217331734173517361737173817391740174117421743174417451746174717481749175017511752175317541755175617571758175917601761176217631764176517661767176817691770177117721773177417751776177717781779178017811782178317841785178617871788178917901791179217931794179517961797179817991800180118021803180418051806180718081809181018111812181318141815181618171818181918201821182218231824182518261827182818291830183118321833183418351836183718381839184018411842184318441845184618471848184918501851185218531854185518561857185818591860186118621863186418651866186718681869187018711872187318741875187618771878187918801881188218831884188518861887188818891890189118921893189418951896189718981899190019011902190319041905190619071908190919101911191219131914191519161917191819191920192119221923192419251926192719281929193019311932193319341935193619371938193919401941194219431944194519461947194819491950195119521953195419551956195719581959196019611962196319641965196619671968196919701971197219731974197519761977197819791980198119821983198419851986198719881989199019911992199319941995199619971998199920002001200220032004200520062007200820092010201120122013201420152016201720182019202020212022202320242025202620272028202920302031203220332034203520362037203820392040204120422043204420452046204720482049205020512052205320542055205620572058205920602061206220632064206520662067206820692070207120722073207420752076207720782079208020812082208320842085208620872088208920902091209220932094209520962097209820992100210121022103210421052106210721082109211021112112211321142115211621172118211921202121212221232124212521262127212821292130213121322133213421352136213721382139214021412142214321442145214621472148214921502151215221532154215521562157215821592160216121622163216421652166216721682169217021712172217321742175217621772178217921802181218221832184218521862187218821892190219121922193219421952196219721982199220022012202220322042205220622072208220922102211221222132214221522162217221822192220222122222223222422252226222722282229223022312232223322342235223622372238223922402241224222432244224522462247224822492250225122522253225422552256225722582259226022612262226322642265226622672268226922702271227222732274227522762277227822792280228122822283228422852286228722882289229022912292229322942295229622972298229923002301230223032304230523062307230823092310231123122313231423152316231723182319232023212322232323242325232623272328232923302331233223332334233523362337233823392340234123422343234423452346234723482349235023512352235323542355235623572358235923602361236223632364236523662367236823692370237123722373237423752376237723782379238023812382238323842385238623872388238923902391239223932394239523962397239823992400240124022403240424052406240724082409241024112412241324142415241624172418241924202421242224232424242524262427242824292430243124322433243424352436243724382439244024412442244324442445244624472448244924502451245224532454245524562457245824592460246124622463246424652466246724682469247024712472247324742475247624772478247924802481248224832484248524862487248824892490249124922493249424952496249724982499250025012502250325042505250625072508250925102511251225132514251525162517251825192520252125222523252425252526252725282529253025312532253325342535253625372538253925402541254225432544254525462547254825492550255125522553255425552556255725582559256025612562256325642565256625672568256925702571257225732574257525762577257825792580258125822583258425852586258725882589259025912592259325942595259625972598259926002601260226032604260526062607260826092610261126122613261426152616261726182619262026212622262326242625262626272628262926302631263226332634263526362637263826392640264126422643264426452646264726482649265026512652265326542655265626572658265926602661266226632664266526662667266826692670267126722673267426752676267726782679268026812682268326842685268626872688268926902691269226932694269526962697269826992700270127022703270427052706270727082709271027112712271327142715271627172718271927202721272227232724272527262727272827292730273127322733273427352736273727382739274027412742274327442745274627472748274927502751275227532754275527562757275827592760276127622763276427652766276727682769277027712772277327742775277627772778277927802781278227832784278527862787278827892790279127922793279427952796279727982799280028012802280328042805280628072808280928102811281228132814281528162817281828192820282128222823282428252826282728282829283028312832283328342835283628372838283928402841284228432844284528462847284828492850285128522853285428552856285728582859286028612862286328642865286628672868286928702871287228732874287528762877287828792880288128822883288428852886288728882889289028912892289328942895289628972898289929002901290229032904290529062907290829092910291129122913291429152916291729182919292029212922292329242925292629272928292929302931293229332934293529362937293829392940294129422943294429452946294729482949295029512952295329542955295629572958295929602961296229632964296529662967296829692970297129722973297429752976297729782979298029812982298329842985298629872988298929902991299229932994299529962997299829993000300130023003300430053006300730083009301030113012301330143015301630173018301930203021302230233024302530263027302830293030303130323033303430353036303730383039304030413042304330443045304630473048304930503051305230533054305530563057305830593060306130623063306430653066306730683069307030713072307330743075307630773078307930803081308230833084308530863087308830893090309130923093309430953096309730983099310031013102310331043105310631073108310931103111311231133114311531163117311831193120312131223123312431253126312731283129313031313132313331343135313631373138313931403141314231433144314531463147314831493150315131523153315431553156315731583159316031613162316331643165316631673168316931703171317231733174317531763177317831793180318131823183318431853186318731883189319031913192319331943195319631973198319932003201320232033204320532063207320832093210321132123213321432153216321732183219322032213222322332243225322632273228322932303231323232333234323532363237323832393240324132423243324432453246324732483249325032513252325332543255325632573258325932603261326232633264326532663267326832693270327132723273327432753276327732783279328032813282328332843285328632873288328932903291329232933294329532963297329832993300330133023303330433053306330733083309331033113312331333143315331633173318331933203321332233233324332533263327332833293330333133323333333433353336333733383339334033413342334333443345334633473348334933503351335233533354335533563357335833593360336133623363336433653366336733683369337033713372337333743375337633773378337933803381338233833384338533863387338833893390339133923393339433953396339733983399340034013402340334043405340634073408340934103411341234133414341534163417341834193420342134223423342434253426342734283429343034313432343334343435343634373438343934403441344234433444344534463447344834493450345134523453345434553456345734583459346034613462346334643465346634673468346934703471347234733474347534763477347834793480348134823483348434853486348734883489349034913492349334943495349634973498349935003501350235033504350535063507350835093510351135123513351435153516351735183519352035213522352335243525352635273528352935303531353235333534353535363537353835393540354135423543354435453546354735483549355035513552355335543555355635573558355935603561356235633564356535663567356835693570357135723573357435753576357735783579358035813582358335843585358635873588358935903591359235933594359535963597359835993600360136023603360436053606360736083609361036113612361336143615361636173618361936203621362236233624362536263627362836293630363136323633363436353636363736383639364036413642364336443645364636473648364936503651365236533654365536563657365836593660366136623663366436653666366736683669367036713672367336743675367636773678367936803681368236833684368536863687368836893690369136923693369436953696369736983699370037013702370337043705370637073708370937103711371237133714371537163717371837193720372137223723372437253726372737283729373037313732373337343735373637373738373937403741374237433744374537463747374837493750375137523753375437553756375737583759376037613762376337643765376637673768376937703771377237733774377537763777377837793780378137823783378437853786378737883789379037913792379337943795379637973798379938003801380238033804380538063807380838093810381138123813381438153816381738183819382038213822382338243825382638273828382938303831383238333834383538363837383838393840384138423843384438453846384738483849385038513852385338543855385638573858385938603861386238633864386538663867386838693870387138723873387438753876387738783879388038813882388338843885388638873888388938903891389238933894389538963897389838993900390139023903390439053906390739083909391039113912391339143915391639173918391939203921392239233924392539263927392839293930393139323933393439353936393739383939394039413942394339443945394639473948394939503951395239533954395539563957395839593960396139623963396439653966396739683969397039713972397339743975397639773978397939803981398239833984398539863987398839893990399139923993399439953996399739983999400040014002400340044005400640074008400940104011401240134014401540164017401840194020402140224023402440254026402740284029403040314032403340344035403640374038403940404041404240434044404540464047404840494050405140524053405440554056405740584059406040614062406340644065406640674068406940704071407240734074407540764077407840794080408140824083408440854086408740884089409040914092409340944095409640974098409941004101410241034104410541064107410841094110411141124113411441154116411741184119412041214122412341244125412641274128412941304131413241334134413541364137413841394140414141424143414441454146414741484149415041514152415341544155415641574158415941604161416241634164416541664167416841694170417141724173417441754176417741784179418041814182418341844185418641874188418941904191419241934194419541964197419841994200420142024203420442054206420742084209421042114212421342144215421642174218421942204221422242234224422542264227422842294230423142324233423442354236423742384239424042414242424342444245424642474248424942504251425242534254425542564257425842594260426142624263426442654266426742684269427042714272427342744275427642774278427942804281428242834284428542864287428842894290429142924293429442954296429742984299430043014302430343044305430643074308430943104311431243134314431543164317431843194320432143224323432443254326432743284329433043314332433343344335433643374338433943404341434243434344434543464347434843494350435143524353435443554356435743584359436043614362436343644365436643674368436943704371437243734374437543764377437843794380438143824383438443854386438743884389439043914392439343944395439643974398439944004401440244034404440544064407440844094410441144124413441444154416441744184419442044214422442344244425442644274428442944304431443244334434443544364437443844394440444144424443444444454446444744484449445044514452445344544455445644574458445944604461446244634464446544664467446844694470447144724473447444754476447744784479448044814482448344844485448644874488448944904491449244934494449544964497449844994500450145024503450445054506450745084509451045114512451345144515451645174518451945204521452245234524452545264527452845294530453145324533453445354536453745384539454045414542454345444545454645474548454945504551455245534554455545564557455845594560456145624563456445654566456745684569457045714572457345744575457645774578457945804581458245834584458545864587458845894590459145924593459445954596459745984599460046014602460346044605460646074608460946104611461246134614461546164617461846194620462146224623462446254626462746284629463046314632463346344635463646374638463946404641464246434644464546464647464846494650465146524653465446554656465746584659466046614662466346644665466646674668466946704671467246734674467546764677467846794680468146824683468446854686468746884689469046914692469346944695469646974698469947004701470247034704470547064707470847094710471147124713471447154716471747184719472047214722472347244725472647274728472947304731473247334734473547364737473847394740474147424743474447454746474747484749475047514752475347544755475647574758475947604761476247634764476547664767476847694770477147724773477447754776477747784779478047814782478347844785478647874788478947904791479247934794479547964797479847994800480148024803480448054806480748084809481048114812481348144815481648174818481948204821482248234824482548264827482848294830483148324833483448354836483748384839484048414842484348444845484648474848484948504851485248534854485548564857485848594860486148624863486448654866486748684869487048714872487348744875487648774878487948804881488248834884488548864887488848894890489148924893489448954896489748984899490049014902490349044905490649074908490949104911491249134914491549164917491849194920492149224923492449254926492749284929493049314932493349344935493649374938493949404941494249434944494549464947494849494950495149524953495449554956495749584959496049614962496349644965496649674968496949704971497249734974497549764977497849794980498149824983498449854986498749884989499049914992499349944995499649974998499950005001500250035004500550065007500850095010501150125013501450155016501750185019502050215022502350245025502650275028502950305031503250335034503550365037503850395040504150425043504450455046504750485049505050515052505350545055505650575058505950605061506250635064506550665067506850695070507150725073507450755076507750785079508050815082508350845085508650875088508950905091509250935094509550965097509850995100510151025103510451055106510751085109511051115112511351145115511651175118511951205121512251235124512551265127512851295130513151325133513451355136513751385139514051415142514351445145514651475148514951505151515251535154515551565157515851595160516151625163516451655166516751685169517051715172517351745175517651775178517951805181518251835184518551865187518851895190519151925193519451955196519751985199520052015202520352045205520652075208520952105211521252135214521552165217521852195220522152225223522452255226522752285229523052315232523352345235523652375238523952405241524252435244524552465247524852495250525152525253525452555256525752585259526052615262526352645265526652675268526952705271527252735274527552765277527852795280528152825283528452855286528752885289529052915292529352945295529652975298529953005301530253035304530553065307530853095310531153125313531453155316531753185319532053215322532353245325532653275328532953305331533253335334533553365337533853395340534153425343534453455346534753485349535053515352535353545355535653575358535953605361536253635364536553665367536853695370537153725373537453755376537753785379538053815382538353845385538653875388538953905391539253935394539553965397539853995400540154025403540454055406540754085409541054115412541354145415541654175418541954205421542254235424542554265427542854295430543154325433543454355436543754385439544054415442544354445445544654475448544954505451545254535454545554565457545854595460546154625463546454655466546754685469547054715472547354745475547654775478547954805481548254835484548554865487548854895490549154925493549454955496549754985499550055015502550355045505550655075508550955105511551255135514551555165517551855195520552155225523552455255526552755285529553055315532553355345535553655375538553955405541554255435544554555465547554855495550555155525553555455555556555755585559556055615562556355645565556655675568556955705571557255735574557555765577557855795580558155825583558455855586558755885589559055915592559355945595559655975598559956005601560256035604560556065607560856095610561156125613561456155616561756185619562056215622562356245625562656275628562956305631563256335634563556365637563856395640564156425643564456455646564756485649565056515652565356545655565656575658565956605661566256635664566556665667566856695670567156725673567456755676567756785679568056815682568356845685568656875688568956905691569256935694569556965697569856995700570157025703570457055706570757085709571057115712571357145715571657175718571957205721572257235724572557265727572857295730573157325733573457355736573757385739574057415742574357445745574657475748574957505751575257535754575557565757575857595760576157625763576457655766576757685769577057715772577357745775577657775778577957805781578257835784578557865787578857895790579157925793579457955796579757985799580058015802580358045805580658075808580958105811581258135814581558165817581858195820582158225823582458255826582758285829583058315832583358345835583658375838583958405841584258435844584558465847584858495850585158525853585458555856585758585859586058615862586358645865586658675868586958705871587258735874587558765877587858795880588158825883588458855886588758885889589058915892589358945895589658975898589959005901590259035904590559065907590859095910591159125913591459155916591759185919592059215922592359245925592659275928592959305931593259335934593559365937593859395940594159425943594459455946594759485949595059515952595359545955595659575958595959605961596259635964596559665967596859695970597159725973597459755976597759785979598059815982598359845985598659875988598959905991599259935994599559965997599859996000600160026003600460056006600760086009601060116012601360146015601660176018601960206021602260236024602560266027602860296030603160326033603460356036603760386039604060416042604360446045604660476048604960506051605260536054605560566057605860596060606160626063606460656066606760686069607060716072607360746075607660776078607960806081608260836084608560866087608860896090609160926093609460956096609760986099610061016102610361046105610661076108610961106111611261136114611561166117611861196120612161226123612461256126612761286129613061316132613361346135613661376138613961406141614261436144614561466147614861496150615161526153615461556156615761586159616061616162616361646165616661676168616961706171617261736174617561766177617861796180618161826183618461856186618761886189619061916192619361946195619661976198619962006201620262036204620562066207620862096210621162126213621462156216621762186219622062216222622362246225622662276228622962306231623262336234623562366237623862396240624162426243624462456246624762486249625062516252625362546255625662576258625962606261626262636264626562666267626862696270627162726273627462756276627762786279628062816282628362846285628662876288628962906291629262936294629562966297629862996300630163026303630463056306630763086309631063116312631363146315631663176318631963206321632263236324632563266327632863296330633163326333633463356336633763386339634063416342634363446345634663476348634963506351635263536354635563566357635863596360636163626363636463656366636763686369637063716372637363746375637663776378637963806381638263836384638563866387638863896390639163926393639463956396639763986399640064016402640364046405640664076408640964106411641264136414641564166417641864196420642164226423642464256426642764286429643064316432643364346435643664376438643964406441644264436444644564466447644864496450645164526453645464556456645764586459646064616462646364646465646664676468646964706471647264736474647564766477647864796480648164826483648464856486648764886489649064916492649364946495649664976498649965006501650265036504650565066507650865096510651165126513651465156516651765186519652065216522652365246525652665276528652965306531653265336534653565366537653865396540654165426543654465456546654765486549655065516552655365546555655665576558655965606561656265636564656565666567656865696570657165726573657465756576657765786579658065816582658365846585658665876588658965906591659265936594659565966597659865996600660166026603660466056606660766086609661066116612661366146615661666176618661966206621662266236624662566266627662866296630663166326633663466356636663766386639664066416642664366446645664666476648664966506651665266536654665566566657665866596660666166626663666466656666666766686669667066716672667366746675667666776678667966806681668266836684668566866687668866896690669166926693669466956696669766986699670067016702670367046705670667076708670967106711671267136714671567166717671867196720672167226723672467256726672767286729673067316732673367346735673667376738673967406741674267436744674567466747674867496750675167526753675467556756675767586759676067616762676367646765676667676768676967706771677267736774677567766777677867796780678167826783678467856786678767886789679067916792679367946795679667976798679968006801680268036804680568066807680868096810681168126813681468156816681768186819682068216822682368246825682668276828682968306831683268336834683568366837683868396840684168426843684468456846684768486849685068516852685368546855685668576858685968606861686268636864686568666867686868696870687168726873687468756876687768786879688068816882688368846885688668876888688968906891689268936894689568966897689868996900690169026903690469056906690769086909691069116912691369146915691669176918691969206921692269236924692569266927692869296930693169326933693469356936693769386939694069416942694369446945694669476948694969506951695269536954695569566957695869596960696169626963696469656966696769686969697069716972697369746975697669776978697969806981698269836984698569866987698869896990699169926993699469956996699769986999700070017002700370047005700670077008700970107011701270137014701570167017701870197020702170227023702470257026702770287029703070317032703370347035703670377038703970407041704270437044704570467047704870497050705170527053705470557056705770587059706070617062706370647065706670677068706970707071707270737074707570767077707870797080708170827083708470857086708770887089709070917092709370947095709670977098709971007101710271037104710571067107710871097110711171127113711471157116711771187119712071217122712371247125712671277128712971307131713271337134713571367137713871397140714171427143714471457146714771487149715071517152715371547155715671577158715971607161716271637164716571667167716871697170717171727173717471757176717771787179718071817182718371847185718671877188718971907191719271937194719571967197719871997200720172027203720472057206720772087209721072117212721372147215721672177218721972207221722272237224722572267227722872297230723172327233723472357236723772387239724072417242724372447245724672477248724972507251725272537254725572567257725872597260726172627263726472657266726772687269727072717272727372747275727672777278727972807281728272837284728572867287728872897290729172927293729472957296729772987299730073017302730373047305730673077308730973107311731273137314731573167317731873197320732173227323732473257326732773287329733073317332733373347335733673377338733973407341734273437344734573467347734873497350735173527353735473557356735773587359736073617362736373647365736673677368736973707371737273737374737573767377737873797380738173827383738473857386738773887389739073917392739373947395739673977398739974007401740274037404740574067407740874097410741174127413741474157416741774187419742074217422742374247425742674277428742974307431743274337434743574367437743874397440744174427443744474457446744774487449745074517452745374547455745674577458745974607461746274637464746574667467746874697470747174727473747474757476747774787479748074817482748374847485748674877488748974907491749274937494749574967497749874997500750175027503750475057506750775087509751075117512751375147515751675177518751975207521752275237524752575267527752875297530753175327533753475357536753775387539754075417542754375447545754675477548754975507551755275537554755575567557755875597560756175627563756475657566756775687569757075717572757375747575757675777578757975807581758275837584758575867587758875897590759175927593759475957596759775987599760076017602760376047605760676077608760976107611761276137614761576167617761876197620762176227623762476257626762776287629763076317632763376347635763676377638763976407641764276437644764576467647764876497650765176527653765476557656765776587659766076617662766376647665766676677668766976707671767276737674767576767677767876797680768176827683768476857686768776887689769076917692769376947695769676977698769977007701770277037704770577067707770877097710771177127713771477157716771777187719772077217722772377247725772677277728772977307731773277337734773577367737773877397740774177427743774477457746774777487749775077517752775377547755775677577758775977607761776277637764776577667767776877697770777177727773777477757776777777787779778077817782778377847785778677877788778977907791779277937794779577967797779877997800780178027803780478057806780778087809781078117812781378147815781678177818781978207821782278237824782578267827782878297830783178327833783478357836783778387839784078417842784378447845784678477848784978507851785278537854785578567857785878597860786178627863786478657866786778687869787078717872787378747875787678777878787978807881788278837884788578867887788878897890789178927893789478957896789778987899790079017902790379047905790679077908790979107911791279137914791579167917791879197920792179227923792479257926792779287929793079317932793379347935793679377938793979407941794279437944794579467947794879497950795179527953795479557956795779587959796079617962796379647965796679677968796979707971797279737974797579767977797879797980798179827983798479857986798779887989799079917992799379947995799679977998799980008001800280038004800580068007800880098010801180128013801480158016801780188019802080218022802380248025802680278028802980308031803280338034803580368037803880398040804180428043804480458046804780488049805080518052805380548055805680578058805980608061806280638064806580668067806880698070807180728073807480758076807780788079808080818082808380848085808680878088808980908091809280938094809580968097809880998100810181028103810481058106810781088109811081118112811381148115811681178118811981208121812281238124812581268127812881298130813181328133813481358136813781388139814081418142814381448145814681478148814981508151815281538154815581568157815881598160816181628163816481658166816781688169817081718172817381748175817681778178817981808181818281838184818581868187818881898190819181928193819481958196819781988199820082018202820382048205820682078208820982108211821282138214821582168217821882198220822182228223822482258226822782288229823082318232823382348235823682378238823982408241824282438244824582468247824882498250825182528253825482558256825782588259826082618262826382648265826682678268826982708271827282738274827582768277827882798280828182828283828482858286828782888289829082918292829382948295829682978298829983008301830283038304830583068307830883098310831183128313831483158316831783188319832083218322832383248325832683278328832983308331833283338334833583368337833883398340834183428343834483458346834783488349835083518352835383548355835683578358835983608361836283638364836583668367836883698370837183728373837483758376837783788379838083818382838383848385838683878388838983908391839283938394839583968397839883998400840184028403840484058406840784088409841084118412841384148415841684178418841984208421842284238424842584268427842884298430843184328433843484358436843784388439844084418442844384448445844684478448844984508451845284538454845584568457845884598460846184628463846484658466846784688469847084718472847384748475847684778478847984808481848284838484848584868487848884898490849184928493849484958496849784988499850085018502850385048505850685078508850985108511851285138514851585168517851885198520852185228523852485258526852785288529853085318532853385348535853685378538853985408541854285438544854585468547854885498550855185528553855485558556855785588559856085618562856385648565856685678568856985708571857285738574857585768577857885798580858185828583858485858586858785888589859085918592859385948595859685978598859986008601860286038604860586068607860886098610861186128613861486158616861786188619862086218622862386248625862686278628862986308631863286338634863586368637863886398640864186428643864486458646864786488649865086518652865386548655865686578658865986608661866286638664866586668667866886698670867186728673867486758676867786788679868086818682868386848685868686878688868986908691869286938694869586968697869886998700870187028703870487058706870787088709871087118712871387148715871687178718871987208721872287238724872587268727872887298730873187328733873487358736873787388739874087418742874387448745874687478748874987508751875287538754875587568757875887598760876187628763876487658766876787688769877087718772877387748775877687778778877987808781878287838784878587868787878887898790879187928793879487958796879787988799880088018802880388048805880688078808880988108811881288138814881588168817881888198820882188228823882488258826882788288829883088318832883388348835883688378838883988408841884288438844884588468847884888498850885188528853885488558856885788588859886088618862886388648865886688678868886988708871887288738874887588768877887888798880888188828883888488858886888788888889889088918892889388948895889688978898889989008901890289038904890589068907890889098910891189128913891489158916891789188919892089218922892389248925892689278928892989308931893289338934893589368937893889398940894189428943894489458946894789488949895089518952895389548955895689578958895989608961896289638964896589668967896889698970897189728973897489758976897789788979898089818982898389848985898689878988898989908991899289938994899589968997899889999000900190029003900490059006900790089009901090119012901390149015901690179018901990209021902290239024902590269027902890299030903190329033903490359036903790389039904090419042904390449045904690479048904990509051905290539054905590569057905890599060906190629063906490659066906790689069907090719072907390749075907690779078907990809081908290839084908590869087908890899090909190929093909490959096909790989099910091019102910391049105910691079108910991109111911291139114911591169117911891199120912191229123912491259126912791289129913091319132913391349135913691379138913991409141914291439144914591469147914891499150915191529153915491559156915791589159916091619162916391649165916691679168916991709171917291739174917591769177917891799180918191829183918491859186918791889189919091919192919391949195919691979198919992009201920292039204920592069207920892099210921192129213921492159216921792189219922092219222922392249225922692279228922992309231923292339234923592369237923892399240924192429243924492459246924792489249925092519252925392549255925692579258925992609261926292639264926592669267926892699270927192729273927492759276927792789279928092819282928392849285928692879288928992909291929292939294929592969297929892999300930193029303930493059306930793089309931093119312931393149315931693179318931993209321932293239324932593269327932893299330933193329333933493359336933793389339934093419342934393449345934693479348934993509351935293539354935593569357935893599360936193629363936493659366936793689369937093719372937393749375937693779378937993809381938293839384938593869387938893899390939193929393939493959396939793989399940094019402940394049405940694079408940994109411941294139414941594169417941894199420942194229423942494259426942794289429943094319432943394349435943694379438943994409441944294439444944594469447944894499450945194529453945494559456945794589459946094619462946394649465946694679468946994709471947294739474947594769477947894799480948194829483948494859486948794889489949094919492949394949495949694979498949995009501950295039504950595069507950895099510951195129513951495159516951795189519952095219522952395249525952695279528952995309531953295339534953595369537953895399540954195429543954495459546954795489549955095519552955395549555955695579558955995609561956295639564956595669567956895699570957195729573957495759576957795789579958095819582958395849585958695879588958995909591959295939594959595969597959895999600960196029603960496059606960796089609961096119612961396149615961696179618961996209621962296239624962596269627962896299630963196329633963496359636963796389639964096419642964396449645964696479648964996509651965296539654965596569657965896599660966196629663966496659666966796689669967096719672967396749675967696779678967996809681968296839684968596869687968896899690969196929693969496959696969796989699970097019702970397049705970697079708970997109711971297139714971597169717971897199720
  1. <?xml version="1.0"?>
  2. <doc>
  3. <assembly>
  4. "Cognex.VisionPro3D.Core"
  5. </assembly>
  6. <members>
  7. <member name="M:Cognex.VisionPro3D.Cog3DHandEyeCalibrationValidationResult.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
  8. <inheritdoc cref="M:Cognex.VisionPro3D.ICog3DBase.SerializationConstructor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)" />
  9. </member>
  10. <member name="M:Cognex.VisionPro3D.Cog3DHandEyeCalibrationValidationResult.ToString">
  11. <inheritdoc cref="M:Cognex.VisionPro3D.ICog3DBase.ToString" />
  12. </member>
  13. <member name="P:Cognex.VisionPro3D.Cog3DHandEyeCalibrationValidationResult.PositionResidualsPhys3D">
  14. <summary>
  15. Gets the overall residual statistics corresponding to the distribution of
  16. physical 3D residuals over all robot poses used for validation.
  17. </summary>
  18. <value>
  19. The residual statistics characterizing the accuracy of the hand-eye
  20. system.
  21. </value>
  22. <remarks>
  23. PositionResidualsPhys3D.ResidualsDistance.Rms can be used to compare
  24. between the stored validation result and the current validation result and see
  25. whether the measurements satisfactorily agree.
  26. </remarks>
  27. </member>
  28. <member name="P:Cognex.VisionPro3D.Cog3DHandEyeCalibrationValidationResult.CameraCalibrationValidationResult">
  29. <summary>
  30. Gets the camera calibration validation result.
  31. </summary>
  32. <value>
  33. The camera calibration validation result characterizing the accuracy of
  34. camera intrinsic parameters.
  35. </value>
  36. </member>
  37. <member name="M:Cognex.VisionPro3D.Cog3DHandEyeCalibrationValidationResult.Finalize">
  38. <inheritdoc cref="M:Cognex.VisionPro3D.ICog3DBase.FinalizerForThisClass" />
  39. </member>
  40. <member name="M:Cognex.VisionPro3D.Cog3DHandEyeCalibrationValidationResult.Dispose">
  41. <inheritdoc cref="M:Cognex.VisionPro3D.ICog3DBase.DestructorForThisClass" />
  42. </member>
  43. <member name="M:Cognex.VisionPro3D.Cog3DHandEyeCalibrationValidationResult.#ctor(Cognex.VisionPro3D.Cog3DHandEyeCalibrationValidationResult)">
  44. <inheritdoc cref="M:Cognex.VisionPro3D.ICog3DBase.DeepCopyConstructorForThisClass(System.Object)" />
  45. </member>
  46. <member name="T:Cognex.VisionPro3D.Cog3DHandEyeCalibrationValidationResult">
  47. <summary>
  48. This class encapsulates a hand-eye calibration validation result.
  49. It contains
  50. a camera calibration validation result with 2D and 3D residuals to
  51. characterize the accuracy of the camera intrinsic parameters, and 3D residuals
  52. to characterize the accuracy of the whole hand-eye system. These
  53. residuals objects are intended to be used to determine
  54. whether a system is "out of calibration".
  55. <para> Note that this class is immutable - it may not be changed once
  56. it has been constructed. The usage model for this class is that it
  57. gets factoried by the Cog3DHandEyeCalibrationValidator class and always
  58. contains a hand-eye calibration validation result and 3D residuals.
  59. </para></summary>
  60. </member>
  61. <member name="M:Cognex.VisionPro3D.Cog3DCameraCalibrationValidationResult.GetObjectData(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
  62. <inheritdoc cref="M:Cognex.VisionPro3D.ICog3DBase.GetObjectData(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)" />
  63. </member>
  64. <member name="M:Cognex.VisionPro3D.Cog3DCameraCalibrationValidationResult.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
  65. <inheritdoc cref="M:Cognex.VisionPro3D.ICog3DBase.SerializationConstructor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)" />
  66. </member>
  67. <member name="M:Cognex.VisionPro3D.Cog3DCameraCalibrationValidationResult.ToString">
  68. <inheritdoc cref="M:Cognex.VisionPro3D.ICog3DBase.ToString" />
  69. </member>
  70. <member name="P:Cognex.VisionPro3D.Cog3DCameraCalibrationValidationResult.RmsOfResidualsPhys3D">
  71. <summary>
  72. Gets the RMS error of the RMS errors of the Phys3D residuals
  73. for each combination of calibration plate pose and camera.
  74. </summary>
  75. <value>
  76. The RMS error of the RMS errors of the Phys3D residuals
  77. for each combination of calibration plate pose and camera.
  78. </value>
  79. <remarks>
  80. This value can be used as an overall accuracy metric for all
  81. the cameras and camera calibrations in the system.
  82. </remarks>
  83. </member>
  84. <member name="P:Cognex.VisionPro3D.Cog3DCameraCalibrationValidationResult.RmsOfResidualsRaw2D">
  85. <summary>
  86. Gets the RMS error of the RMS errors of the Raw2D residuals
  87. for each combination of calibration plate pose and camera.
  88. </summary>
  89. <value>
  90. The RMS error of the RMS errors of the Raw2D residuals
  91. for each combination of calibration plate pose and camera.
  92. </value>
  93. <remarks>
  94. This value can be used as an overall accuracy metric for all
  95. the cameras and camera calibrations in the system.
  96. </remarks>
  97. </member>
  98. <member name="P:Cognex.VisionPro3D.Cog3DCameraCalibrationValidationResult.CameraCalibrationResult">
  99. <summary>
  100. Gets the camera calibration result for all the calibration plate poses and for all the cameras.
  101. </summary>
  102. <value>
  103. The camera calibration result.
  104. </value>
  105. </member>
  106. <member name="M:Cognex.VisionPro3D.Cog3DCameraCalibrationValidationResult.Finalize">
  107. <inheritdoc cref="M:Cognex.VisionPro3D.ICog3DBase.FinalizerForThisClass" />
  108. </member>
  109. <member name="M:Cognex.VisionPro3D.Cog3DCameraCalibrationValidationResult.Dispose">
  110. <inheritdoc cref="M:Cognex.VisionPro3D.ICog3DBase.DestructorForThisClass" />
  111. </member>
  112. <member name="M:Cognex.VisionPro3D.Cog3DCameraCalibrationValidationResult.#ctor(Cognex.VisionPro3D.Cog3DCameraCalibrationValidationResult)">
  113. <inheritdoc cref="M:Cognex.VisionPro3D.ICog3DBase.DeepCopyConstructorForThisClass(System.Object)" />
  114. </member>
  115. <member name="T:Cognex.VisionPro3D.Cog3DCameraCalibrationValidationResult">
  116. <summary>
  117. This class encapsulates the results of a 3D camera calibration validation.
  118. It contains a 3D camera calibration result and two RMS error values.
  119. The two RMS error values are the RMS error of the
  120. RMS errors in the residuals observed over all of the calibration plate poses
  121. for all the cameras.
  122. One RMS error value is the RMS error observed for raw image 2D residuals.
  123. The other RMS error value is the RMS error observed for the physical 3D residuals.
  124. These RMS error values are designed to be used to determine thresholds
  125. for whether a system is "out of calibration".
  126. <para> Note that this class is immutable - it may not be changed once
  127. it has been constructed. The usage model for this class is that it
  128. gets factoried by the Cog3DCameraCalibrationValidator class and always
  129. contains the results from a camera calibration validation.
  130. </para></summary>
  131. </member>
  132. <member name="M:Cognex.VisionPro3D.Cog3DHandEyeCalibrationResult.GetObjectData(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
  133. <inheritdoc cref="M:Cognex.VisionPro3D.ICog3DBase.GetObjectData(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)" />
  134. </member>
  135. <member name="M:Cognex.VisionPro3D.Cog3DHandEyeCalibrationResult.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
  136. <inheritdoc cref="M:Cognex.VisionPro3D.ICog3DBase.SerializationConstructor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)" />
  137. </member>
  138. <member name="M:Cognex.VisionPro3D.Cog3DHandEyeCalibrationResult.ToString">
  139. <inheritdoc cref="M:Cognex.VisionPro3D.ICog3DBase.ToString" />
  140. </member>
  141. <member name="M:Cognex.VisionPro3D.Cog3DHandEyeCalibrationResult.CreateCameraCalibWherePhys3DIsHand3D(Cognex.VisionPro3D.Cog3DTransformRigid)">
  142. <summary>
  143. Create the camera calibration for a stationary camera hand-eye calibration
  144. at the supplied robot hand pose.
  145. The physical 3D (Phys3D) space is the Hand 3D space (Hand3D).
  146. </summary>
  147. <param name="robotBase3DFromHand3D">
  148. The current robot hand pose in RobotBase 3D space (RobotBase3D).
  149. </param>
  150. <returns>
  151. The 3D camera calibration composed of the camera intrinsics in this result, and the
  152. stationary camera's extrinsics, derived from the supplied robot hand pose.
  153. </returns>
  154. <exception cref="T:System.ArgumentNullException">
  155. If the input argument is null.
  156. </exception>
  157. <exception cref="T:System.InvalidOperationException">
  158. If IsCameraMoving would return true.
  159. </exception>
  160. </member>
  161. <member name="M:Cognex.VisionPro3D.Cog3DHandEyeCalibrationResult.CreateCameraCalibWherePhys3DIsRobotBase3D(Cognex.VisionPro3D.Cog3DTransformRigid)">
  162. <summary>
  163. Create the camera calibration for a moving camera hand-eye calibration,
  164. at the supplied robot hand pose.
  165. The physical 3D space (Phys3D) is the RobotBase 3D space (RobotBase3D).
  166. </summary>
  167. <param name="robotBase3DFromHand3D">
  168. The current robot hand pose in RobotBase 3D space (RobotBase3D).
  169. </param>
  170. <returns>
  171. The 3D camera calibration composed of the camera intrinsics in this result, and the
  172. moving camera's extrinsics, derived from the supplied robot hand pose.
  173. </returns>
  174. <exception cref="T:System.ArgumentNullException">
  175. If the input argument is null.
  176. </exception>
  177. <exception cref="T:System.InvalidOperationException">
  178. If IsCameraMoving would return false.
  179. </exception>
  180. </member>
  181. <member name="M:Cognex.VisionPro3D.Cog3DHandEyeCalibrationResult.CreateCameraCalibWherePhys3DIsRobotBase3D">
  182. <summary>
  183. Create the camera calibration for a stationary camera hand-eye calibration.
  184. The physical 3D space (Phys3D) is the RobotBase 3D space (RobotBase3D).
  185. </summary>
  186. <returns>
  187. The 3D camera calibration composed of the camera intrinsics in this result, and the
  188. stationary camera's extrinsics (in RobotBase 3D space).
  189. </returns>
  190. <exception cref="T:System.InvalidOperationException">
  191. If IsCameraMoving would return true.
  192. </exception>
  193. </member>
  194. <member name="M:Cognex.VisionPro3D.Cog3DHandEyeCalibrationResult.CreateCameraCalib(Cognex.VisionPro3D.Cog3DTransformRigid)">
  195. <summary>
  196. Create the camera calibration based on the supplied camera extrinsics.
  197. </summary>
  198. <param name="cam3DFromPhys3D">
  199. The camera extrinsics. This rigid 3D transform maps points from the
  200. physical 3D space (Phys3D) into the camera 3D space (Camera3D).
  201. </param>
  202. <returns>
  203. The 3D camera calibration composed of the camera intrinsics in this result, and the
  204. supplied camera extrinsics.
  205. </returns>
  206. <exception cref="T:System.ArgumentNullException">
  207. If the input argument is null.
  208. </exception>
  209. </member>
  210. <member name="P:Cognex.VisionPro3D.Cog3DHandEyeCalibrationResult.Raw2DFromCamera2D">
  211. <summary>
  212. Gets the camera intrinsics (which correspond to the mapping from Camera2D space
  213. (the z=1 plane in front of the camera) to Raw2D image space).
  214. </summary>
  215. <value>
  216. The camera intrinsics (which correspond to the mapping from Camera2D space
  217. (the z=1 plane in front of the camera) to Raw2D image space).
  218. </value>
  219. </member>
  220. <member name="P:Cognex.VisionPro3D.Cog3DHandEyeCalibrationResult.RobotBase3DFromStationaryCamera3D">
  221. <summary>
  222. Gets the transformation from Camera3D to RobotBase3D for a stationary camera/moving plate
  223. calibration. The returned transformation maps points from the calibrated camera 3D
  224. space to robot base 3D space.
  225. </summary>
  226. <value>
  227. The transformation from Camera3D to RobotBase3D for a stationary camera/moving plate
  228. calibration.
  229. </value>
  230. <exception cref="T:System.InvalidOperationException">
  231. If this is a moving camera calibration.
  232. </exception>
  233. </member>
  234. <member name="P:Cognex.VisionPro3D.Cog3DHandEyeCalibrationResult.MovingCamera3DFromHand3D">
  235. <summary>
  236. Gets the hand-eye transformation for a moving camera/stationary plate
  237. calibration.
  238. The returned transformation maps points from the robot hand 3D space (Hand3D) to
  239. the calibrated camera 3D space (Camera3D).
  240. </summary>
  241. <value>
  242. The hand-eye transformation for a moving camera/stationary plate
  243. calibration.
  244. </value>
  245. <exception cref="T:System.InvalidOperationException">
  246. If this is a stationary camera calibration.
  247. </exception>
  248. </member>
  249. <member name="P:Cognex.VisionPro3D.Cog3DHandEyeCalibrationResult.PositionResidualsPhys3D">
  250. <summary>
  251. Gets the overall residual statistics. These statistics represent all mapped samples
  252. from all stations.
  253. </summary>
  254. <value>
  255. The overall residual statistics.
  256. </value>
  257. <exception cref="T:System.Exception">
  258. If this result has no valid residual statistics.
  259. </exception>
  260. </member>
  261. <member name="P:Cognex.VisionPro3D.Cog3DHandEyeCalibrationResult.IsResidualsComputed">
  262. <summary>
  263. Gets whether this result contains valid residual statistics.
  264. </summary>
  265. <value>
  266. Whether this result contains valid residual statistics.
  267. </value>
  268. </member>
  269. <member name="P:Cognex.VisionPro3D.Cog3DHandEyeCalibrationResult.CalibRoiRaw2D">
  270. <summary>
  271. Gets the region of interest of the raw acquired calibration image (the field of view
  272. of the calibrated camera).
  273. </summary>
  274. <value>
  275. The region of interest of the raw acquired calibration image (the field of view
  276. of the calibrated camera).
  277. </value>
  278. </member>
  279. <member name="P:Cognex.VisionPro3D.Cog3DHandEyeCalibrationResult.IsCameraMoving">
  280. <summary>
  281. Gets whether this is a moving camera hand-eye calibration result.
  282. </summary>
  283. <value>
  284. True if this is a moving camera hand-eye calibration result; False otherwise.
  285. </value>
  286. </member>
  287. <member name="M:Cognex.VisionPro3D.Cog3DHandEyeCalibrationResult.Finalize">
  288. <inheritdoc cref="M:Cognex.VisionPro3D.ICog3DBase.FinalizerForThisClass" />
  289. </member>
  290. <member name="M:Cognex.VisionPro3D.Cog3DHandEyeCalibrationResult.Dispose">
  291. <inheritdoc cref="M:Cognex.VisionPro3D.ICog3DBase.DestructorForThisClass" />
  292. </member>
  293. <member name="M:Cognex.VisionPro3D.Cog3DHandEyeCalibrationResult.#ctor(Cognex.VisionPro3D.Cog3DHandEyeCalibrationResult)">
  294. <inheritdoc cref="M:Cognex.VisionPro3D.ICog3DBase.DeepCopyConstructorForThisClass(System.Object)" />
  295. </member>
  296. <member name="M:Cognex.VisionPro3D.Cog3DHandEyeCalibrationResult.#ctor">
  297. <summary>
  298. Construct this default Cog3DHandEyeCalibrationResult.
  299. </summary>
  300. </member>
  301. <member name="T:Cognex.VisionPro3D.Cog3DHandEyeCalibrationResult">
  302. <summary>
  303. This class encapsulates a hand-eye calibration result.
  304. Note that this class is immutable - it may not be changed once
  305. it has been constructed. The usage model for this class is that it
  306. gets factoried by the Cog3DHandEyeCalibrator class and always
  307. contains a hand-eye calibration result.
  308. </summary>
  309. </member>
  310. <member name="M:Cognex.VisionPro3D.Cog3DCameraCalibrationResult.GetObjectData(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
  311. <inheritdoc cref="M:Cognex.VisionPro3D.ICog3DBase.GetObjectData(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)" />
  312. </member>
  313. <member name="M:Cognex.VisionPro3D.Cog3DCameraCalibrationResult.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
  314. <inheritdoc cref="M:Cognex.VisionPro3D.ICog3DBase.SerializationConstructor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)" />
  315. </member>
  316. <member name="M:Cognex.VisionPro3D.Cog3DCameraCalibrationResult.ToString">
  317. <inheritdoc cref="M:Cognex.VisionPro3D.ICog3DBase.ToString" />
  318. </member>
  319. <member name="M:Cognex.VisionPro3D.Cog3DCameraCalibrationResult.ExportToCVLArchive(System.String)">
  320. <summary>
  321. Convert this camera calibration result to a cc3DCameraCalibResult and export to a CVL archive file.
  322. </summary>
  323. <param name="pathOfCVLArchiveFile">
  324. The path of CVL archive file to store the camera calibration result. May not be null or empty.
  325. </param>
  326. <exception cref="T:System.ArgumentException">
  327. If the input argument is null or an empty string.
  328. </exception>
  329. </member>
  330. <member name="M:Cognex.VisionPro3D.Cog3DCameraCalibrationResult.ImportFromCVLArchive(System.String)">
  331. <summary>
  332. Import a cc3DCameraCalibResult from a CVL archive file.
  333. </summary>
  334. <param name="pathOfCVLArchiveFile">
  335. The path of the CVL archive file containing the camera calibration result. May not be null or empty.
  336. </param>
  337. <exception cref="T:System.ArgumentException">
  338. If the input argument is null or an empty string.
  339. </exception>
  340. <returns>
  341. A converted 3D camera calibration result.
  342. </returns>
  343. </member>
  344. <member name="M:Cognex.VisionPro3D.Cog3DCameraCalibrationResult.GetRaw2DFromCamera2Ds">
  345. <summary>
  346. Get the camera intrinsics from the camera calibration result.
  347. </summary>
  348. <returns>
  349. The list of camera intrinsics for all cameras.
  350. </returns>
  351. </member>
  352. <member name="P:Cognex.VisionPro3D.Cog3DCameraCalibrationResult.FeatureCoverageOfCameraPlate(System.Int32,System.Int32)">
  353. <summary>
  354. Gets the proportion of a particular camera's field of view which was covered
  355. by the convex hull of the feature correspondences found in the particular
  356. calibration plate pose.
  357. </summary>
  358. <param name="cameraIndex">
  359. The zero-based index of the camera.
  360. </param>
  361. <param name="platePoseIndex">
  362. The zero-based index of the calibration plate pose.
  363. </param>
  364. <value>
  365. The proportion of the specified camera's field of view which was covered
  366. by the convex hull of the feature correspondences found in the specified calibration
  367. plate pose.
  368. </value>
  369. </member>
  370. <member name="P:Cognex.VisionPro3D.Cog3DCameraCalibrationResult.FeatureCoverageOfCamera(System.Int32)">
  371. <summary>
  372. Gets the proportion of a particular camera's field of view which was covered
  373. by the convex hull of the feature correspondences found in all calibration plate poses.
  374. </summary>
  375. <param name="cameraIndex">
  376. The zero-based index of the camera.
  377. </param>
  378. <value>
  379. The proportion of the specified camera's field of view which was covered
  380. by the convex hull of the feature correspondences found in all calibration
  381. plate poses.
  382. </value>
  383. </member>
  384. <member name="P:Cognex.VisionPro3D.Cog3DCameraCalibrationResult.NumCorrespondences(System.Int32,System.Int32)">
  385. <summary>
  386. Gets the number of correspondences found for
  387. a particular calibration plate pose and a particular camera.
  388. </summary>
  389. <param name="cameraIndex">
  390. The zero-based index of the camera.
  391. </param>
  392. <param name="platePoseIndex">
  393. The zero-based index of the calibration plate pose.
  394. </param>
  395. <value>
  396. The number of correspondences found for the specified calibration plate pose and the specified camera.
  397. </value>
  398. </member>
  399. <member name="P:Cognex.VisionPro3D.Cog3DCameraCalibrationResult.ResidualsPhys3D(System.Int32,System.Int32)">
  400. <summary>
  401. Gets the residual statistics in Phys3D for the specified calibration plate pose and the specified camera.
  402. </summary>
  403. <param name="cameraIndex">
  404. The zero-based index of the camera.
  405. </param>
  406. <param name="platePoseIndex">
  407. The zero-based index of the calibration plate pose.
  408. </param>
  409. <value>
  410. The residual statistics in Phys3D for the specified calibration plate pose and the specified camera.
  411. </value>
  412. <inheritdoc cref="P:Cognex.VisionPro3D.ICog3DBase.ResidualsPhys3DCalibration" />
  413. </member>
  414. <member name="P:Cognex.VisionPro3D.Cog3DCameraCalibrationResult.ResidualsRaw2D(System.Int32,System.Int32)">
  415. <summary>
  416. Gets the residual statistics in Raw2D for the specified calibration plate pose and the specified camera.
  417. </summary>
  418. <param name="cameraIndex">
  419. The zero-based index of the camera.
  420. </param>
  421. <param name="platePoseIndex">
  422. The zero-based index of the calibration plate pose.
  423. </param>
  424. <value>
  425. The residual statistics in Raw2D for the specified calibration plate pose and the specified camera.
  426. </value>
  427. <inheritdoc cref="P:Cognex.VisionPro3D.ICog3DBase.ResidualsRaw2DCalibration" />
  428. </member>
  429. <member name="P:Cognex.VisionPro3D.Cog3DCameraCalibrationResult.OverallResidualsRaw2D">
  430. <summary>
  431. Gets the overall residual statistics in Raw2D (over all cameras and over all calibration plate poses).
  432. </summary>
  433. <value>
  434. The overall residual statistics in Raw2D.
  435. </value>
  436. <inheritdoc cref="P:Cognex.VisionPro3D.ICog3DBase.ResidualsRaw2DCalibration" />
  437. </member>
  438. <member name="P:Cognex.VisionPro3D.Cog3DCameraCalibrationResult.OverallResidualsPhys3D">
  439. <summary>
  440. Gets the overall residual statistics in Phys3D (over all cameras and over all calibration plate poses).
  441. </summary>
  442. <value>
  443. The overall residual statistics in Phys3D.
  444. </value>
  445. <inheritdoc cref="P:Cognex.VisionPro3D.ICog3DBase.ResidualsPhys3DCalibration" />
  446. </member>
  447. <member name="P:Cognex.VisionPro3D.Cog3DCameraCalibrationResult.MaximumTilt">
  448. <summary>
  449. Gets the maximum tilt of the calibration plate over all
  450. the measured poses.
  451. </summary>
  452. <value>
  453. The maximum tilt of the calibration plate.
  454. </value>
  455. </member>
  456. <member name="P:Cognex.VisionPro3D.Cog3DCameraCalibrationResult.CalPlate3DFromCamera3D(System.Int32,System.Int32)">
  457. <summary>
  458. Gets the pose of a particular camera relative to the calibration plate at a particular
  459. calibration plate pose index.
  460. </summary>
  461. <param name="cameraIndex">
  462. The zero-based index of the camera.
  463. </param>
  464. <param name="platePoseIndex">
  465. The zero-based index of the calibration plate pose.
  466. </param>
  467. <value>
  468. The pose of a particular camera relative to the calibration plate at the specified calibration
  469. plate pose index.
  470. </value>
  471. <exception cref="T:System.ArgumentException">
  472. If <paramref name="platePoseIndex" /> is out of range [0, NumCalPlatePoses-1], or
  473. <paramref name="cameraIndex" /> is out of range [0, NumCameras-1].
  474. </exception>
  475. </member>
  476. <member name="P:Cognex.VisionPro3D.Cog3DCameraCalibrationResult.NumCalPlatePoses">
  477. <summary>
  478. Gets the number of calibration plate poses, i.e., the number of views.
  479. </summary>
  480. <value>
  481. The number of calibration plate poses.
  482. </value>
  483. </member>
  484. <member name="P:Cognex.VisionPro3D.Cog3DCameraCalibrationResult.NumCameras">
  485. <summary>
  486. Gets the number of cameras inside this camera calibration result.
  487. </summary>
  488. <value>
  489. The number of cameras.
  490. </value>
  491. </member>
  492. <member name="P:Cognex.VisionPro3D.Cog3DCameraCalibrationResult.Camera3DFromPhys3D(System.Int32)">
  493. <summary>
  494. Gets the transform between the specified camera and the physical
  495. coordinate system (Phys3D). The physical coordinate system
  496. corresponds to the view having pose type PoseDefineWorldCoord.
  497. </summary>
  498. <param name="cameraIndex">
  499. The zero-based index of the camera.
  500. </param>
  501. <value>
  502. The transform between the specified camera and the physical
  503. coordinate system (Phys3D).
  504. </value>
  505. <exception cref="T:System.ArgumentException">
  506. If <paramref name="cameraIndex" /> is out of range [0, NumCameras-1].
  507. </exception>
  508. </member>
  509. <member name="M:Cognex.VisionPro3D.Cog3DCameraCalibrationResult.GetPhys3DFromCalPlate3Ds">
  510. <summary>
  511. Get the calibration plate poses computed by the 3D camera calibration
  512. algorithm. The poses are computed with respect to the calibration plate
  513. pose which defines the world coordinates (which is equivalent to Phys3D).
  514. </summary>
  515. <returns>
  516. A list of calibration plate poses.
  517. </returns>
  518. </member>
  519. <member name="M:Cognex.VisionPro3D.Cog3DCameraCalibrationResult.GetRaw2DFromPhys3Ds">
  520. <summary>
  521. Get the calibrations computed by the 3D camera calibration
  522. algorithm.
  523. </summary>
  524. <returns>
  525. The list of camera calibrations.
  526. </returns>
  527. </member>
  528. <member name="M:Cognex.VisionPro3D.Cog3DCameraCalibrationResult.Finalize">
  529. <inheritdoc cref="M:Cognex.VisionPro3D.ICog3DBase.FinalizerForThisClass" />
  530. </member>
  531. <member name="M:Cognex.VisionPro3D.Cog3DCameraCalibrationResult.Dispose">
  532. <inheritdoc cref="M:Cognex.VisionPro3D.ICog3DBase.DestructorForThisClass" />
  533. </member>
  534. <member name="M:Cognex.VisionPro3D.Cog3DCameraCalibrationResult.#ctor(Cognex.VisionPro3D.Cog3DCameraCalibrationResult)">
  535. <inheritdoc cref="M:Cognex.VisionPro3D.ICog3DBase.DeepCopyConstructorForThisClass(System.Object)" />
  536. </member>
  537. <member name="T:Cognex.VisionPro3D.Cog3DCameraCalibrationResult">
  538. <summary>
  539. This class holds 3D camera calibration result. It contains the
  540. set of Cog3DCameraCalibration for all the cameras.
  541. Note that this class is immutable - it may not be changed once
  542. it has been constructed. The usage model for this class is that it
  543. gets factoried by the Cog3DCameraCalibrator class and *always*
  544. contains a camera calibration result. Note that in camera calibration,
  545. Phys3D is the coordinate space defined by the calibration plate pose
  546. with pose type of Cog3DCalibrationPlatePoseTypeConstants.PoseDefineWorldCoord.
  547. </summary>
  548. </member>
  549. <member name="M:Cognex.VisionPro3D.Cog3DCameraCalibration.GetObjectData(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
  550. <inheritdoc cref="M:Cognex.VisionPro3D.ICog3DBase.GetObjectData(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)" />
  551. </member>
  552. <member name="M:Cognex.VisionPro3D.Cog3DCameraCalibration.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
  553. <inheritdoc cref="M:Cognex.VisionPro3D.ICog3DBase.SerializationConstructor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)" />
  554. </member>
  555. <member name="M:Cognex.VisionPro3D.Cog3DCameraCalibration.ExportToCVLArchive(System.String)">
  556. <summary>
  557. Convert this camera calibration to a cc3DCameraCalib and export to a CVL archive file.
  558. </summary>
  559. <param name="pathOfCVLArchiveFile">
  560. The path of CVL archive file to store the camera calibration. May not be null or empty.
  561. </param>
  562. <exception cref="T:System.ArgumentException">
  563. If the input argument is null or an empty string.
  564. </exception>
  565. </member>
  566. <member name="M:Cognex.VisionPro3D.Cog3DCameraCalibration.ImportFromCVLArchive(System.String)">
  567. <summary>
  568. Import a cc3DCameraCalib from a CVL archive file.
  569. </summary>
  570. <param name="pathOfCVLArchiveFile">
  571. The path of the CVL archive file containing the camera calibration. May not be null or empty.
  572. </param>
  573. <exception cref="T:System.ArgumentException">
  574. If the input argument is null or an empty string.
  575. </exception>
  576. <returns>
  577. A converted 3D camera calibration.
  578. </returns>
  579. </member>
  580. <member name="M:Cognex.VisionPro3D.Cog3DCameraCalibration.RealEqual(Cognex.VisionPro3D.Cog3DCameraCalibration,Cognex.VisionPro3D.Cog3DCameraCalibration,System.Double)">
  581. <inheritdoc cref="M:Cognex.VisionPro3D.ICog3DBase.RealEqual(System.Object,System.Object,System.Double)" />
  582. </member>
  583. <member name="M:Cognex.VisionPro3D.Cog3DCameraCalibration.ToString">
  584. <inheritdoc cref="M:Cognex.VisionPro3D.ICog3DBase.ToString" />
  585. </member>
  586. <member name="M:Cognex.VisionPro3D.Cog3DCameraCalibration.op_Multiply(Cognex.VisionPro3D.Cog3DCameraCalibration,Cognex.VisionPro3D.Cog3DVect3)">
  587. <summary>
  588. Operator for mapping a 3D physical position to a Raw2D image position using the specified camera calibration.
  589. </summary>
  590. <param name="cameraCalibration">
  591. The specified camera calibration. May not be null.
  592. </param>
  593. <param name="pointPhys3D">
  594. The 3D point in Phys3D to map using the specified camera calibration.
  595. </param>
  596. <returns>
  597. The mapped point in Raw2D.
  598. </returns>
  599. <exception cref="T:System.ArgumentNullException">
  600. If <paramref name="cameraCalibration" /> is null.
  601. </exception>
  602. </member>
  603. <member name="M:Cognex.VisionPro3D.Cog3DCameraCalibration.CloneComposeWithPhys3DFromAny3D(Cognex.VisionPro3D.Cog3DTransformRigid)">
  604. <summary>
  605. <para> Create a new camera calibration by composing the current
  606. Camera3DFromPhys3D transform with the specified
  607. Phys3DFromAny3D transform. The value of camera3DFromPhys3D in the new camera calibration object
  608. becomes </para>
  609. <para> Camera3DFromPhys3D * <paramref name="phys3DFromAny3D" /></para>
  610. </summary>
  611. <param name="phys3DFromAny3D">
  612. The transform from a 3D space to the current camera calibration's Phys3D. May not be null.
  613. </param>
  614. <returns>
  615. The created camera calibration.
  616. </returns>
  617. <exception cref="T:System.ArgumentNullException">
  618. If <paramref name="phys3DFromAny3D" /> is null.
  619. </exception>
  620. </member>
  621. <member name="M:Cognex.VisionPro3D.Cog3DCameraCalibration.CloneWithNewCamera3DFromPhys3D(Cognex.VisionPro3D.Cog3DTransformRigid)">
  622. <summary>
  623. Create a new camera calibration by using the specified
  624. Camera3DFromPhys3D transform.
  625. </summary>
  626. <param name="newCamera3DFromPhys3D">
  627. The new Camera3DFromPhys3D transform. May not be null.
  628. </param>
  629. <returns>
  630. The created new camera calibration.
  631. </returns>
  632. <exception cref="T:System.ArgumentNullException">
  633. If <paramref name="newCamera3DFromPhys3D" /> is null.
  634. </exception>
  635. </member>
  636. <member name="M:Cognex.VisionPro3D.Cog3DCameraCalibration.ComputeRayPhys3DFromPointRaw2D(Cognex.VisionPro3D.Cog3DVect2)">
  637. <summary>
  638. Compute a 3D ray through the camera origin from the given
  639. 2D image position.
  640. </summary>
  641. <param name="pointRaw2D">
  642. The 2D image point in Raw2D space.
  643. </param>
  644. <returns>
  645. A ray in Phys3D.
  646. </returns>
  647. </member>
  648. <member name="M:Cognex.VisionPro3D.Cog3DCameraCalibration.MapPointFromRaw2DToPhys3D(Cognex.VisionPro3D.Cog3DVect2,Cognex.VisionPro3D.Cog3DPlane,Cognex.VisionPro3D.Cog3DVect3@,Cognex.VisionPro3D.Cog3DShapeIntersectionStatusConstants@)">
  649. <summary>
  650. Map a 2D point from Raw2D to a 3D point in Phys3D. The 3D physical
  651. point is computed by intersecting
  652. the ray corresponding to a 2D raw image point with the given plane in Phys3D.
  653. </summary>
  654. <param name="pointRaw2D">
  655. The 2D point in Raw2D space.
  656. </param>
  657. <param name="planePhys3D">
  658. The 3D plane in Phys3D used for intersection with the ray. May not be null.
  659. </param>
  660. <param name="pointPhys3D">
  661. A reference to the 3D point to store the resulting intersection position between the ray and the plane.
  662. </param>
  663. <param name="resultStatus">
  664. jA reference to the intersection result status to store the intersection status.
  665. </param>
  666. <exception cref="T:System.ArgumentNullException">
  667. If <paramref name="planePhys3D" /> is null.
  668. </exception>
  669. <remarks>
  670. The resultStatus is set to Cog3DShapeIntersectionStatusConstants.Intersect if
  671. <paramref name="pointPhys3D" /> is computed; Otherwise it is set to
  672. Cog3DShapeIntersectionStatusConstants.None, and <paramref name="pointPhys3D" />
  673. is not updated.
  674. </remarks>
  675. </member>
  676. <member name="M:Cognex.VisionPro3D.Cog3DCameraCalibration.MapPointFromPhys3DToRaw2D(Cognex.VisionPro3D.Cog3DVect3)">
  677. <summary>
  678. Project a 3D point from Phys3D to Raw2D.
  679. </summary>
  680. <param name="pointPhys3D">
  681. The 3D point in Phys3D.
  682. </param>
  683. <returns>
  684. The projected point in Raw2D.
  685. </returns>
  686. </member>
  687. <member name="P:Cognex.VisionPro3D.Cog3DCameraCalibration.CalibRoiRaw2D">
  688. <summary>
  689. Gets the region of interest (the field of view) of the raw
  690. acquired image (the field of view of the camera).
  691. </summary>
  692. <value>
  693. The region of interest of the raw acquired image.
  694. </value>
  695. </member>
  696. <member name="P:Cognex.VisionPro3D.Cog3DCameraCalibration.Phys3DFromCamera3D">
  697. <summary>
  698. Get the inverse of the camera extrinsics from this camera calibration.
  699. </summary>
  700. <value>
  701. The 3D transform that corresponds to Phys3D space from Camera3D space.
  702. </value>
  703. </member>
  704. <member name="P:Cognex.VisionPro3D.Cog3DCameraCalibration.Camera3DFromPhys3D">
  705. <summary>
  706. Get the camera extrinsics from this camera calibration.
  707. </summary>
  708. <value>
  709. The camera extrinsics that correspond to the
  710. position of the camera with respect to Phys3D space.
  711. </value>
  712. </member>
  713. <member name="P:Cognex.VisionPro3D.Cog3DCameraCalibration.Raw2DFromCamera2D">
  714. <summary>
  715. Gets the camera intrinsic parameters from this camera calibration.
  716. </summary>
  717. <value>
  718. The camera intrinsic parameters.
  719. </value>
  720. </member>
  721. <member name="P:Cognex.VisionPro3D.Cog3DCameraCalibration.IsTelecentric">
  722. <summary>
  723. Gets whether this camera calibration's distortion model is
  724. Cog3DCameraCalibrationDistortionModelConstants::eTelecentric.
  725. </summary>
  726. <value>
  727. True if this camera calibration's distortion model is
  728. Cog3DCameraCalibrationDistortionModelConstants::eTelecentric; False otherwise.
  729. </value>
  730. </member>
  731. <member name="M:Cognex.VisionPro3D.Cog3DCameraCalibration.Finalize">
  732. <inheritdoc cref="M:Cognex.VisionPro3D.ICog3DBase.FinalizerForThisClass" />
  733. </member>
  734. <member name="M:Cognex.VisionPro3D.Cog3DCameraCalibration.Dispose">
  735. <inheritdoc cref="M:Cognex.VisionPro3D.ICog3DBase.DestructorForThisClass" />
  736. </member>
  737. <member name="M:Cognex.VisionPro3D.Cog3DCameraCalibration.#ctor(Cognex.VisionPro3D.Cog3DCameraCalibrationIntrinsics,Cognex.VisionPro3D.Cog3DTransformRigid,System.Drawing.Rectangle)">
  738. <summary>
  739. Construct this Cog3DCameraCalibration using the specified camera intrinsics,
  740. Camera3DFromPhys3D pose, and the specified calibration region of interest.
  741. </summary>
  742. <param name="raw2DFromCamera2D">
  743. The camera intrinsics. May not be null.
  744. </param>
  745. <param name="camera3DFromPhys3D">
  746. The camera extrinsics. May not be null.
  747. </param>
  748. <param name="calibROIRaw2D">
  749. The region of interest (the field of view) of the raw
  750. acquired image (the field of view of the camera). Must be the size of acquired calibration images
  751. for this camera (with origin(0,0)).
  752. </param>
  753. <exception cref="T:System.ArgumentNullException">
  754. If <paramref name="raw2DFromCamera2D" /> or <paramref name="camera3DFromPhys3D" /> is null.
  755. </exception>
  756. <exception cref="T:System.ArgumentException">
  757. If width or height of <paramref name="calibROIRaw2D" /> is equal or less than 0.
  758. </exception>
  759. </member>
  760. <member name="M:Cognex.VisionPro3D.Cog3DCameraCalibration.#ctor(Cognex.VisionPro3D.Cog3DCameraCalibration)">
  761. <inheritdoc cref="M:Cognex.VisionPro3D.ICog3DBase.DeepCopyConstructorForThisClass(System.Object)" />
  762. </member>
  763. <member name="T:Cognex.VisionPro3D.Cog3DCameraCalibration">
  764. <summary>
  765. This class holds intrinsic and extrinsic camera calibration parameters for one
  766. camera.
  767. <para> Note that in camera calibration,
  768. Phys3D is the coordinate space defined by the calibration plate pose
  769. with pose type of Cog3DCalibrationPlatePoseTypeConstants.PoseDefineWorldCoord.
  770. </para><para> Note that this class is immutable - it may not be changed once
  771. it has been constructed. </para></summary>
  772. </member>
  773. <member name="M:Cognex.VisionPro3D.Cog3DCameraCalibrationIntrinsics.GetObjectData(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
  774. <inheritdoc cref="M:Cognex.VisionPro3D.ICog3DBase.GetObjectData(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)" />
  775. </member>
  776. <member name="M:Cognex.VisionPro3D.Cog3DCameraCalibrationIntrinsics.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
  777. <inheritdoc cref="M:Cognex.VisionPro3D.ICog3DBase.SerializationConstructor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)" />
  778. </member>
  779. <member name="M:Cognex.VisionPro3D.Cog3DCameraCalibrationIntrinsics.RealEqual(Cognex.VisionPro3D.Cog3DCameraCalibrationIntrinsics,Cognex.VisionPro3D.Cog3DCameraCalibrationIntrinsics,System.Double)">
  780. <inheritdoc cref="M:Cognex.VisionPro3D.ICog3DBase.RealEqual(System.Object,System.Object,System.Double)" />
  781. </member>
  782. <member name="M:Cognex.VisionPro3D.Cog3DCameraCalibrationIntrinsics.ToString">
  783. <inheritdoc cref="M:Cognex.VisionPro3D.ICog3DBase.ToString" />
  784. </member>
  785. <member name="M:Cognex.VisionPro3D.Cog3DCameraCalibrationIntrinsics.MapPointFromCamera2DToRaw2D(Cognex.VisionPro3D.Cog3DVect2)">
  786. <summary>
  787. Map a 2D point from Camera2D to Raw2D.
  788. </summary>
  789. <param name="pointCamera2D">
  790. The 2D point in Camera2D.
  791. </param>
  792. <returns>
  793. The mapped point.
  794. </returns>
  795. </member>
  796. <member name="M:Cognex.VisionPro3D.Cog3DCameraCalibrationIntrinsics.MapPointFromRaw2DToCamera2D(Cognex.VisionPro3D.Cog3DVect2)">
  797. <summary>
  798. Map a 2D point from Raw2D to Camera2D.
  799. </summary>
  800. <param name="pointRaw2D">
  801. The 2D point in Raw2D.
  802. </param>
  803. <returns>
  804. The mapped point.
  805. </returns>
  806. </member>
  807. <member name="P:Cognex.VisionPro3D.Cog3DCameraCalibrationIntrinsics.DistortionModel">
  808. <summary>
  809. Gets the distortion model.
  810. </summary>
  811. <value>
  812. The distortion model.
  813. </value>
  814. </member>
  815. <member name="M:Cognex.VisionPro3D.Cog3DCameraCalibrationIntrinsics.GetKc">
  816. <summary>
  817. Get the coefficients of lens distortion.
  818. </summary>
  819. <returns>
  820. The coefficients of lens distortion.
  821. </returns>
  822. </member>
  823. <member name="P:Cognex.VisionPro3D.Cog3DCameraCalibrationIntrinsics.Skew">
  824. <summary>
  825. Gets the skew coefficient.
  826. </summary>
  827. <value>
  828. The skew coefficient.
  829. </value>
  830. </member>
  831. <member name="P:Cognex.VisionPro3D.Cog3DCameraCalibrationIntrinsics.Translation">
  832. <summary>
  833. Gets the x and y translations.
  834. </summary>
  835. <value>
  836. The x and y translations.
  837. </value>
  838. </member>
  839. <member name="P:Cognex.VisionPro3D.Cog3DCameraCalibrationIntrinsics.Scale">
  840. <summary>
  841. Gets the x and y scales.
  842. </summary>
  843. <value>
  844. The x and y scales.
  845. </value>
  846. </member>
  847. <member name="M:Cognex.VisionPro3D.Cog3DCameraCalibrationIntrinsics.Finalize">
  848. <inheritdoc cref="M:Cognex.VisionPro3D.ICog3DBase.FinalizerForThisClass" />
  849. </member>
  850. <member name="M:Cognex.VisionPro3D.Cog3DCameraCalibrationIntrinsics.Dispose">
  851. <inheritdoc cref="M:Cognex.VisionPro3D.ICog3DBase.DestructorForThisClass" />
  852. </member>
  853. <member name="M:Cognex.VisionPro3D.Cog3DCameraCalibrationIntrinsics.#ctor(Cognex.VisionPro3D.Cog3DCameraCalibrationIntrinsics)">
  854. <inheritdoc cref="M:Cognex.VisionPro3D.ICog3DBase.DeepCopyConstructorForThisClass(System.Object)" />
  855. </member>
  856. <member name="M:Cognex.VisionPro3D.Cog3DCameraCalibrationIntrinsics.#ctor(Cognex.VisionPro3D.Cog3DVect2,System.Double,Cognex.VisionPro3D.Cog3DVect2,Cognex.VisionPro3D.Cog3DCameraCalibrationDistortionModelConstants,Cognex.VisionPro3D.Cog3DScalarCollection)">
  857. <summary>
  858. Construct this Cog3DCameraCalibrationIntrinsics using the specified camera intrinsics parameters.
  859. </summary>
  860. <param name="scale">
  861. The x and y scales.
  862. </param>
  863. <param name="translation">
  864. The x and y translations.
  865. </param>
  866. <param name="skew">
  867. The skew coefficient.
  868. </param>
  869. <param name="distortionModel">
  870. The distortion model.
  871. </param>
  872. <param name="kc">
  873. The coefficients of lens distortion. Note that the number of elements in Kc must match the distortion model <paramref name="distortionModel" />.
  874. </param>
  875. <exception cref="T:System.ArgumentException">
  876. <list type="bullet">
  877. <item>
  878. If <paramref name="scale" />.X is less or equal to 0, or <paramref name="scale" />.Y is less or equal to 0.
  879. </item>
  880. <item>
  881. If <paramref name="kc" /> does not have the number of coefficients required for <paramref name="distortionModel" />.
  882. </item>
  883. </list>
  884. </exception>
  885. </member>
  886. <member name="T:Cognex.VisionPro3D.Cog3DCameraCalibrationIntrinsics">
  887. <summary>
  888. This class holds camera intrinsic parameters. These
  889. parameters include: two scales, skew, translation
  890. and coefficients of radial distortion.
  891. Note that this class is immutable - it may not be changed once
  892. it has been constructed.
  893. </summary>
  894. </member>
  895. <member name="T:Cognex.VisionPro3D.Cog3DCameraCalibrationDistortionModelConstants">
  896. <summary>
  897. This class defines enumeration constants used for calibration distortion model.
  898. </summary>
  899. </member>
  900. <member name="F:Cognex.VisionPro3D.Cog3DCameraCalibrationDistortionModelConstants.eTelecentric">
  901. <summary>
  902. Supported in 3D camera calibration, and used for telecentric lenses.
  903. </summary>
  904. </member>
  905. <member name="F:Cognex.VisionPro3D.Cog3DCameraCalibrationDistortionModelConstants.e3ParamRadial">
  906. <summary>
  907. Supported in 3D camera calibration, and may be used for “low distortion”
  908. lenses – where the distortion is not apparent to the human eye – but where
  909. distortion correction can improve accuracy performance nonetheless.
  910. </summary>
  911. </member>
  912. <member name="F:Cognex.VisionPro3D.Cog3DCameraCalibrationDistortionModelConstants.eNoDistortion">
  913. <summary>
  914. Supported in 3D camera calibration, and may be used for ideal lenses without distortion.
  915. </summary>
  916. </member>
  917. <member name="F:Cognex.VisionPro3D.Cog3DCameraCalibrationDistortionModelConstants.eSineTanLawProjection">
  918. <summary>
  919. Supported in 3D camera calibration, and may be used for “high distortion”
  920. lenses – short focal length lenses which exhibit apparent distortion.
  921. </summary>
  922. </member>
  923. <member name="M:Cognex.VisionPro3D.Cog3DPositionResiduals.RealEqual(Cognex.VisionPro3D.Cog3DPositionResiduals,Cognex.VisionPro3D.Cog3DPositionResiduals,System.Double)">
  924. <inheritdoc cref="M:Cognex.VisionPro3D.ICog3DBase.RealEqual(System.Object,System.Object,System.Double)" />
  925. </member>
  926. <member name="M:Cognex.VisionPro3D.Cog3DPositionResiduals.op_Inequality(Cognex.VisionPro3D.Cog3DPositionResiduals,Cognex.VisionPro3D.Cog3DPositionResiduals)">
  927. <summary>
  928. Compare two Cog3DPositionResiduals.
  929. </summary>
  930. <param name="alpha">
  931. The first PositionResiduals.
  932. </param>
  933. <param name="beta">
  934. The second PositionResiduals.
  935. </param>
  936. <returns>
  937. False if exactly equal, true otherwise.
  938. </returns>
  939. </member>
  940. <member name="M:Cognex.VisionPro3D.Cog3DPositionResiduals.op_Equality(Cognex.VisionPro3D.Cog3DPositionResiduals,Cognex.VisionPro3D.Cog3DPositionResiduals)">
  941. <summary>
  942. Compare two Cog3DPositionResiduals.
  943. </summary>
  944. <param name="alpha">
  945. The first PositionResiduals.
  946. </param>
  947. <param name="beta">
  948. The second PositionResiduals.
  949. </param>
  950. <returns>
  951. True if exactly equal, false otherwise.
  952. </returns>
  953. </member>
  954. <member name="M:Cognex.VisionPro3D.Cog3DPositionResiduals.ToString">
  955. <inheritdoc cref="M:Cognex.VisionPro3D.ICog3DBase.ToString" />
  956. </member>
  957. <member name="P:Cognex.VisionPro3D.Cog3DPositionResiduals.ResidualsDistance">
  958. <summary>
  959. Gets the residual statistics based on Euclidian distance.
  960. </summary>
  961. <value>
  962. The residual statistics based on Euclidian distance.
  963. </value>
  964. </member>
  965. <member name="P:Cognex.VisionPro3D.Cog3DPositionResiduals.ResidualsZ">
  966. <summary>
  967. Gets the residual statistics based on distance measured solely along the "z" axis.
  968. </summary>
  969. <value>
  970. The residual statistics based on distance measured solely along the "z" axis.
  971. </value>
  972. </member>
  973. <member name="P:Cognex.VisionPro3D.Cog3DPositionResiduals.ResidualsY">
  974. <summary>
  975. Gets the residual statistics based on distance measured solely along the "y" axis.
  976. </summary>
  977. <value>
  978. The residual statistics based on distance measured solely along the "y" axis.
  979. </value>
  980. </member>
  981. <member name="P:Cognex.VisionPro3D.Cog3DPositionResiduals.ResidualsX">
  982. <summary>
  983. Gets the residual statistics based on distance measured solely along the "x" axis.
  984. </summary>
  985. <value>
  986. The residual statistics based on distance measured solely along the "x" axis.
  987. </value>
  988. </member>
  989. <member name="M:Cognex.VisionPro3D.Cog3DPositionResiduals.#ctor(Cognex.VisionPro3D.Cog3DResiduals,Cognex.VisionPro3D.Cog3DResiduals,Cognex.VisionPro3D.Cog3DResiduals,Cognex.VisionPro3D.Cog3DResiduals)">
  990. <summary>
  991. Construct this Cog3DPositionResiduals with the supplied values.
  992. </summary>
  993. <param name="initialX">
  994. The initial ResidualsX value.
  995. </param>
  996. <param name="initialY">
  997. The initial ResidualsY value.
  998. </param>
  999. <param name="initialZ">
  1000. The initial ResidualsZ value.
  1001. </param>
  1002. <param name="initialDistance">
  1003. The initial ResidualsDistance value.
  1004. </param>
  1005. </member>
  1006. <member name="T:Cognex.VisionPro3D.Cog3DPositionResiduals">
  1007. <summary>
  1008. This value class holds residual error statistics for a collection of 3D locations.
  1009. This class lets you obtain both maximum and RMS error for differences in the x-, y-, and
  1010. z-directions as well as for the Euclidean distance between expected and actual points.
  1011. Note that this class is immutable - it may not be changed once
  1012. it has been constructed.
  1013. <para>
  1014. The default values for properties ResidualsX, ResidualsY, ResidualsZ, and ResidualsDistance are
  1015. default constructed Cog3DResiduals.
  1016. </para></summary>
  1017. </member>
  1018. <member name="M:Cognex.VisionPro3D.Cog3DAngleRange.RealEqual(Cognex.VisionPro3D.Cog3DAngleRange,Cognex.VisionPro3D.Cog3DAngleRange,System.Double)">
  1019. <inheritdoc cref="M:Cognex.VisionPro3D.ICog3DBase.RealEqual(System.Object,System.Object,System.Double)" />
  1020. </member>
  1021. <member name="M:Cognex.VisionPro3D.Cog3DAngleRange.ToString">
  1022. <inheritdoc cref="M:Cognex.VisionPro3D.ICog3DBase.ToString" />
  1023. </member>
  1024. <member name="M:Cognex.VisionPro3D.Cog3DAngleRange.op_Inequality(Cognex.VisionPro3D.Cog3DAngleRange,Cognex.VisionPro3D.Cog3DAngleRange)">
  1025. <summary>
  1026. Compare two Cog3DAngleRange's.
  1027. </summary>
  1028. <param name="alpha">
  1029. The first Cog3DAngleRange.
  1030. </param>
  1031. <param name="beta">
  1032. The second Cog3DAngleRange.
  1033. </param>
  1034. <returns>
  1035. False if exactly equal, true otherwise.
  1036. </returns>
  1037. </member>
  1038. <member name="M:Cognex.VisionPro3D.Cog3DAngleRange.op_Equality(Cognex.VisionPro3D.Cog3DAngleRange,Cognex.VisionPro3D.Cog3DAngleRange)">
  1039. <summary>
  1040. Compare two Cog3DAngleRange's.
  1041. </summary>
  1042. <param name="alpha">
  1043. The first Cog3DAngleRange.
  1044. </param>
  1045. <param name="beta">
  1046. The second Cog3DAngleRange.
  1047. </param>
  1048. <returns>
  1049. True if exactly equal, false otherwise.
  1050. </returns>
  1051. </member>
  1052. <member name="M:Cognex.VisionPro3D.Cog3DAngleRange.Dilate(Cognex.VisionPro3D.Cog3DAngleRange)">
  1053. <summary>
  1054. Dilate this angle range by another angle range.
  1055. </summary>
  1056. <param name="other">
  1057. The other angle range.
  1058. </param>
  1059. <returns>
  1060. An angle range characterized by dilating this angle range by <paramref name="other" />.
  1061. </returns>
  1062. </member>
  1063. <member name="M:Cognex.VisionPro3D.Cog3DAngleRange.IsWithin(System.Double)">
  1064. <summary>
  1065. Check whether a value is inside the angle range.
  1066. </summary>
  1067. <param name="value">
  1068. The value (in radians) for checking.
  1069. </param>
  1070. <returns>
  1071. True if <paramref name="value" /> is inside the angle range; false otherwise.
  1072. </returns>
  1073. </member>
  1074. <member name="P:Cognex.VisionPro3D.Cog3DAngleRange.Length">
  1075. <summary>
  1076. Gets the length of the angle range in radians, and is defined as follows:
  1077. <list type="bullet"><item> If RangeType is Cog3DRangeTypeConstants.Full, Length is 2 * Math.PI. </item><item> If RangeType is Cog3DRangeTypeConstants.Empty,Length is 0. </item><item> If RangeType is Cog3DRangeTypeConstants.Partial, Length is (End -Start). </item></list></summary>
  1078. <value>
  1079. The length of the angle range in radians.
  1080. </value>
  1081. </member>
  1082. <member name="P:Cognex.VisionPro3D.Cog3DAngleRange.RangeType">
  1083. <summary>
  1084. Gets the type of the angle range.
  1085. </summary>
  1086. <value>
  1087. The type of the angle range.
  1088. </value>
  1089. </member>
  1090. <member name="P:Cognex.VisionPro3D.Cog3DAngleRange.Middle">
  1091. <summary>
  1092. Gets the middle of the angle range in radians.
  1093. </summary>
  1094. <value>
  1095. The middle of the angle range in radians.
  1096. </value>
  1097. <exception cref="T:Cognex.VisionPro3D.Cog3DException">
  1098. If RangeType is NOT Cog3DRangeTypeConstants.Partial.
  1099. </exception>
  1100. </member>
  1101. <member name="P:Cognex.VisionPro3D.Cog3DAngleRange.End">
  1102. <summary>
  1103. Gets the end value of the angle range in radians.
  1104. </summary>
  1105. <value>
  1106. The end value of the angle range in radians.
  1107. </value>
  1108. <exception cref="T:Cognex.VisionPro3D.Cog3DException">
  1109. If RangeType is NOT Cog3DRangeTypeConstants.Partial.
  1110. </exception>
  1111. </member>
  1112. <member name="P:Cognex.VisionPro3D.Cog3DAngleRange.Start">
  1113. <summary>
  1114. Gets the start value of the angle range in radians.
  1115. </summary>
  1116. <value>
  1117. The start value of the angle range in radians.
  1118. </value>
  1119. <exception cref="T:Cognex.VisionPro3D.Cog3DException">
  1120. If RangeType is NOT Cog3DRangeTypeConstants.Partial.
  1121. </exception>
  1122. </member>
  1123. <member name="M:Cognex.VisionPro3D.Cog3DAngleRange.CreateFullRange">
  1124. <summary>
  1125. Create a full range object.
  1126. </summary>
  1127. <returns>
  1128. A Cog3DAngleRange object with full range.
  1129. </returns>
  1130. </member>
  1131. <member name="M:Cognex.VisionPro3D.Cog3DAngleRange.#ctor(System.Double,System.Double)">
  1132. <summary>
  1133. Construct this Cog3DAngleRange with the given start and end values. Note that if
  1134. <paramref name="end" /> - <paramref name="start" /> &gt; 2*PI, then it constructs
  1135. a full angle range.
  1136. </summary>
  1137. <param name="start">
  1138. The start value of the angle range in radians.
  1139. </param>
  1140. <param name="end">
  1141. The end value of the angle range in radians.
  1142. </param>
  1143. <exception cref="T:System.ArgumentException">
  1144. If <paramref name="start" /> &gt; <paramref name="end" />.
  1145. </exception>
  1146. </member>
  1147. <member name="T:Cognex.VisionPro3D.Cog3DAngleRange">
  1148. <summary>
  1149. This value class describes an angle range and associated operations.
  1150. An angle range can have a range type of Cog3DRangeTypeConstants.Full, or .Empty, or .Partial.
  1151. If the range type is Cog3DRangeTypeConstants:Partial, it has a start value and
  1152. an end value.
  1153. </summary>
  1154. <remarks>
  1155. <list type="bullet">
  1156. <item> This class is immutable - it may not be changed once
  1157. it has been constructed. </item>
  1158. <item> The default constructor creates an object with an empty angle range. </item>
  1159. </list>
  1160. </remarks>
  1161. </member>
  1162. <member name="M:Cognex.VisionPro3D.Cog3DRange.RealEqual(Cognex.VisionPro3D.Cog3DRange,Cognex.VisionPro3D.Cog3DRange,System.Double)">
  1163. <inheritdoc cref="M:Cognex.VisionPro3D.ICog3DBase.RealEqual(System.Object,System.Object,System.Double)" />
  1164. </member>
  1165. <member name="M:Cognex.VisionPro3D.Cog3DRange.ToString">
  1166. <inheritdoc cref="M:Cognex.VisionPro3D.ICog3DBase.ToString" />
  1167. </member>
  1168. <member name="M:Cognex.VisionPro3D.Cog3DRange.op_Inequality(Cognex.VisionPro3D.Cog3DRange,Cognex.VisionPro3D.Cog3DRange)">
  1169. <summary>
  1170. Compare two Cog3DRange's.
  1171. </summary>
  1172. <param name="alpha">
  1173. The first Cog3DRange.
  1174. </param>
  1175. <param name="beta">
  1176. The second Cog3DRange.
  1177. </param>
  1178. <returns>
  1179. False if the two ranges are exactly equal, true otherwise.
  1180. </returns>
  1181. </member>
  1182. <member name="M:Cognex.VisionPro3D.Cog3DRange.op_Equality(Cognex.VisionPro3D.Cog3DRange,Cognex.VisionPro3D.Cog3DRange)">
  1183. <summary>
  1184. Compare two Cog3DRange's.
  1185. </summary>
  1186. <param name="alpha">
  1187. The first Cog3DRange.
  1188. </param>
  1189. <param name="beta">
  1190. The second Cog3DRange.
  1191. </param>
  1192. <returns>
  1193. True if the two ranges are exactly equal, false otherwise.
  1194. </returns>
  1195. </member>
  1196. <member name="M:Cognex.VisionPro3D.Cog3DRange.Erode(Cognex.VisionPro3D.Cog3DRange)">
  1197. <summary>
  1198. Erode this range by another range.
  1199. </summary>
  1200. <param name="other">
  1201. The other range.
  1202. </param>
  1203. <returns>
  1204. A new range computed by eroding this range by <paramref name="other" />.
  1205. </returns>
  1206. </member>
  1207. <member name="M:Cognex.VisionPro3D.Cog3DRange.Dilate(Cognex.VisionPro3D.Cog3DRange)">
  1208. <summary>
  1209. Dilate this range by another range.
  1210. </summary>
  1211. <param name="other">
  1212. The other range.
  1213. </param>
  1214. <returns>
  1215. A new range computed by dilating this range by <paramref name="other" />.
  1216. </returns>
  1217. </member>
  1218. <member name="M:Cognex.VisionPro3D.Cog3DRange.Scale(System.Double)">
  1219. <summary>
  1220. Scale this range by the given amount.
  1221. </summary>
  1222. <param name="value">
  1223. The scale factor.
  1224. </param>
  1225. <returns>
  1226. A new range computed by scaling this range by <paramref name="value" />.
  1227. </returns>
  1228. </member>
  1229. <member name="M:Cognex.VisionPro3D.Cog3DRange.Translate(System.Double)">
  1230. <summary>
  1231. Translate this range by the given amount.
  1232. </summary>
  1233. <param name="value">
  1234. The amount to translate.
  1235. </param>
  1236. <returns>
  1237. A new range computed by translating this range by <paramref name="value" />.
  1238. </returns>
  1239. </member>
  1240. <member name="M:Cognex.VisionPro3D.Cog3DRange.Intersect(Cognex.VisionPro3D.Cog3DRange)">
  1241. <summary>
  1242. Intersect this range with another range.
  1243. </summary>
  1244. <param name="other">
  1245. The other range.
  1246. </param>
  1247. <returns>
  1248. A new range resulting from the intersection of this range and <paramref name="other" />.
  1249. </returns>
  1250. </member>
  1251. <member name="M:Cognex.VisionPro3D.Cog3DRange.IsWithin(System.Double)">
  1252. <summary>
  1253. Check whether a value is inside the range.
  1254. </summary>
  1255. <param name="value">
  1256. The value for checking.
  1257. </param>
  1258. <returns>
  1259. True if <paramref name="value" /> is inside the range; false otherwise.
  1260. </returns>
  1261. </member>
  1262. <member name="P:Cognex.VisionPro3D.Cog3DRange.Length">
  1263. <summary>
  1264. Gets the length of the range, and is defined as follows:
  1265. <list type="bullet"><item> If RangeType is Cog3DRangeTypeConstants.Full, Length is Double.MaxValue. </item><item> If RangeType is Cog3DRangeTypeConstants.Empty,Length is 0. </item><item> If RangeType is Cog3DRangeTypeConstants.Partial, Length is (End -Start). </item></list></summary>
  1266. <value>
  1267. The length of the range.
  1268. </value>
  1269. </member>
  1270. <member name="P:Cognex.VisionPro3D.Cog3DRange.RangeType">
  1271. <summary>
  1272. Gets the type of the range.
  1273. </summary>
  1274. <value>
  1275. The type of the range.
  1276. </value>
  1277. </member>
  1278. <member name="P:Cognex.VisionPro3D.Cog3DRange.Middle">
  1279. <summary>
  1280. Gets the middle of the range.
  1281. </summary>
  1282. <value>
  1283. The middle of the range.
  1284. </value>
  1285. <exception cref="T:Cognex.VisionPro3D.Cog3DException">
  1286. If RangeType is NOT Cog3DRangeTypeConstants.Partial.
  1287. </exception>
  1288. </member>
  1289. <member name="P:Cognex.VisionPro3D.Cog3DRange.End">
  1290. <summary>
  1291. Gets the end value of the range.
  1292. </summary>
  1293. <value>
  1294. The end value of the range.
  1295. </value>
  1296. <exception cref="T:Cognex.VisionPro3D.Cog3DException">
  1297. If RangeType is NOT Cog3DRangeTypeConstants.Partial.
  1298. </exception>
  1299. </member>
  1300. <member name="P:Cognex.VisionPro3D.Cog3DRange.Start">
  1301. <summary>
  1302. Gets the start value of the range.
  1303. </summary>
  1304. <value>
  1305. The start value of the range.
  1306. </value>
  1307. <exception cref="T:Cognex.VisionPro3D.Cog3DException">
  1308. If RangeType is NOT Cog3DRangeTypeConstants.Partial.
  1309. </exception>
  1310. </member>
  1311. <member name="M:Cognex.VisionPro3D.Cog3DRange.CreateFullRange">
  1312. <summary>
  1313. Create a full range object.
  1314. </summary>
  1315. <returns>
  1316. A Cog3DRange object with full range.
  1317. </returns>
  1318. </member>
  1319. <member name="M:Cognex.VisionPro3D.Cog3DRange.#ctor(System.Double,System.Double)">
  1320. <summary>
  1321. Construct this Cog3DRange with the given start and end values.
  1322. </summary>
  1323. <param name="start">
  1324. The start value of the range.
  1325. </param>
  1326. <param name="end">
  1327. The end value of the range.
  1328. </param>
  1329. <exception cref="T:System.ArgumentException">
  1330. If <paramref name="start" /> &gt; <paramref name="end" />.
  1331. </exception>
  1332. </member>
  1333. <member name="T:Cognex.VisionPro3D.Cog3DRange">
  1334. <summary>
  1335. This value class describes a range and associated operations.
  1336. A range can have a range type of Cog3DRangeTypeConstants.Full, or .Empty, or .Partial.
  1337. If the range type is Cog3DRangeTypeConstants:Partial, it has a start value and
  1338. an end value.
  1339. </summary>
  1340. <remarks>
  1341. <list type="bullet">
  1342. <item> This class is immutable - it may not be changed once
  1343. it has been constructed. </item>
  1344. <item> The default constructor creates an object with an empty range. </item>
  1345. </list>
  1346. </remarks>
  1347. </member>
  1348. <member name="T:Cognex.VisionPro3D.Cog3DRangeTypeConstants">
  1349. <summary>
  1350. This class defines enumeration constants used for Cog3DRange.
  1351. </summary>
  1352. </member>
  1353. <member name="F:Cognex.VisionPro3D.Cog3DRangeTypeConstants.Full">
  1354. <summary>
  1355. Range spans the entire space.
  1356. </summary>
  1357. </member>
  1358. <member name="F:Cognex.VisionPro3D.Cog3DRangeTypeConstants.Empty">
  1359. <summary>
  1360. Range is completely empty.
  1361. </summary>
  1362. </member>
  1363. <member name="F:Cognex.VisionPro3D.Cog3DRangeTypeConstants.Partial">
  1364. <summary>
  1365. Range spans a finite segment.
  1366. </summary>
  1367. </member>
  1368. <member name="M:Cognex.VisionPro3D.Cog3DResiduals.RealEqual(Cognex.VisionPro3D.Cog3DResiduals,Cognex.VisionPro3D.Cog3DResiduals,System.Double)">
  1369. <inheritdoc cref="M:Cognex.VisionPro3D.ICog3DBase.RealEqual(System.Object,System.Object,System.Double)" />
  1370. </member>
  1371. <member name="M:Cognex.VisionPro3D.Cog3DResiduals.op_Inequality(Cognex.VisionPro3D.Cog3DResiduals,Cognex.VisionPro3D.Cog3DResiduals)">
  1372. <summary>
  1373. Compare two Cog3DResiduals.
  1374. </summary>
  1375. <param name="alpha">
  1376. The first Residual.
  1377. </param>
  1378. <param name="beta">
  1379. The second Residual.
  1380. </param>
  1381. <returns>
  1382. False if the two Residuals are exactly equal, true otherwise.
  1383. </returns>
  1384. </member>
  1385. <member name="M:Cognex.VisionPro3D.Cog3DResiduals.op_Equality(Cognex.VisionPro3D.Cog3DResiduals,Cognex.VisionPro3D.Cog3DResiduals)">
  1386. <summary>
  1387. Compare two Cog3DResiduals.
  1388. </summary>
  1389. <param name="alpha">
  1390. The first Residual.
  1391. </param>
  1392. <param name="beta">
  1393. The second Residual.
  1394. </param>
  1395. <returns>
  1396. True if the two Residuals are exactly equal, false otherwise.
  1397. </returns>
  1398. </member>
  1399. <member name="M:Cognex.VisionPro3D.Cog3DResiduals.ToString">
  1400. <inheritdoc cref="M:Cognex.VisionPro3D.ICog3DBase.ToString" />
  1401. </member>
  1402. <member name="P:Cognex.VisionPro3D.Cog3DResiduals.Max">
  1403. <summary>
  1404. Gets the maximum residual value.
  1405. </summary>
  1406. <value>
  1407. The maximum residual value.
  1408. </value>
  1409. </member>
  1410. <member name="P:Cognex.VisionPro3D.Cog3DResiduals.Rms">
  1411. <summary>
  1412. Gets the RMS residual value.
  1413. </summary>
  1414. <value>
  1415. The RMS residual value.
  1416. </value>
  1417. </member>
  1418. <member name="M:Cognex.VisionPro3D.Cog3DResiduals.#ctor(System.Double,System.Double)">
  1419. <summary>
  1420. Construct this Cog3DResiduals with the supplied Rms, Max values.
  1421. </summary>
  1422. <param name="initialRms">
  1423. The initial Rms value.
  1424. </param>
  1425. <param name="initialMax">
  1426. The initial Max value.
  1427. </param>
  1428. <exception cref="T:System.ArgumentException">
  1429. If any argument is less than 0, or
  1430. initialMax is less than initialRms.
  1431. </exception>
  1432. </member>
  1433. <member name="T:Cognex.VisionPro3D.Cog3DResiduals">
  1434. <summary>
  1435. This value class holds residual statistics information.
  1436. Residual error is the difference between a measured metric and its
  1437. expected value. Residual statistics may be expressed as the
  1438. maximum error (the largest difference) or the RMS error (Root Mean Square,
  1439. the square root of the average of the differences squared).
  1440. Note that this class is immutable - it may not be changed once
  1441. it has been constructed.
  1442. <para>
  1443. The default values for properties Rms and Max are 0.0.
  1444. </para></summary>
  1445. </member>
  1446. <member name="M:Cognex.VisionPro3D.Cog3DShapeGeometricOperations.AreRealPerpendicular(Cognex.VisionPro3D.Cog3DLine,Cognex.VisionPro3D.Cog3DPlane,System.Double)">
  1447. <summary>
  1448. Check whether one line and one plane are perpendicular within the
  1449. specified tolerance, i.e., whether <paramref name="line3D" /> is parallel
  1450. to the normal vector of <paramref name="plane3D" />
  1451. within <paramref name="epsilon" /> .
  1452. It is the caller responsibility to map the shapes to a common 3D
  1453. space before calling this method.
  1454. </summary>
  1455. <param name="plane3D">
  1456. The 3D plane. May not be null.
  1457. </param>
  1458. <param name="line3D">
  1459. The 3D line. May not be null.
  1460. </param>
  1461. <param name="epsilon">
  1462. The tolerance used in checking.
  1463. </param>
  1464. <returns>
  1465. True if <paramref name="plane3D" /> and <paramref name="line3D" /> are
  1466. perpendicular within the specified tolerance, false otherwise.
  1467. </returns>
  1468. <exception cref="T:System.ArgumentNullException">
  1469. If <paramref name="plane3D" /> or <paramref name="line3D" /> is null.
  1470. </exception>
  1471. <exception cref="T:System.ArgumentException">
  1472. If <paramref name="plane3D" /> is degenerate or <paramref name="line3D" />
  1473. is degenerate.
  1474. </exception>
  1475. <remarks>
  1476. This method computes the cross product of
  1477. <paramref name="line3D" />.Direction and
  1478. <paramref name="plane3D" />.Normal. If
  1479. the length of the cross product is less than or equal to
  1480. <paramref name="epsilon" />, returns true, false otherwise
  1481. </remarks>
  1482. </member>
  1483. <member name="M:Cognex.VisionPro3D.Cog3DShapeGeometricOperations.AreRealParallel(Cognex.VisionPro3D.Cog3DLine,Cognex.VisionPro3D.Cog3DPlane,System.Double)">
  1484. <summary>
  1485. Check whether one line and one plane are parallel within the specified
  1486. tolerance, i.e., whether <paramref name="line3D" /> is
  1487. perpendicular to the normal vector of <paramref name="plane3D" />
  1488. within the specified tolerance.
  1489. It is the caller responsibility to map the shapes to a common 3D
  1490. space before calling this method.
  1491. </summary>
  1492. <param name="plane3D">
  1493. The 3D plane. May not be null.
  1494. </param>
  1495. <param name="line3D">
  1496. The 3D line. May not be null.
  1497. </param>
  1498. <param name="epsilon">
  1499. The tolerance used in checking.
  1500. </param>
  1501. <returns>
  1502. True if <paramref name="plane3D" /> and <paramref name="line3D" /> are
  1503. parallel within the specified tolerance, false otherwise.
  1504. </returns>
  1505. <exception cref="T:System.ArgumentNullException">
  1506. If <paramref name="plane3D" /> or <paramref name="line3D" /> is null.
  1507. </exception>
  1508. <exception cref="T:System.ArgumentException">
  1509. If <paramref name="plane3D" /> is degenerate or <paramref name="line3D" />
  1510. is degenerate.
  1511. </exception>
  1512. <remarks>
  1513. This method computes the dot product of
  1514. <paramref name="line3D" />.Direction and
  1515. <paramref name="plane3D" />.Normal. If
  1516. the absolute value of the dot product is less than or equal to
  1517. <paramref name="epsilon" />, returns true, false otherwise
  1518. </remarks>
  1519. </member>
  1520. <member name="M:Cognex.VisionPro3D.Cog3DShapeGeometricOperations.AreRealAntiParallel(Cognex.VisionPro3D.Cog3DPlane,Cognex.VisionPro3D.Cog3DPlane,System.Double)">
  1521. <summary>
  1522. Check whether two planes are anti-parallel
  1523. within the specified tolerance.
  1524. It is the caller responsibility to map the shapes to a common 3D
  1525. space before calling this method.
  1526. </summary>
  1527. <param name="planeA">
  1528. The first plane. May not be null.
  1529. </param>
  1530. <param name="planeB">
  1531. The second plane. May not be null.
  1532. </param>
  1533. <param name="epsilon">
  1534. The tolerance used in checking.
  1535. </param>
  1536. <returns>
  1537. True if <paramref name="planeA" /> and <paramref name="planeB" /> are
  1538. anti-parallel within the specified tolerance, false otherwise.
  1539. </returns>
  1540. <exception cref="T:System.ArgumentNullException">
  1541. If <paramref name="planeA" /> or <paramref name="planeB" /> is null.
  1542. </exception>
  1543. <exception cref="T:System.ArgumentException">
  1544. If <paramref name="planeA" /> is degenerate or <paramref name="planeB" />
  1545. is degenerate.
  1546. </exception>
  1547. <remarks>
  1548. See section of remarks in
  1549. <see cref="M:Cognex.VisionPro3D.Cog3DShapeGeometricOperations.AreRealParallel(Cognex.VisionPro3D.Cog3DPlane,Cognex.VisionPro3D.Cog3DPlane,System.Double)" /></remarks>
  1550. </member>
  1551. <member name="M:Cognex.VisionPro3D.Cog3DShapeGeometricOperations.AreRealParallelIncludingDirection(Cognex.VisionPro3D.Cog3DPlane,Cognex.VisionPro3D.Cog3DPlane,System.Double)">
  1552. <summary>
  1553. Check whether two planes are parallel including direction
  1554. within the specified tolerance.
  1555. It is the caller responsibility to map the shapes to a common 3D
  1556. space before calling this method.
  1557. </summary>
  1558. <param name="planeA">
  1559. The first plane. May not be null.
  1560. </param>
  1561. <param name="planeB">
  1562. The second plane. May not be null.
  1563. </param>
  1564. <param name="epsilon">
  1565. The tolerance used in checking.
  1566. </param>
  1567. <returns>
  1568. True if <paramref name="planeA" /> and <paramref name="planeB" /> are
  1569. parallel including direction
  1570. within the specified tolerance, false otherwise.
  1571. </returns>
  1572. <exception cref="T:System.ArgumentNullException">
  1573. If <paramref name="planeA" /> or <paramref name="planeB" /> is null.
  1574. </exception>
  1575. <exception cref="T:System.ArgumentException">
  1576. If <paramref name="planeA" /> is degenerate or <paramref name="planeB" />
  1577. is degenerate.
  1578. </exception>
  1579. <remarks>
  1580. See section of remarks in
  1581. <see cref="M:Cognex.VisionPro3D.Cog3DShapeGeometricOperations.AreRealParallel(Cognex.VisionPro3D.Cog3DPlane,Cognex.VisionPro3D.Cog3DPlane,System.Double)" /></remarks>
  1582. </member>
  1583. <member name="M:Cognex.VisionPro3D.Cog3DShapeGeometricOperations.AreRealParallel(Cognex.VisionPro3D.Cog3DPlane,Cognex.VisionPro3D.Cog3DPlane,System.Double)">
  1584. <summary>
  1585. Check whether two planes are parallel including direction
  1586. or anti-parallel within the specified tolerance.
  1587. It is the caller responsibility to map the shapes to a common 3D
  1588. space before calling this method.
  1589. </summary>
  1590. <param name="planeA">
  1591. The first plane. May not be null.
  1592. </param>
  1593. <param name="planeB">
  1594. The second plane. May not be null.
  1595. </param>
  1596. <param name="epsilon">
  1597. The tolerance used in checking.
  1598. </param>
  1599. <returns>
  1600. True if <paramref name="planeA" /> and <paramref name="planeB" />
  1601. are parallel including direction
  1602. or anti-parallel within the specified tolerance, false otherwise.
  1603. </returns>
  1604. <exception cref="T:System.ArgumentNullException">
  1605. If <paramref name="planeA" /> or <paramref name="planeB" /> is null.
  1606. </exception>
  1607. <exception cref="T:System.ArgumentException">
  1608. If <paramref name="planeA" /> is degenerate or <paramref name="planeB" />
  1609. is degenerate.
  1610. </exception>
  1611. <remarks>
  1612. Plane parallelism checking methods compute the cross product and dot
  1613. product of the two unit normal vectors of
  1614. <paramref name="planeA" /> and <paramref name="planeB" />.
  1615. <list type="bullet"><item> If the length of the cross product vector is less than or equal to
  1616. <paramref name="epsilon" />, AreRealParallel() returns true; </item><item> If the dot product is greater than 0 and AreRealParallel() is
  1617. true, AreRealParallelIncludingDirection() returns true; </item><item> If the dot product is less than 0 and AreRealParallel() is true,
  1618. AreRealAntiParallel() returns true. </item></list></remarks>
  1619. </member>
  1620. <member name="M:Cognex.VisionPro3D.Cog3DShapeGeometricOperations.AreRealAntiParallel(Cognex.VisionPro3D.Cog3DLine,Cognex.VisionPro3D.Cog3DLine,System.Double)">
  1621. <summary>
  1622. Check whether two lines are anti-parallel
  1623. within the specified tolerance.
  1624. It is the caller responsibility to map the shapes to a common 3D
  1625. space before calling this method.
  1626. </summary>
  1627. <param name="lineA">
  1628. The first line. May not be null.
  1629. </param>
  1630. <param name="lineB">
  1631. The second line. May not be null.
  1632. </param>
  1633. <param name="epsilon">
  1634. The tolerance used in checking.
  1635. </param>
  1636. <returns>
  1637. True if <paramref name="lineA" /> and <paramref name="lineB" /> are
  1638. anti-parallel within the specified tolerance, false otherwise.
  1639. </returns>
  1640. <exception cref="T:System.ArgumentNullException">
  1641. If <paramref name="lineA" /> or <paramref name="lineB" /> is null.
  1642. </exception>
  1643. <exception cref="T:System.ArgumentException">
  1644. If <paramref name="lineA" /> is degenerate or <paramref name="lineB" />
  1645. is degenerate.
  1646. </exception>
  1647. <remarks>
  1648. See section of remarks in
  1649. <see cref="M:Cognex.VisionPro3D.Cog3DShapeGeometricOperations.AreRealParallel(Cognex.VisionPro3D.Cog3DLine,Cognex.VisionPro3D.Cog3DLine,System.Double)" /></remarks>
  1650. </member>
  1651. <member name="M:Cognex.VisionPro3D.Cog3DShapeGeometricOperations.AreRealParallelIncludingDirection(Cognex.VisionPro3D.Cog3DLine,Cognex.VisionPro3D.Cog3DLine,System.Double)">
  1652. <summary>
  1653. Check whether two lines are parallel including direction
  1654. within the specified tolerance.
  1655. It is the caller responsibility to map the shapes to a common 3D
  1656. space before calling this method.
  1657. </summary>
  1658. <param name="lineA">
  1659. The first line. May not be null.
  1660. </param>
  1661. <param name="lineB">
  1662. The second line. May not be null.
  1663. </param>
  1664. <param name="epsilon">
  1665. The tolerance used in checking.
  1666. </param>
  1667. <returns>
  1668. True if <paramref name="lineA" /> and <paramref name="lineB" />
  1669. are parallel including direction
  1670. within the specified tolerance, false otherwise.
  1671. </returns>
  1672. <exception cref="T:System.ArgumentNullException">
  1673. If <paramref name="lineA" /> or <paramref name="lineB" /> is null.
  1674. </exception>
  1675. <exception cref="T:System.ArgumentException">
  1676. If <paramref name="lineA" /> is degenerate or <paramref name="lineB" />
  1677. is degenerate.
  1678. </exception>
  1679. <remarks>
  1680. See section of remarks in
  1681. <see cref="M:Cognex.VisionPro3D.Cog3DShapeGeometricOperations.AreRealParallel(Cognex.VisionPro3D.Cog3DLine,Cognex.VisionPro3D.Cog3DLine,System.Double)" /></remarks>
  1682. </member>
  1683. <member name="M:Cognex.VisionPro3D.Cog3DShapeGeometricOperations.AreRealParallel(Cognex.VisionPro3D.Cog3DLine,Cognex.VisionPro3D.Cog3DLine,System.Double)">
  1684. <summary>
  1685. Check whether two lines are parallel including direction
  1686. or anti-parallel within the specified tolerance.
  1687. It is the caller responsibility to map the shapes to a common 3D
  1688. space before calling this method.
  1689. </summary>
  1690. <param name="lineA">
  1691. The first line. May not be null.
  1692. </param>
  1693. <param name="lineB">
  1694. The second line. May not be null.
  1695. </param>
  1696. <param name="epsilon">
  1697. The tolerance used in checking.
  1698. </param>
  1699. <returns>
  1700. True if <paramref name="lineA" /> and <paramref name="lineB" /> are
  1701. parallel including direction
  1702. or anti-parallel within the specified tolerance, false otherwise.
  1703. </returns>
  1704. <exception cref="T:System.ArgumentNullException">
  1705. If <paramref name="lineA" /> or <paramref name="lineB" /> is null.
  1706. </exception>
  1707. <exception cref="T:System.ArgumentException">
  1708. If <paramref name="lineA" /> is degenerate or <paramref name="lineB" /> is
  1709. degenerate.
  1710. </exception>
  1711. <remarks>
  1712. Line parallelism checking methods compute the cross product and dot
  1713. product of the two unit direction vectors of <paramref name="lineA" />
  1714. and <paramref name="lineB" />.
  1715. <list type="bullet"><item> If the length of the cross product vector is less than or equal to
  1716. <paramref name="epsilon" />, AreRealParallel() returns true; </item><item> If the dot product is greater than 0 and AreRealParallel() is
  1717. true, AreRealParallelIncludingDirection() returns true; </item><item> If the dot product is less than 0 and AreRealParallel() is true,
  1718. AreRealAntiParallel() returns true. </item></list></remarks>
  1719. </member>
  1720. <member name="M:Cognex.VisionPro3D.Cog3DShapeGeometricOperations.ProjectOntoPlane(Cognex.VisionPro3D.Cog3DPlane,Cognex.VisionPro3D.Cog3DLineSeg,Cognex.VisionPro3D.Cog3DLineSeg@,Cognex.VisionPro3D.Cog3DShapeProjectionStatusConstants@)">
  1721. <summary>
  1722. Project a 3D line segment onto a specified 3D plane.
  1723. It is the caller responsibility to map the shapes to a common 3D
  1724. space before calling this method.
  1725. </summary>
  1726. <param name="plane3D">
  1727. The 3D plane to project onto. May not be null.
  1728. </param>
  1729. <param name="lineSeg3D">
  1730. The 3D line segment. May not be null.
  1731. </param>
  1732. <param name="projectedLineSeg3D">
  1733. This output parameter is used to keep the projected line segment.
  1734. </param>
  1735. <param name="projectionStatus">
  1736. This output parameter is used to keep the projection status.
  1737. </param>
  1738. <remarks>
  1739. If <paramref name="projectionStatus" /> is
  1740. Cog3DShapeProjectionStatusConstants.DegenerateProjection,
  1741. <paramref name="projectedLineSeg3D" /> will be a degenerate line segment.
  1742. </remarks>
  1743. <exception cref="T:System.ArgumentNullException">
  1744. If <paramref name="plane3D" /> or <paramref name="lineSeg3D" /> is null.
  1745. </exception>
  1746. <exception cref="T:System.ArgumentException">
  1747. If <paramref name="plane3D" /> is degenerate or
  1748. <paramref name="lineSeg3D" /> is degenerate.
  1749. </exception>
  1750. </member>
  1751. <member name="M:Cognex.VisionPro3D.Cog3DShapeGeometricOperations.ProjectOntoPlane(Cognex.VisionPro3D.Cog3DPlane,Cognex.VisionPro3D.Cog3DLine,Cognex.VisionPro3D.Cog3DLine@,Cognex.VisionPro3D.Cog3DShapeProjectionStatusConstants@)">
  1752. <summary>
  1753. Project a 3D line onto a specified 3D plane.
  1754. It is the caller responsibility to map the shapes to a common 3D
  1755. space before calling this method.
  1756. </summary>
  1757. <param name="plane3D">
  1758. The 3D plane to project onto. May not be null.
  1759. </param>
  1760. <param name="line3D">
  1761. The 3D line. May not be null.
  1762. </param>
  1763. <param name="projectedLine3D">
  1764. This output parameter is used to keep the projected line.
  1765. </param>
  1766. <param name="projectionStatus">
  1767. This output parameter is used to keep the projection status.
  1768. </param>
  1769. <remarks>
  1770. If <paramref name="projectionStatus" /> is
  1771. Cog3DShapeProjectionStatusConstants.DegenerateProjection,
  1772. <paramref name="projectedLine3D" /> will be a degenerate line.
  1773. </remarks>
  1774. <exception cref="T:System.ArgumentNullException">
  1775. If <paramref name="plane3D" /> or <paramref name="line3D" /> is null.
  1776. </exception>
  1777. <exception cref="T:System.ArgumentException">
  1778. If <paramref name="plane3D" /> is degenerate or <paramref name="line3D" />
  1779. is degenerate.
  1780. </exception>
  1781. </member>
  1782. <member name="M:Cognex.VisionPro3D.Cog3DShapeGeometricOperations.ComputeDistance(Cognex.VisionPro3D.Cog3DLineSeg,Cognex.VisionPro3D.Cog3DLineSeg)">
  1783. <summary>
  1784. Compute the minimum distance between two line segments.
  1785. It is the caller responsibility to map the shapes to a common 3D
  1786. space before calling this method.
  1787. </summary>
  1788. <param name="lineSegA">
  1789. The first 3D line segment. May not be null.
  1790. </param>
  1791. <param name="lineSegB">
  1792. The second 3D line segment. May not be null.
  1793. </param>
  1794. <returns>
  1795. The minimum distance between <paramref name="lineSegA" /> and
  1796. <paramref name="lineSegB" /></returns>
  1797. <exception cref="T:System.ArgumentNullException">
  1798. If <paramref name="lineSegA" /> or <paramref name="lineSegB" /> is null.
  1799. </exception>
  1800. </member>
  1801. <member name="M:Cognex.VisionPro3D.Cog3DShapeGeometricOperations.Intersect(Cognex.VisionPro3D.Cog3DPlane,Cognex.VisionPro3D.Cog3DPlane,Cognex.VisionPro3D.Cog3DLine@,Cognex.VisionPro3D.Cog3DShapeIntersectionStatusConstants@)">
  1802. <summary>
  1803. Compute the intersection line between two given planes.
  1804. It is the caller responsibility to map the shapes to a common 3D
  1805. space before calling this method.
  1806. </summary>
  1807. <param name="planeA">
  1808. The first 3D plane. May not be null.
  1809. </param>
  1810. <param name="planeB">
  1811. The second 3D plane. May not be null.
  1812. </param>
  1813. <param name="line3D">
  1814. This output parameter is used to keep the intersection line.
  1815. </param>
  1816. <param name="intersectionStatus">
  1817. This output parameter is used to keep the intersection status.
  1818. </param>
  1819. <remarks>
  1820. <paramref name="line3D" /> is valid if and only if
  1821. <paramref name="intersectionStatus" /> is
  1822. Cog3DShapeIntersectionStatusConstants.Intersect, and unchanged otherwise.
  1823. <para><paramref name="intersectionStatus" /> is
  1824. Cog3DShapeIntersectionStatusConstants.Overlap
  1825. if <paramref name="planeB" /> is coincident with
  1826. <paramref name="planeA" />. </para><para><paramref name="intersectionStatus" /> is
  1827. Cog3DShapeIntersectionStatusConstants.None
  1828. if <paramref name="planeB" /> is parallel to <paramref name="planeA" />.
  1829. </para></remarks>
  1830. <exception cref="T:System.ArgumentNullException">
  1831. If <paramref name="planeA" /> or <paramref name="planeB" /> is null.
  1832. </exception>
  1833. <exception cref="T:System.ArgumentException">
  1834. If <paramref name="planeA" /> is degenerate or <paramref name="planeB" />
  1835. is degenerate.
  1836. </exception>
  1837. </member>
  1838. <member name="M:Cognex.VisionPro3D.Cog3DShapeGeometricOperations.Intersect(Cognex.VisionPro3D.Cog3DPlane,Cognex.VisionPro3D.Cog3DRay,Cognex.VisionPro3D.Cog3DVect3@,Cognex.VisionPro3D.Cog3DShapeIntersectionStatusConstants@)">
  1839. <summary>
  1840. Compute the intersection point between the given plane and
  1841. the given 3D ray.
  1842. It is the caller responsibility to map the shapes to a common 3D
  1843. space before calling this method.
  1844. </summary>
  1845. <param name="plane3D">
  1846. The 3D plane. May not be null.
  1847. </param>
  1848. <param name="ray3D">
  1849. The 3D ray. May not be null.
  1850. </param>
  1851. <param name="point3D">
  1852. This output parameter is used to keep the intersection point.
  1853. </param>
  1854. <param name="intersectionStatus">
  1855. This output parameter is used to keep the intersection status.
  1856. </param>
  1857. <remarks>
  1858. <paramref name="point3D" /> is valid if and only if
  1859. <paramref name="intersectionStatus" /> is
  1860. Cog3DShapeIntersectionStatusConstants.Intersect, and unchanged otherwise.
  1861. <para><paramref name="intersectionStatus" /> is
  1862. Cog3DShapeIntersectionStatusConstants.Overlap
  1863. if <paramref name="ray3D" /> is on <paramref name="plane3D" />. </para><para><paramref name="intersectionStatus" /> is
  1864. Cog3DShapeIntersectionStatusConstants.None
  1865. if <paramref name="ray3D" /> is parallel to <paramref name="plane3D" />
  1866. or if <paramref name="ray3D" /> is
  1867. pointing away from <paramref name="plane3D" />.
  1868. </para><para> An intersection will not be found if <paramref name="ray3D" /> is
  1869. pointing away from <paramref name="plane3D" />. </para></remarks>
  1870. <exception cref="T:System.ArgumentNullException">
  1871. If <paramref name="plane3D" /> or <paramref name="ray3D" /> is null.
  1872. </exception>
  1873. <exception cref="T:System.ArgumentException">
  1874. If <paramref name="plane3D" /> is degenerate or <paramref name="ray3D" /> is
  1875. degenerate.
  1876. </exception>
  1877. </member>
  1878. <member name="M:Cognex.VisionPro3D.Cog3DShapeGeometricOperations.Intersect(Cognex.VisionPro3D.Cog3DPlane,Cognex.VisionPro3D.Cog3DLine,Cognex.VisionPro3D.Cog3DVect3@,Cognex.VisionPro3D.Cog3DShapeIntersectionStatusConstants@)">
  1879. <summary>
  1880. Compute the intersection point between the given plane and
  1881. the given 3D line.
  1882. It is the caller responsibility to map the shapes to a common 3D
  1883. space before calling this method.
  1884. </summary>
  1885. <param name="plane3D">
  1886. The 3D plane. May not be null.
  1887. </param>
  1888. <param name="line3D">
  1889. The 3D line. May not be null.
  1890. </param>
  1891. <param name="point3D">
  1892. This output parameter is used to keep the intersection point.
  1893. </param>
  1894. <param name="intersectionStatus">
  1895. This output parameter is used to keep the intersection status.
  1896. </param>
  1897. <remarks>
  1898. <paramref name="point3D" /> is valid if and only if
  1899. <paramref name="intersectionStatus" /> is
  1900. Cog3DShapeIntersectionStatusConstants.Intersect, and unchanged otherwise.
  1901. <para><paramref name="intersectionStatus" /> is
  1902. Cog3DShapeIntersectionStatusConstants.Overlap
  1903. if <paramref name="line3D" /> is on <paramref name="plane3D" />. </para><para><paramref name="intersectionStatus" /> is
  1904. Cog3DShapeIntersectionStatusConstants.None
  1905. if <paramref name="line3D" /> is parallel to <paramref name="plane3D" />.
  1906. </para></remarks>
  1907. <exception cref="T:System.ArgumentNullException">
  1908. If <paramref name="plane3D" /> or <paramref name="line3D" /> is null.
  1909. </exception>
  1910. <exception cref="T:System.ArgumentException">
  1911. If <paramref name="plane3D" /> is degenerate or <paramref name="line3D" />
  1912. is degenerate.
  1913. </exception>
  1914. </member>
  1915. <member name="M:Cognex.VisionPro3D.Cog3DShapeGeometricOperations.ComputeNearestPoints(Cognex.VisionPro3D.Cog3DLine,Cognex.VisionPro3D.Cog3DLine,Cognex.VisionPro3D.Cog3DVect3@,Cognex.VisionPro3D.Cog3DVect3@)">
  1916. <summary>
  1917. Compute the pair of nearest points between two lines.
  1918. It is the caller responsibility to map the shapes to a common 3D
  1919. space before calling this method.
  1920. </summary>
  1921. <param name="lineA">
  1922. The first line. May not be null.
  1923. </param>
  1924. <param name="lineB">
  1925. The second line. May not be null.
  1926. </param>
  1927. <param name="pointOnLineA">
  1928. This output parameter is a point on <paramref name="lineA" />. The distance
  1929. between <paramref name="pointOnLineA" />
  1930. and <paramref name="pointOnLineB" /> is the shortest distance between
  1931. <paramref name="lineA" /> and <paramref name="lineB" />.
  1932. </param>
  1933. <param name="pointOnLineB">
  1934. This output parameter is a point on <paramref name="lineB" />. The
  1935. distance between <paramref name="pointOnLineA" />
  1936. and <paramref name="pointOnLineB" /> is the shortest distance between
  1937. <paramref name="lineA" /> and <paramref name="lineB" />.
  1938. </param>
  1939. <remarks>
  1940. If <paramref name="lineA" /> and <paramref name="lineB" /> are parallel
  1941. or coincident, then the pair of
  1942. nearest points is not unique. (<paramref name="pointOnLineA" />,
  1943. <paramref name="pointOnLineB" />) is just
  1944. one of the pairs of nearest points.
  1945. </remarks>
  1946. <exception cref="T:System.ArgumentNullException">
  1947. If <paramref name="lineA" /> or <paramref name="lineB" /> is null.
  1948. </exception>
  1949. </member>
  1950. <member name="T:Cognex.VisionPro3D.Cog3DShapeGeometricOperations">
  1951. <summary>
  1952. This class contains static methods that perform various 3D shape
  1953. geometric operations.
  1954. Note that this class has only static methods.
  1955. </summary>
  1956. </member>
  1957. <member name="T:Cognex.VisionPro3D.Cog3DShapeProjectionStatusConstants">
  1958. <summary>
  1959. This class defines enumeration constants of the shape projection
  1960. status for 3D shapes.
  1961. </summary>
  1962. </member>
  1963. <member name="F:Cognex.VisionPro3D.Cog3DShapeProjectionStatusConstants.DegenerateProjection">
  1964. <summary>
  1965. The projection results in a degenerate shape.
  1966. </summary>
  1967. </member>
  1968. <member name="F:Cognex.VisionPro3D.Cog3DShapeProjectionStatusConstants.StandardProjection">
  1969. <summary>
  1970. Standard projection
  1971. </summary>
  1972. </member>
  1973. <member name="M:Cognex.VisionPro3D.cfConvert_ICog3DShape(Cognex.VisionPro3D.ICog3DShape)">
  1974. <summary>
  1975. Internal helper function to convert a .NET ICog3DShape to a CVL cc3DShape*.
  1976. </summary>
  1977. <param name="shape">
  1978. The CVL shape used in the conversion. May not be null.
  1979. </param>
  1980. <exception cref="T:System.ArgumentNullException">
  1981. If the cvlShape argument is null.
  1982. </exception>
  1983. <exception cref="T:System.ArgumentException">
  1984. If the cvlShape argument is an unknown CVL shape.
  1985. </exception>
  1986. </member>
  1987. <member name="M:Cognex.VisionPro3D.cfConvert_cc3DShape(cc3DShape*,System.Boolean)">
  1988. <summary>
  1989. Internal helper function to convert a CVL cc3DShape* to a .NET ICog3DShape.
  1990. </summary>
  1991. <param name="cvlShape">
  1992. The CVL shape used in the conversion. May not be null.
  1993. </param>
  1994. <param name="takeOwnership">
  1995. Specifies whether or not the .NET class should take ownership of the cvlShape.
  1996. If takeOwnership is true, then ownership of the specified cvlShape
  1997. is taken by the .NET class returned.
  1998. If takeOwnership is false, then a copy of the specified cvlShape is held
  1999. by the .NET class returned.
  2000. </param>
  2001. <exception cref="T:System.ArgumentNullException">
  2002. If the cvlShape argument is null.
  2003. </exception>
  2004. <exception cref="T:System.ArgumentException">
  2005. If the cvlShape argument is an unknown CVL shape.
  2006. </exception>
  2007. </member>
  2008. <member name="M:Cognex.VisionPro3D.Cog3DCylinder.GetObjectData(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
  2009. <inheritdoc cref="M:Cognex.VisionPro3D.ICog3DBase.GetObjectData(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)" />
  2010. </member>
  2011. <member name="M:Cognex.VisionPro3D.Cog3DCylinder.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
  2012. <inheritdoc cref="M:Cognex.VisionPro3D.ICog3DBase.SerializationConstructor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)" />
  2013. </member>
  2014. <member name="M:Cognex.VisionPro3D.Cog3DCylinder.RealEqual(Cognex.VisionPro3D.Cog3DCylinder,Cognex.VisionPro3D.Cog3DCylinder,System.Double)">
  2015. <inheritdoc cref="M:Cognex.VisionPro3D.ICog3DBase.RealEqual(System.Object,System.Object,System.Double)" />
  2016. </member>
  2017. <member name="M:Cognex.VisionPro3D.Cog3DCylinder.ToString">
  2018. <inheritdoc cref="M:Cognex.VisionPro3D.ICog3DBase.ToString" />
  2019. </member>
  2020. <member name="M:Cognex.VisionPro3D.Cog3DCylinder.MapRigid(Cognex.VisionPro3D.Cog3DTransformRigid)">
  2021. <summary>
  2022. Maps this cylinder through the specified rigid transform and
  2023. returns a new Cog3DCylinder.
  2024. </summary>
  2025. <param name="newFromOld">
  2026. The rigid transform to use when mapping this cylinder.
  2027. </param>
  2028. <returns>
  2029. The Cog3DCylinder resulting from mapping this shape through the specified
  2030. rigid transform.
  2031. </returns>
  2032. <exception cref="T:System.ArgumentNullException">
  2033. If <paramref name="newFromOld" /> is null.
  2034. </exception>
  2035. </member>
  2036. <member name="M:Cognex.VisionPro3D.Cog3DCylinder.SetShapeFromScaledUnitCylinder(Cognex.VisionPro3D.Cog3DTransformRigid)">
  2037. <summary>
  2038. Set the ShapeFromScaledUnitCylinder transform of this cylinder.
  2039. It may change the
  2040. value of StartCircle. It does not change the value of Radius and Height.
  2041. </summary>
  2042. <param name="shapeFromScaledUnitCylinder">
  2043. A Cog3DTransformRigid used to specify the ShapeFromScaledUnitCylinder
  2044. transform of this cylinder. This transform
  2045. specifies the pose of the ScaledUnitCylinder in 3D space.
  2046. </param>
  2047. <exception cref="T:System.ArgumentNullException">
  2048. If <paramref name="shapeFromScaledUnitCylinder" /> is null.
  2049. </exception>
  2050. <event cref="E:Cognex.VisionPro.ICogChangedEvent.Changed">
  2051. <para>Fires when some properties change.</para>
  2052. <para>The following state flags may be affected:</para>
  2053. <list type="bullet">
  2054. <item> SfGetShapeFromScaledUnitCylinder </item>
  2055. <item> SfStartCircle </item>
  2056. <item> SfGetEndCircle </item>
  2057. <item> SfAxisDirection </item>
  2058. <item> SfComputeBoundingBox </item>
  2059. </list>
  2060. </event>
  2061. </member>
  2062. <member name="M:Cognex.VisionPro3D.Cog3DCylinder.GetShapeFromScaledUnitCylinder">
  2063. <summary>
  2064. Get the ShapeFromScaledUnitCylinder transform of this cylinder.
  2065. </summary>
  2066. <returns>
  2067. The ShapeFromScaledUnitCylinder transform of this cylinder. This transform
  2068. specifies the pose of the ScaledUnitCylinder in 3D space.
  2069. </returns>
  2070. </member>
  2071. <member name="M:Cognex.VisionPro3D.Cog3DCylinder.GetEndCircle">
  2072. <summary>
  2073. Get the end circle of this cylinder.
  2074. </summary>
  2075. <returns>
  2076. The end circle of this cylinder.
  2077. </returns>
  2078. </member>
  2079. <member name="P:Cognex.VisionPro3D.Cog3DCylinder.StartCircle">
  2080. <summary>
  2081. Gets/Sets the start circle of this cylinder.
  2082. </summary>
  2083. <exception cref="T:System.ArgumentNullException">
  2084. If <paramref name="value" /> of setter is null.
  2085. </exception>
  2086. <value>
  2087. The start circle of the cylinder, and it might be a degenerate circle.
  2088. </value>
  2089. <event cref="E:Cognex.VisionPro.ICogChangedEvent.Changed">
  2090. <para>Fires when this property changes.</para>
  2091. <para>The following state flags may be affected:</para>
  2092. <list type="bullet">
  2093. <item> SfStartCircle </item>
  2094. <item> SfGetEndCircle </item>
  2095. <item> SfGetShapeFromScaledUnitCylinder </item>
  2096. <item> SfRadius </item>
  2097. <item> SfAxisDirection </item>
  2098. <item> SfComputePerimeter </item>
  2099. <item> SfComputeArea </item>
  2100. <item> SfComputeVolume </item>
  2101. <item> SfComputeBoundingBox </item>
  2102. <item> SfIsDegenerateCurve </item>
  2103. <item> SfIsDegenerateSurface </item>
  2104. <item> SfIsDegenerateVolume </item>
  2105. </list>
  2106. </event>
  2107. </member>
  2108. <member name="P:Cognex.VisionPro3D.Cog3DCylinder.AxisDirection">
  2109. <summary>
  2110. Gets the axis direction of this cylinder.
  2111. </summary>
  2112. <value>
  2113. The axis direction of the cylinder.
  2114. </value>
  2115. </member>
  2116. <member name="P:Cognex.VisionPro3D.Cog3DCylinder.Height">
  2117. <summary>
  2118. Gets/sets the height of this cylinder.
  2119. </summary>
  2120. <value>
  2121. The height of this cylinder.
  2122. </value>
  2123. <exception cref="T:System.ArgumentException">
  2124. If <paramref name="value" /> is less than 0.
  2125. </exception>
  2126. <event cref="E:Cognex.VisionPro.ICogChangedEvent.Changed">
  2127. <para>Fires when this property changes.</para>
  2128. <para>The following state flags may be affected:</para>
  2129. <list type="bullet">
  2130. <item> SfHeight </item>
  2131. <item> SfGetEndCircle </item>
  2132. <item> SfComputeArea </item>
  2133. <item> SfComputeVolume </item>
  2134. <item> SfComputeBoundingBox </item>
  2135. <item> SfIsDegenerateVolume </item>
  2136. </list>
  2137. </event>
  2138. </member>
  2139. <member name="P:Cognex.VisionPro3D.Cog3DCylinder.Radius">
  2140. <summary>
  2141. Gets the radius of this cylinder.
  2142. </summary>
  2143. <value>
  2144. The radius of this cylinder.
  2145. </value>
  2146. </member>
  2147. <member name="P:Cognex.VisionPro3D.Cog3DCylinder.ShapeState">
  2148. <summary>
  2149. Gets/sets the ShapeState for this shape.
  2150. </summary>
  2151. <value>
  2152. The ShapeState of this Shape. Must be Cog3DShapeStateConstants.Curve, or .Surface, or .Volume.
  2153. </value>
  2154. <exception cref="T:System.ArgumentException">
  2155. If <paramref name="shapeState" /> is not Cog3DShapeStateConstants.Curve, .Surface, or .Volume.
  2156. </exception>
  2157. <event cref="E:Cognex.VisionPro.ICogChangedEvent.Changed">
  2158. <para>Fires when this property changes.</para>
  2159. <para>The following state flags may be affected:</para>
  2160. <list type="bullet">
  2161. <item> SfShapeState </item>
  2162. </list>
  2163. </event>
  2164. </member>
  2165. <member name="M:Cognex.VisionPro3D.Cog3DCylinder.ComputeDistanceVolume(Cognex.VisionPro3D.Cog3DVect3)">
  2166. <inheritdoc />
  2167. </member>
  2168. <member name="M:Cognex.VisionPro3D.Cog3DCylinder.ComputeNearestPointVolume(Cognex.VisionPro3D.Cog3DVect3)">
  2169. <inheritdoc />
  2170. </member>
  2171. <member name="P:Cognex.VisionPro3D.Cog3DCylinder.IsDegenerateVolume">
  2172. <inheritdoc />
  2173. </member>
  2174. <member name="M:Cognex.VisionPro3D.Cog3DCylinder.ComputeVolume">
  2175. <inheritdoc />
  2176. </member>
  2177. <member name="M:Cognex.VisionPro3D.Cog3DCylinder.ComputeDistanceSurface(Cognex.VisionPro3D.Cog3DVect3)">
  2178. <inheritdoc />
  2179. </member>
  2180. <member name="M:Cognex.VisionPro3D.Cog3DCylinder.ComputeNearestPointSurface(Cognex.VisionPro3D.Cog3DVect3)">
  2181. <inheritdoc />
  2182. </member>
  2183. <member name="P:Cognex.VisionPro3D.Cog3DCylinder.IsDegenerateSurface">
  2184. <inheritdoc />
  2185. </member>
  2186. <member name="M:Cognex.VisionPro3D.Cog3DCylinder.ComputeArea">
  2187. <inheritdoc />
  2188. </member>
  2189. <member name="M:Cognex.VisionPro3D.Cog3DCylinder.ComputeDistanceCurve(Cognex.VisionPro3D.Cog3DVect3)">
  2190. <inheritdoc />
  2191. </member>
  2192. <member name="M:Cognex.VisionPro3D.Cog3DCylinder.ComputeNearestPointCurve(Cognex.VisionPro3D.Cog3DVect3)">
  2193. <inheritdoc />
  2194. </member>
  2195. <member name="P:Cognex.VisionPro3D.Cog3DCylinder.IsDegenerateCurve">
  2196. <inheritdoc />
  2197. </member>
  2198. <member name="M:Cognex.VisionPro3D.Cog3DCylinder.ComputePerimeter">
  2199. <inheritdoc />
  2200. </member>
  2201. <member name="M:Cognex.VisionPro3D.Cog3DCylinder.MapShape(Cognex.VisionPro3D.ICog3DTransform)">
  2202. <inheritdoc />
  2203. </member>
  2204. <member name="M:Cognex.VisionPro3D.Cog3DCylinder.ComputeBoundingBox">
  2205. <inheritdoc />
  2206. </member>
  2207. <member name="P:Cognex.VisionPro3D.Cog3DCylinder.SelectedSpaceName3D">
  2208. <inheritdoc />
  2209. </member>
  2210. <member name="M:Cognex.VisionPro3D.Cog3DCylinder.ComputeDistance(Cognex.VisionPro3D.Cog3DVect3)">
  2211. <inheritdoc />
  2212. </member>
  2213. <member name="M:Cognex.VisionPro3D.Cog3DCylinder.ComputeNearestPoint(Cognex.VisionPro3D.Cog3DVect3)">
  2214. <inheritdoc />
  2215. </member>
  2216. <member name="P:Cognex.VisionPro3D.Cog3DCylinder.IsEmpty">
  2217. <inheritdoc />
  2218. </member>
  2219. <member name="P:Cognex.VisionPro3D.Cog3DCylinder.IsFinite">
  2220. <inheritdoc />
  2221. </member>
  2222. <member name="M:Cognex.VisionPro3D.Cog3DCylinder.Clone">
  2223. <inheritdoc />
  2224. </member>
  2225. <member name="M:Cognex.VisionPro3D.Cog3DCylinder.Finalize">
  2226. <inheritdoc cref="M:Cognex.VisionPro3D.ICog3DBase.FinalizerForThisClass" />
  2227. </member>
  2228. <member name="M:Cognex.VisionPro3D.Cog3DCylinder.Dispose">
  2229. <inheritdoc cref="M:Cognex.VisionPro3D.ICog3DBase.DestructorForThisClass" />
  2230. </member>
  2231. <member name="M:Cognex.VisionPro3D.Cog3DCylinder.#ctor(Cognex.VisionPro3D.Cog3DCylinder)">
  2232. <inheritdoc cref="M:Cognex.VisionPro3D.ICog3DBase.DeepCopyConstructorForThisClass(System.Object)" />
  2233. </member>
  2234. <member name="M:Cognex.VisionPro3D.Cog3DCylinder.#ctor(Cognex.VisionPro3D.Cog3DCircle,System.Double,Cognex.VisionPro3D.Cog3DShapeStateConstants)">
  2235. <summary>
  2236. Constructs a cylinder using the specified start circle, height, and
  2237. Cog3DShapeStateConstants. The cylinder extends from the start circle
  2238. in the direction of the start circle's normal.
  2239. </summary>
  2240. <param name="startCircle">
  2241. The start circle of the cylinder. May not be null, but a degenerate circle
  2242. is allowed.
  2243. </param>
  2244. <param name="height">
  2245. The height of this cylinder. Must be &gt;= 0.
  2246. </param>
  2247. <param name="shapeState">
  2248. The state of this cylinder. Must be Cog3DShapeStateConstants.Curve,
  2249. .Surface, or .Volume.
  2250. </param>
  2251. <exception cref="T:System.ArgumentNullException">
  2252. If <paramref name="startCircle" /> is null.
  2253. </exception>
  2254. <exception cref="T:System.ArgumentException">
  2255. If <paramref name="height" /> is less than 0.
  2256. </exception>
  2257. <exception cref="T:System.ArgumentException">
  2258. If <paramref name="shapeState" /> is not
  2259. Cog3DShapeStateConstants.Curve, .Surface, or .Volume.
  2260. </exception>
  2261. </member>
  2262. <member name="M:Cognex.VisionPro3D.Cog3DCylinder.#ctor(System.Double,System.Double,Cognex.VisionPro3D.Cog3DTransformRigid,Cognex.VisionPro3D.Cog3DShapeStateConstants)">
  2263. <summary>
  2264. Constructs a cylinder using the specified radius, height,
  2265. rigid transform, and Cog3DShapeStateConstants.
  2266. </summary>
  2267. <param name="radius">
  2268. The radius of this cylinder. Must be &gt;= 0.
  2269. </param>
  2270. <param name="height">
  2271. The height of this cylinder. Must be &gt;= 0.
  2272. </param>
  2273. <param name="shapeFromScaledUnitCylinder">
  2274. The rigid transform that maps the ScaledUnitCylinder to a pose in 3D space.
  2275. May not be null.
  2276. </param>
  2277. <param name="shapeState">
  2278. The state of this cylinder. Must be Cog3DShapeStateConstants.Curve,
  2279. .Surface, or .Volume.
  2280. </param>
  2281. <exception cref="T:System.ArgumentException">
  2282. If <paramref name="radius" /> is less than 0.
  2283. </exception>
  2284. <exception cref="T:System.ArgumentException">
  2285. If <paramref name="height" /> is less than 0.
  2286. </exception>
  2287. <exception cref="T:System.ArgumentNullException">
  2288. If <paramref name="shapeFromScaledUnitCylinder" /> is null.
  2289. </exception>
  2290. <exception cref="T:System.ArgumentException">
  2291. If <paramref name="shapeState" /> is not
  2292. Cog3DShapeStateConstants.Curve, .Surface, or .Volume.
  2293. </exception>
  2294. </member>
  2295. <member name="M:Cognex.VisionPro3D.Cog3DCylinder.#ctor">
  2296. <summary>
  2297. Constructs a degenerate cylinder with Radius of 0, Height of 0,
  2298. ShapeFromScaledUnitCylinder of identity transform,
  2299. and ShapeState of Cog3DShapeStateConstants.Volume.
  2300. </summary>
  2301. </member>
  2302. <member name="T:Cognex.VisionPro3D.Cog3DCylinder">
  2303. <summary>
  2304. This class encapsulates a 3D cylinder.
  2305. A Cog3DCylinder can be defined by a 3D circle (StartCircle) and a
  2306. height(Height). The 3D circle defines the cylinder's bottom circle
  2307. (StartCircle), radius (Radius) and axis direction (AxisDirection).
  2308. The height (Height) defines the cylinder's height along the normal
  2309. direction of StartCircle.
  2310. A 3D cylinder can also be defined by using a UnitCylinder, a radius, a height, and
  2311. a rigid transform ShapeFromScaledUnitCylinder.
  2312. The UnitCylinder has a bottom unit circle centered at the origin, the axis
  2313. of the UnitCylinder is along the positive Z axis and has unit length.
  2314. Scale UnitCylinder using the specified radius and height, so the ScaledUnitCylinder
  2315. has the specified radius and height.
  2316. The rigid transform ShapeFromScaledUnitCylinder is used to transform
  2317. ScaledUnitCylinder to the expected pose in 3D space.
  2318. </summary>
  2319. </member>
  2320. <member name="M:Cognex.VisionPro3D.Cog3DSphere.GetObjectData(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
  2321. <inheritdoc cref="M:Cognex.VisionPro3D.ICog3DBase.GetObjectData(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)" />
  2322. </member>
  2323. <member name="M:Cognex.VisionPro3D.Cog3DSphere.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
  2324. <inheritdoc cref="M:Cognex.VisionPro3D.ICog3DBase.SerializationConstructor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)" />
  2325. </member>
  2326. <member name="M:Cognex.VisionPro3D.Cog3DSphere.RealEqual(Cognex.VisionPro3D.Cog3DSphere,Cognex.VisionPro3D.Cog3DSphere,System.Double)">
  2327. <inheritdoc cref="M:Cognex.VisionPro3D.ICog3DBase.RealEqual(System.Object,System.Object,System.Double)" />
  2328. </member>
  2329. <member name="M:Cognex.VisionPro3D.Cog3DSphere.ToString">
  2330. <inheritdoc cref="M:Cognex.VisionPro3D.ICog3DBase.ToString" />
  2331. </member>
  2332. <member name="M:Cognex.VisionPro3D.Cog3DSphere.MapRigid(Cognex.VisionPro3D.Cog3DTransformRigid)">
  2333. <summary>
  2334. Maps this sphere through the specified rigid transform and
  2335. returns a new Cog3DSphere.
  2336. </summary>
  2337. <param name="newFromOld">
  2338. The rigid transform to use when mapping this sphere.
  2339. </param>
  2340. <returns>
  2341. The Cog3DSphere resulting from mapping this shape through the specified rigid transform.
  2342. </returns>
  2343. <exception cref="T:System.ArgumentNullException">
  2344. If <paramref name="newFromOld" /> is null.
  2345. </exception>
  2346. </member>
  2347. <member name="M:Cognex.VisionPro3D.Cog3DSphere.SetShapeFromScaledUnitSphere(Cognex.VisionPro3D.Cog3DTransformRigid)">
  2348. <summary>
  2349. Set the ShapeFromScaledUnitSphere transform of this sphere.
  2350. It may change the
  2351. value of Center. It does not change the value of Radius.
  2352. </summary>
  2353. <param name="shapeFromScaledUnitSphere">
  2354. A Cog3DTransformRigid used to specify the ShapeFromScaledUnitSphere transform of this sphere.
  2355. This transform
  2356. specifies the pose of the ScaledUnitSphere in 3D space.
  2357. </param>
  2358. <exception cref="T:System.ArgumentNullException">
  2359. If <paramref name="shapeFromScaledUnitSphere" /> is null.
  2360. </exception>
  2361. <event cref="E:Cognex.VisionPro.ICogChangedEvent.Changed">
  2362. <para>Fires when some properties change.</para>
  2363. <para>The following state flags may be affected:</para>
  2364. <list type="bullet">
  2365. <item> SfGetShapeFromScaledUnitSphere </item>
  2366. <item> SfCenter </item>
  2367. <item> SfComputeBoundingBox </item>
  2368. </list>
  2369. </event>
  2370. </member>
  2371. <member name="M:Cognex.VisionPro3D.Cog3DSphere.GetShapeFromScaledUnitSphere">
  2372. <summary>
  2373. Get the ShapeFromScaledUnitSphere transform of this sphere.
  2374. </summary>
  2375. <returns>
  2376. The ShapeFromScaledUnitSphere transform of this sphere. This transform
  2377. specifies the pose of the ScaledUnitSphere in 3D space.
  2378. </returns>
  2379. </member>
  2380. <member name="P:Cognex.VisionPro3D.Cog3DSphere.Center">
  2381. <summary>
  2382. Gets/sets the center position of this sphere.
  2383. </summary>
  2384. <value>
  2385. The center point of this sphere.
  2386. </value>
  2387. <remarks>
  2388. The setter might change the value of GetShapeFromScaledUnitSphere().
  2389. </remarks>
  2390. <event cref="E:Cognex.VisionPro.ICogChangedEvent.Changed">
  2391. <para>Fires when this property changes.</para>
  2392. <para>The following state flags may be affected:</para>
  2393. <list type="bullet">
  2394. <item> SfCenter </item>
  2395. <item> SfGetShapeFromScaledUnitSphere </item>
  2396. <item> SfComputeBoundingBox </item>
  2397. </list>
  2398. </event>
  2399. </member>
  2400. <member name="P:Cognex.VisionPro3D.Cog3DSphere.Radius">
  2401. <summary>
  2402. Gets/sets the radius of this sphere.
  2403. </summary>
  2404. <value>
  2405. The radius of this sphere.
  2406. </value>
  2407. <exception cref="T:System.ArgumentException">
  2408. If <paramref name="newRadius" /> is less than 0.
  2409. </exception>
  2410. <event cref="E:Cognex.VisionPro.ICogChangedEvent.Changed">
  2411. <para>Fires when this property changes.</para>
  2412. <para>The following state flags may be affected:</para>
  2413. <list type="bullet">
  2414. <item> SfRadius </item>
  2415. <item> SfComputeArea </item>
  2416. <item> SfComputeVolume </item>
  2417. <item> SfComputeBoundingBox </item>
  2418. <item> SfIsDegenerateSurface </item>
  2419. <item> SfIsDegenerateVolume </item>
  2420. </list>
  2421. </event>
  2422. </member>
  2423. <member name="P:Cognex.VisionPro3D.Cog3DSphere.ShapeState">
  2424. <summary>
  2425. Gets/sets the ShapeState for this shape.
  2426. </summary>
  2427. <value>
  2428. The ShapeState of this Shape. Must be Cog3DShapeStateConstants.Surface, or .Volume.
  2429. </value>
  2430. <exception cref="T:System.ArgumentException">
  2431. The ShapeState for this shape must be Cog3DShapeStateConstants.Surface, or .Volume.
  2432. </exception>
  2433. <event cref="E:Cognex.VisionPro.ICogChangedEvent.Changed">
  2434. <para>Fires when this property changes.</para>
  2435. <para>The following state flags may be affected:</para>
  2436. <list type="bullet">
  2437. <item> SfShapeState </item>
  2438. </list>
  2439. </event>
  2440. </member>
  2441. <member name="M:Cognex.VisionPro3D.Cog3DSphere.ComputeDistanceVolume(Cognex.VisionPro3D.Cog3DVect3)">
  2442. <inheritdoc />
  2443. </member>
  2444. <member name="M:Cognex.VisionPro3D.Cog3DSphere.ComputeNearestPointVolume(Cognex.VisionPro3D.Cog3DVect3)">
  2445. <inheritdoc />
  2446. </member>
  2447. <member name="P:Cognex.VisionPro3D.Cog3DSphere.IsDegenerateVolume">
  2448. <inheritdoc />
  2449. </member>
  2450. <member name="M:Cognex.VisionPro3D.Cog3DSphere.ComputeVolume">
  2451. <inheritdoc />
  2452. </member>
  2453. <member name="M:Cognex.VisionPro3D.Cog3DSphere.ComputeDistanceSurface(Cognex.VisionPro3D.Cog3DVect3)">
  2454. <inheritdoc />
  2455. </member>
  2456. <member name="M:Cognex.VisionPro3D.Cog3DSphere.ComputeNearestPointSurface(Cognex.VisionPro3D.Cog3DVect3)">
  2457. <inheritdoc />
  2458. </member>
  2459. <member name="P:Cognex.VisionPro3D.Cog3DSphere.IsDegenerateSurface">
  2460. <inheritdoc />
  2461. </member>
  2462. <member name="M:Cognex.VisionPro3D.Cog3DSphere.ComputeArea">
  2463. <inheritdoc />
  2464. </member>
  2465. <member name="M:Cognex.VisionPro3D.Cog3DSphere.MapShape(Cognex.VisionPro3D.ICog3DTransform)">
  2466. <inheritdoc />
  2467. </member>
  2468. <member name="M:Cognex.VisionPro3D.Cog3DSphere.ComputeBoundingBox">
  2469. <inheritdoc />
  2470. </member>
  2471. <member name="P:Cognex.VisionPro3D.Cog3DSphere.SelectedSpaceName3D">
  2472. <inheritdoc />
  2473. </member>
  2474. <member name="M:Cognex.VisionPro3D.Cog3DSphere.ComputeDistance(Cognex.VisionPro3D.Cog3DVect3)">
  2475. <inheritdoc />
  2476. </member>
  2477. <member name="M:Cognex.VisionPro3D.Cog3DSphere.ComputeNearestPoint(Cognex.VisionPro3D.Cog3DVect3)">
  2478. <inheritdoc />
  2479. </member>
  2480. <member name="P:Cognex.VisionPro3D.Cog3DSphere.IsEmpty">
  2481. <inheritdoc />
  2482. </member>
  2483. <member name="P:Cognex.VisionPro3D.Cog3DSphere.IsFinite">
  2484. <inheritdoc />
  2485. </member>
  2486. <member name="M:Cognex.VisionPro3D.Cog3DSphere.Clone">
  2487. <inheritdoc />
  2488. </member>
  2489. <member name="M:Cognex.VisionPro3D.Cog3DSphere.Finalize">
  2490. <inheritdoc cref="M:Cognex.VisionPro3D.ICog3DBase.FinalizerForThisClass" />
  2491. </member>
  2492. <member name="M:Cognex.VisionPro3D.Cog3DSphere.Dispose">
  2493. <inheritdoc cref="M:Cognex.VisionPro3D.ICog3DBase.DestructorForThisClass" />
  2494. </member>
  2495. <member name="M:Cognex.VisionPro3D.Cog3DSphere.#ctor(Cognex.VisionPro3D.Cog3DSphere)">
  2496. <inheritdoc cref="M:Cognex.VisionPro3D.ICog3DBase.DeepCopyConstructorForThisClass(System.Object)" />
  2497. </member>
  2498. <member name="M:Cognex.VisionPro3D.Cog3DSphere.#ctor(System.Double,Cognex.VisionPro3D.Cog3DVect3,Cognex.VisionPro3D.Cog3DShapeStateConstants)">
  2499. <summary>
  2500. Constructs a sphere using the specified radius, center, and
  2501. Cog3DShapeStateConstants.
  2502. </summary>
  2503. <param name="radius">
  2504. The radius of the sphere. radius must be &gt;= 0.
  2505. </param>
  2506. <param name="center">
  2507. The center of the sphere.
  2508. </param>
  2509. <param name="shapeState">
  2510. The state of this sphere. Must be Cog3DShapeStateConstants.Surface,
  2511. or .Volume.
  2512. </param>
  2513. <exception cref="T:System.ArgumentException">
  2514. If <paramref name="radius" /> is less than 0.
  2515. </exception>
  2516. <exception cref="T:System.ArgumentException">
  2517. If <paramref name="shapeState" /> is neither
  2518. Cog3DShapeStateConstants.Surface, nor .Volume.
  2519. </exception>
  2520. </member>
  2521. <member name="M:Cognex.VisionPro3D.Cog3DSphere.#ctor(System.Double,Cognex.VisionPro3D.Cog3DTransformRigid,Cognex.VisionPro3D.Cog3DShapeStateConstants)">
  2522. <summary>
  2523. Constructs a sphere using the specified radius, rigid transform,
  2524. and Cog3DShapeStateConstants.
  2525. </summary>
  2526. <param name="radius">
  2527. The radius of this sphere. Must be &gt;= 0.
  2528. </param>
  2529. <param name="shapeFromScaledUnitSphere">
  2530. The rigid transform that maps the ScaledUnitSphere to a pose in 3D space.
  2531. </param>
  2532. <param name="shapeState">
  2533. The state of this sphere. Must be Cog3DShapeStateConstants.Surface,
  2534. or .Volume.
  2535. </param>
  2536. <exception cref="T:System.ArgumentException">
  2537. If <paramref name="radius" /> is less than 0.
  2538. </exception>
  2539. <exception cref="T:System.ArgumentNullException">
  2540. If <paramref name="shapeFromScaledUnitSphere" /> is null.
  2541. </exception>
  2542. <exception cref="T:System.ArgumentException">
  2543. If <paramref name="shapeState" /> is neither
  2544. Cog3DShapeStateConstants.Surface nor .Volume.
  2545. </exception>
  2546. </member>
  2547. <member name="M:Cognex.VisionPro3D.Cog3DSphere.#ctor">
  2548. <summary>
  2549. Constructs a degenerate sphere with Radius of 0, Center of (0,0,0),
  2550. ShapeFromScaledUnitSphere of identity transform,
  2551. and ShapeState of Cog3DShapeStateConstants.Volume.
  2552. </summary>
  2553. </member>
  2554. <member name="T:Cognex.VisionPro3D.Cog3DSphere">
  2555. <summary>
  2556. This class encapsulates a 3D sphere.
  2557. A Cog3DSphere can be defined by a radius (Radius) and a center (Center).
  2558. It can also be defined by a radius and a 3D rigid transform: the radius
  2559. defines a sphere centered at the origin (cc3DVect(0,0,0)) with the
  2560. specified radius, and the rigid transform (ShapeFromScaledUnitSphere)
  2561. is used to transform the above sphere to the expected pose in 3D space.
  2562. </summary>
  2563. </member>
  2564. <member name="M:Cognex.VisionPro3D.Cog3DPoint.GetObjectData(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
  2565. <inheritdoc cref="M:Cognex.VisionPro3D.ICog3DBase.GetObjectData(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)" />
  2566. </member>
  2567. <member name="M:Cognex.VisionPro3D.Cog3DPoint.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
  2568. <inheritdoc cref="M:Cognex.VisionPro3D.ICog3DBase.SerializationConstructor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)" />
  2569. </member>
  2570. <member name="M:Cognex.VisionPro3D.Cog3DPoint.RealEqual(Cognex.VisionPro3D.Cog3DPoint,Cognex.VisionPro3D.Cog3DPoint,System.Double)">
  2571. <inheritdoc cref="M:Cognex.VisionPro3D.ICog3DBase.RealEqual(System.Object,System.Object,System.Double)" />
  2572. </member>
  2573. <member name="M:Cognex.VisionPro3D.Cog3DPoint.ToString">
  2574. <inheritdoc cref="M:Cognex.VisionPro3D.ICog3DBase.ToString" />
  2575. </member>
  2576. <member name="M:Cognex.VisionPro3D.Cog3DPoint.MapRigid(Cognex.VisionPro3D.Cog3DTransformRigid)">
  2577. <summary>
  2578. Maps this point through the specified rigid transform and
  2579. returns a Cog3DPoint.
  2580. </summary>
  2581. <param name="transform">
  2582. The rigid transform to use when mapping this point.
  2583. </param>
  2584. <returns>
  2585. The Cog3DPoint resulting from mapping this point through the specified rigid transform.
  2586. </returns>
  2587. <exception cref="T:System.ArgumentNullException">
  2588. If <paramref name="transform" /> is null.
  2589. </exception>
  2590. </member>
  2591. <member name="P:Cognex.VisionPro3D.Cog3DPoint.Z">
  2592. <summary>
  2593. Gets/sets the z component of this point's 3D position.
  2594. </summary>
  2595. <value>
  2596. The z component of this point's 3D position.
  2597. </value>
  2598. </member>
  2599. <member name="P:Cognex.VisionPro3D.Cog3DPoint.Y">
  2600. <summary>
  2601. Gets/sets the y component of this point's 3D position.
  2602. </summary>
  2603. <value>
  2604. The y component of this point's 3D position.
  2605. </value>
  2606. </member>
  2607. <member name="P:Cognex.VisionPro3D.Cog3DPoint.X">
  2608. <summary>
  2609. Gets/sets the x component of this point's 3D position.
  2610. </summary>
  2611. <value>
  2612. The x component of this point's 3D position.
  2613. </value>
  2614. </member>
  2615. <member name="P:Cognex.VisionPro3D.Cog3DPoint.ShapeState">
  2616. <summary>
  2617. Gets the ShapeState for this shape.
  2618. </summary>
  2619. <value>
  2620. The ShapeState of this Shape.
  2621. </value>
  2622. </member>
  2623. <member name="M:Cognex.VisionPro3D.Cog3DPoint.ComputeDistanceVertex(Cognex.VisionPro3D.Cog3DVect3)">
  2624. <inheritdoc />
  2625. </member>
  2626. <member name="M:Cognex.VisionPro3D.Cog3DPoint.ComputeNearestPointVertex(Cognex.VisionPro3D.Cog3DVect3)">
  2627. <inheritdoc />
  2628. </member>
  2629. <member name="M:Cognex.VisionPro3D.Cog3DPoint.MapShape(Cognex.VisionPro3D.ICog3DTransform)">
  2630. <inheritdoc />
  2631. </member>
  2632. <member name="M:Cognex.VisionPro3D.Cog3DPoint.ComputeBoundingBox">
  2633. <inheritdoc />
  2634. </member>
  2635. <member name="P:Cognex.VisionPro3D.Cog3DPoint.SelectedSpaceName3D">
  2636. <inheritdoc />
  2637. </member>
  2638. <member name="M:Cognex.VisionPro3D.Cog3DPoint.ComputeDistance(Cognex.VisionPro3D.Cog3DVect3)">
  2639. <inheritdoc />
  2640. </member>
  2641. <member name="M:Cognex.VisionPro3D.Cog3DPoint.ComputeNearestPoint(Cognex.VisionPro3D.Cog3DVect3)">
  2642. <inheritdoc />
  2643. </member>
  2644. <member name="P:Cognex.VisionPro3D.Cog3DPoint.IsEmpty">
  2645. <inheritdoc />
  2646. </member>
  2647. <member name="P:Cognex.VisionPro3D.Cog3DPoint.IsFinite">
  2648. <inheritdoc />
  2649. </member>
  2650. <member name="M:Cognex.VisionPro3D.Cog3DPoint.Clone">
  2651. <inheritdoc />
  2652. </member>
  2653. <member name="M:Cognex.VisionPro3D.Cog3DPoint.Finalize">
  2654. <inheritdoc cref="M:Cognex.VisionPro3D.ICog3DBase.FinalizerForThisClass" />
  2655. </member>
  2656. <member name="M:Cognex.VisionPro3D.Cog3DPoint.Dispose">
  2657. <inheritdoc cref="M:Cognex.VisionPro3D.ICog3DBase.DestructorForThisClass" />
  2658. </member>
  2659. <member name="M:Cognex.VisionPro3D.Cog3DPoint.#ctor(Cognex.VisionPro3D.Cog3DVect3)">
  2660. <summary>
  2661. Constructs a Cog3DPoint using a specified Cog3DVect3.
  2662. </summary>
  2663. <param name="point">
  2664. The position vector of the 3D point.
  2665. </param>
  2666. </member>
  2667. <member name="M:Cognex.VisionPro3D.Cog3DPoint.#ctor(System.Double,System.Double,System.Double)">
  2668. <summary>
  2669. Constructs a Cog3DPoint using the specified 3D position.
  2670. </summary>
  2671. <param name="x">
  2672. The x component of the point's 3D position.
  2673. </param>
  2674. <param name="y">
  2675. The y component of the point's 3D position.
  2676. </param>
  2677. <param name="z">
  2678. The z component of the point's 3D position.
  2679. </param>
  2680. </member>
  2681. <member name="M:Cognex.VisionPro3D.Cog3DPoint.#ctor(Cognex.VisionPro3D.Cog3DPoint)">
  2682. <inheritdoc cref="M:Cognex.VisionPro3D.ICog3DBase.DeepCopyConstructorForThisClass(System.Object)" />
  2683. </member>
  2684. <member name="M:Cognex.VisionPro3D.Cog3DPoint.#ctor">
  2685. <summary>
  2686. Constructs a Cog3DPoint consistent with
  2687. Cog3DPoint(0, 0, 0).
  2688. </summary>
  2689. </member>
  2690. <member name="T:Cognex.VisionPro3D.Cog3DPoint">
  2691. <summary>
  2692. This class encapsulates a 3D point shape.
  2693. </summary>
  2694. </member>
  2695. <member name="M:Cognex.VisionPro3D.Cog3DCircle.GetObjectData(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
  2696. <inheritdoc cref="M:Cognex.VisionPro3D.ICog3DBase.GetObjectData(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)" />
  2697. </member>
  2698. <member name="M:Cognex.VisionPro3D.Cog3DCircle.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
  2699. <inheritdoc cref="M:Cognex.VisionPro3D.ICog3DBase.SerializationConstructor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)" />
  2700. </member>
  2701. <member name="M:Cognex.VisionPro3D.Cog3DCircle.RealEqual(Cognex.VisionPro3D.Cog3DCircle,Cognex.VisionPro3D.Cog3DCircle,System.Double)">
  2702. <inheritdoc cref="M:Cognex.VisionPro3D.ICog3DBase.RealEqual(System.Object,System.Object,System.Double)" />
  2703. </member>
  2704. <member name="M:Cognex.VisionPro3D.Cog3DCircle.ToString">
  2705. <inheritdoc cref="M:Cognex.VisionPro3D.ICog3DBase.ToString" />
  2706. </member>
  2707. <member name="M:Cognex.VisionPro3D.Cog3DCircle.MapRigid(Cognex.VisionPro3D.Cog3DTransformRigid)">
  2708. <summary>
  2709. Maps this circle through the specified rigid transform and
  2710. returns a Cog3DCircle.
  2711. </summary>
  2712. <param name="newFromOld">
  2713. The rigid transform to use when mapping this circle.
  2714. </param>
  2715. <returns>
  2716. The Cog3DCircle resulting from mapping this shape through the specified rigid transform.
  2717. </returns>
  2718. <exception cref="T:System.ArgumentNullException">
  2719. If <paramref name="newFromOld" /> is null.
  2720. </exception>
  2721. </member>
  2722. <member name="M:Cognex.VisionPro3D.Cog3DCircle.SetShapeFromScaledUnitCircle(Cognex.VisionPro3D.Cog3DTransformRigid)">
  2723. <summary>
  2724. Set the ShapeFromScaledUnitCircle transform of this circle.
  2725. It may change the
  2726. value of Center. It does not change the value of Radius.
  2727. </summary>
  2728. <param name="shapeFromScaledUnitCircle">
  2729. A Cog3DTransformRigid used to specify the ShapeFromScaledUnitCircle transform of this circle.
  2730. This transform
  2731. specifies the pose of the ScaledUnitCircle in 3D space.
  2732. </param>
  2733. <exception cref="T:System.ArgumentNullException">
  2734. If <paramref name="shapeFromScaledUnitCircle" /> is null.
  2735. </exception>
  2736. <event cref="E:Cognex.VisionPro.ICogChangedEvent.Changed">
  2737. <para>Fires when some properties change.</para>
  2738. <para>The following state flags may be affected:</para>
  2739. <list type="bullet">
  2740. <item> SfGetShapeFromScaledUnitCircle </item>
  2741. <item> SfNormal </item>
  2742. <item> SfCenter </item>
  2743. <item> SfComputeBoundingBox </item>
  2744. </list>
  2745. </event>
  2746. </member>
  2747. <member name="M:Cognex.VisionPro3D.Cog3DCircle.GetShapeFromScaledUnitCircle">
  2748. <summary>
  2749. Get the ShapeFromScaledUnitCircle transform of this circle.
  2750. </summary>
  2751. <returns>
  2752. The ShapeFromScaledUnitCircle transform of this circle. This transform
  2753. specifies the pose of the ScaledUnitCircle in 3D space.
  2754. </returns>
  2755. </member>
  2756. <member name="P:Cognex.VisionPro3D.Cog3DCircle.Normal">
  2757. <summary>
  2758. Gets/sets the normal direction of this circle.
  2759. </summary>
  2760. <value>
  2761. The normal direction of this circle.
  2762. </value>
  2763. <remarks>
  2764. The setter might change the value of GetShapeFromScaledUnitCircle().
  2765. </remarks>
  2766. <exception cref="T:System.ArgumentException">
  2767. If <paramref name="normal" /> is (0,0,0).
  2768. </exception>
  2769. <event cref="E:Cognex.VisionPro.ICogChangedEvent.Changed">
  2770. <para>Fires when this property changes.</para>
  2771. <para>The following state flags may be affected:</para>
  2772. <list type="bullet">
  2773. <item> SfNormal </item>
  2774. <item> SfGetShapeFromScaledUnitCircle </item>
  2775. <item> SfComputeBoundingBox </item>
  2776. </list>
  2777. </event>
  2778. </member>
  2779. <member name="P:Cognex.VisionPro3D.Cog3DCircle.Center">
  2780. <summary>
  2781. Gets/sets the center position of this circle.
  2782. </summary>
  2783. <value>
  2784. The center point of this circle.
  2785. </value>
  2786. <remarks>
  2787. The setter might change the value of GetShapeFromScaledUnitCircle().
  2788. </remarks>
  2789. <event cref="E:Cognex.VisionPro.ICogChangedEvent.Changed">
  2790. <para>Fires when this property changes.</para>
  2791. <para>The following state flags may be affected:</para>
  2792. <list type="bullet">
  2793. <item> SfCenter </item>
  2794. <item> SfGetShapeFromScaledUnitCircle </item>
  2795. <item> SfComputeBoundingBox </item>
  2796. </list>
  2797. </event>
  2798. </member>
  2799. <member name="P:Cognex.VisionPro3D.Cog3DCircle.Radius">
  2800. <summary>
  2801. Gets/sets the radius of this circle.
  2802. </summary>
  2803. <value>
  2804. The radius of this circle.
  2805. </value>
  2806. <exception cref="T:System.ArgumentException">
  2807. If <paramref name="newRadius" /> is less than 0.
  2808. </exception>
  2809. <event cref="E:Cognex.VisionPro.ICogChangedEvent.Changed">
  2810. <para>Fires when this property changes.</para>
  2811. <para>The following state flags may be affected:</para>
  2812. <list type="bullet">
  2813. <item> SfRadius </item>
  2814. <item> SfComputePerimeter </item>
  2815. <item> SfComputeArea </item>
  2816. <item> SfComputeBoundingBox </item>
  2817. <item> SfIsDegenerateCurve </item>
  2818. <item> SfIsDegenerateSurface </item>
  2819. </list>
  2820. </event>
  2821. </member>
  2822. <member name="P:Cognex.VisionPro3D.Cog3DCircle.ShapeState">
  2823. <summary>
  2824. Gets/sets the ShapeState for this shape.
  2825. </summary>
  2826. <value>
  2827. The ShapeState of this Shape. Must be Cog3DShapeStateConstants.Curve, or .Surface.
  2828. </value>
  2829. <exception cref="T:System.ArgumentException">
  2830. The ShapeState for this shape must be Cog3DShapeStateConstants.Curve, or .Surface.
  2831. </exception>
  2832. <event cref="E:Cognex.VisionPro.ICogChangedEvent.Changed">
  2833. <para>Fires when this property changes.</para>
  2834. <para>The following state flags may be affected:</para>
  2835. <list type="bullet">
  2836. <item> SfShapeState </item>
  2837. </list>
  2838. </event>
  2839. </member>
  2840. <member name="M:Cognex.VisionPro3D.Cog3DCircle.ComputeDistanceSurface(Cognex.VisionPro3D.Cog3DVect3)">
  2841. <inheritdoc />
  2842. </member>
  2843. <member name="M:Cognex.VisionPro3D.Cog3DCircle.ComputeNearestPointSurface(Cognex.VisionPro3D.Cog3DVect3)">
  2844. <inheritdoc />
  2845. </member>
  2846. <member name="P:Cognex.VisionPro3D.Cog3DCircle.IsDegenerateSurface">
  2847. <inheritdoc />
  2848. </member>
  2849. <member name="M:Cognex.VisionPro3D.Cog3DCircle.ComputeArea">
  2850. <inheritdoc />
  2851. </member>
  2852. <member name="M:Cognex.VisionPro3D.Cog3DCircle.ComputeDistanceCurve(Cognex.VisionPro3D.Cog3DVect3)">
  2853. <inheritdoc />
  2854. </member>
  2855. <member name="M:Cognex.VisionPro3D.Cog3DCircle.ComputeNearestPointCurve(Cognex.VisionPro3D.Cog3DVect3)">
  2856. <inheritdoc />
  2857. </member>
  2858. <member name="P:Cognex.VisionPro3D.Cog3DCircle.IsDegenerateCurve">
  2859. <inheritdoc />
  2860. </member>
  2861. <member name="M:Cognex.VisionPro3D.Cog3DCircle.ComputePerimeter">
  2862. <inheritdoc />
  2863. </member>
  2864. <member name="M:Cognex.VisionPro3D.Cog3DCircle.MapShape(Cognex.VisionPro3D.ICog3DTransform)">
  2865. <inheritdoc />
  2866. </member>
  2867. <member name="M:Cognex.VisionPro3D.Cog3DCircle.ComputeBoundingBox">
  2868. <inheritdoc />
  2869. </member>
  2870. <member name="P:Cognex.VisionPro3D.Cog3DCircle.SelectedSpaceName3D">
  2871. <inheritdoc />
  2872. </member>
  2873. <member name="M:Cognex.VisionPro3D.Cog3DCircle.ComputeDistance(Cognex.VisionPro3D.Cog3DVect3)">
  2874. <inheritdoc />
  2875. </member>
  2876. <member name="M:Cognex.VisionPro3D.Cog3DCircle.ComputeNearestPoint(Cognex.VisionPro3D.Cog3DVect3)">
  2877. <inheritdoc />
  2878. </member>
  2879. <member name="P:Cognex.VisionPro3D.Cog3DCircle.IsEmpty">
  2880. <inheritdoc />
  2881. </member>
  2882. <member name="P:Cognex.VisionPro3D.Cog3DCircle.IsFinite">
  2883. <inheritdoc />
  2884. </member>
  2885. <member name="M:Cognex.VisionPro3D.Cog3DCircle.Clone">
  2886. <inheritdoc />
  2887. </member>
  2888. <member name="M:Cognex.VisionPro3D.Cog3DCircle.Finalize">
  2889. <inheritdoc cref="M:Cognex.VisionPro3D.ICog3DBase.FinalizerForThisClass" />
  2890. </member>
  2891. <member name="M:Cognex.VisionPro3D.Cog3DCircle.Dispose">
  2892. <inheritdoc cref="M:Cognex.VisionPro3D.ICog3DBase.DestructorForThisClass" />
  2893. </member>
  2894. <member name="M:Cognex.VisionPro3D.Cog3DCircle.#ctor(Cognex.VisionPro3D.Cog3DCircle)">
  2895. <inheritdoc cref="M:Cognex.VisionPro3D.ICog3DBase.DeepCopyConstructorForThisClass(System.Object)" />
  2896. </member>
  2897. <member name="M:Cognex.VisionPro3D.Cog3DCircle.#ctor(System.Double,Cognex.VisionPro3D.Cog3DVect3,Cognex.VisionPro3D.Cog3DVect3,Cognex.VisionPro3D.Cog3DShapeStateConstants)">
  2898. <summary>
  2899. Constructs a circle using the specified radius, center, normal direction, and
  2900. Cog3DShapeStateConstants.
  2901. </summary>
  2902. <param name="radius">
  2903. The radius of the circle. radius must be &gt;= 0.
  2904. </param>
  2905. <param name="center">
  2906. The center of the circle.
  2907. </param>
  2908. <param name="normal">
  2909. The normal direction of the circle.
  2910. </param>
  2911. <param name="shapeState">
  2912. The state of this box. Must be Cog3DShapeStateConstants..Curve, or .Surface.
  2913. </param>
  2914. <exception cref="T:System.ArgumentException">
  2915. If radius is less than 0.
  2916. </exception>
  2917. <exception cref="T:System.ArgumentException">
  2918. If <paramref name="normal" /> is (0,0,0).
  2919. </exception>
  2920. <exception cref="T:System.ArgumentException">
  2921. The ShapeState for this shape must be Cog3DShapeStateConstants.Curve, or .Surface.
  2922. </exception>
  2923. </member>
  2924. <member name="M:Cognex.VisionPro3D.Cog3DCircle.#ctor(System.Double,Cognex.VisionPro3D.Cog3DTransformRigid,Cognex.VisionPro3D.Cog3DShapeStateConstants)">
  2925. <summary>
  2926. Constructs a circle using the specified radius, transform, and Cog3DShapeStateConstants.
  2927. </summary>
  2928. <param name="radius">
  2929. The radius of the circle. radius must be &gt;= 0.
  2930. </param>
  2931. <param name="shapeFromScaledUnitCircle">
  2932. The rigid transform that maps the ScaledUnitCircle to a pose in 3D space.
  2933. </param>
  2934. <param name="shapeState">
  2935. The state of this box. Must be Cog3DShapeStateConstants.Curve, or .Surface.
  2936. </param>
  2937. <exception cref="T:System.ArgumentException">
  2938. If radius is less than 0.
  2939. </exception>
  2940. <exception cref="T:System.ArgumentNullException">
  2941. If <paramref name="shapeFromScaledUnitCircle" /> is null.
  2942. </exception>
  2943. <exception cref="T:System.ArgumentException">
  2944. The ShapeState for this shape must be Cog3DShapeStateConstants.Curve, or .Surface.
  2945. </exception>
  2946. </member>
  2947. <member name="M:Cognex.VisionPro3D.Cog3DCircle.#ctor">
  2948. <summary>
  2949. Constructs a degenerate circle on the XY
  2950. plane and whose center is at the origin. Radius is 0,
  2951. ShapeFromScaledUnitCircle is identity transform,
  2952. and ShapeState is Cog3DShapeStateConstants.Surface.
  2953. </summary>
  2954. </member>
  2955. <member name="T:Cognex.VisionPro3D.Cog3DCircle">
  2956. <summary>
  2957. This is the shape class for representing an oriented 3D circle.
  2958. A Cog3DCircle can be defined by a radius (Radius), a center (Center), and a normal
  2959. direction (Normal). It can also be defined by a radius and a 3D rigid transform:
  2960. the radius defines
  2961. a circle on the XY plane whose center is at the origin ((0,0,0)) and
  2962. has the specified radius, the rigid transform (ShapeFromScaledUnitCircle) is used
  2963. to transform the above circle on the XY plane to the expected pose in
  2964. 3D space.
  2965. </summary>
  2966. </member>
  2967. <member name="M:Cognex.VisionPro3D.Cog3DAlignedBox.GetObjectData(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
  2968. <inheritdoc cref="M:Cognex.VisionPro3D.ICog3DBase.GetObjectData(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)" />
  2969. </member>
  2970. <member name="M:Cognex.VisionPro3D.Cog3DAlignedBox.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
  2971. <inheritdoc cref="M:Cognex.VisionPro3D.ICog3DBase.SerializationConstructor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)" />
  2972. </member>
  2973. <member name="M:Cognex.VisionPro3D.Cog3DAlignedBox.RealEqual(Cognex.VisionPro3D.Cog3DAlignedBox,Cognex.VisionPro3D.Cog3DAlignedBox,System.Double)">
  2974. <inheritdoc cref="M:Cognex.VisionPro3D.ICog3DBase.RealEqual(System.Object,System.Object,System.Double)" />
  2975. </member>
  2976. <member name="M:Cognex.VisionPro3D.Cog3DAlignedBox.ToString">
  2977. <inheritdoc cref="M:Cognex.VisionPro3D.ICog3DBase.ToString" />
  2978. </member>
  2979. <member name="M:Cognex.VisionPro3D.Cog3DAlignedBox.GetSurfaces">
  2980. <summary>
  2981. Computes the surfaces of this box.
  2982. </summary>
  2983. <returns>
  2984. The list of surfaces of this box.
  2985. </returns>
  2986. <remarks>
  2987. Notes:
  2988. <list type="bullet"><item> Assuming a unit box, the order of the returned rectangles is
  2989. (uisng a pair of opposite vertices for each rectangle):
  2990. <list type="bullet"><item> 0 Cog3DVect3(0,0,0), Cog3DVect3(1,1,0) </item><item> 1 Cog3DVect3(0,0,1), Cog3DVect3(1,1,1) </item><item> 2 Cog3DVect3(0,0,0), Cog3DVect3(1,0,1) </item><item> 3 Cog3DVect3(1,0,0), Cog3DVect3(1,1,1) </item><item> 4 Cog3DVect3(0,1,0), Cog3DVect3(1,1,1) </item><item> 5 Cog3DVect3(0,0,0), Cog3DVect3(0,1,1) </item></list></item><item> Each element of the returned list has the
  2991. ShapeState value of Cog3DShapeStateConstants.Surface no matter the current ShapeState
  2992. value of the box. </item><item> Some elements of the returned list might be degenerate rectangles
  2993. and some elements might be duplicate if this box is
  2994. degenerate. </item></list></remarks>
  2995. </member>
  2996. <member name="M:Cognex.VisionPro3D.Cog3DAlignedBox.GetLineSegments">
  2997. <inheritdoc cref="M:Cognex.VisionPro3D.Cog3DBox.GetLineSegments" />
  2998. </member>
  2999. <member name="M:Cognex.VisionPro3D.Cog3DAlignedBox.GetVertices">
  3000. <summary>
  3001. Computes the set of vertices defining this aligned box. Assuming a
  3002. unit box, the order of the returned vertices is: (0,0,0) (1,0,0)
  3003. (1,1,0) (0,1,0) (0,0,1) (1,0,1) (1,1,1), (0,1,1).
  3004. </summary>
  3005. <returns>
  3006. The set of vertices defining this aligned box.
  3007. </returns>
  3008. </member>
  3009. <member name="M:Cognex.VisionPro3D.Cog3DAlignedBox.MapRigid(Cognex.VisionPro3D.Cog3DTransformRigid)">
  3010. <summary>
  3011. Maps this aligned box through the specified rigid transform and
  3012. returns a Cog3DBox.
  3013. </summary>
  3014. <param name="newFromOld">
  3015. The rigid transform to use when mapping this aligned box.
  3016. </param>
  3017. <returns>
  3018. The Cog3DBox resulting from mapping this shape through the specified rigid transform.
  3019. </returns>
  3020. <exception cref="T:System.ArgumentNullException">
  3021. If <paramref name="newFromOld" /> is null.
  3022. </exception>
  3023. </member>
  3024. <member name="P:Cognex.VisionPro3D.Cog3DAlignedBox.Translation">
  3025. <summary>
  3026. Gets/sets the translation of this aligned box. Changing the translation
  3027. will change the value returned by Center.
  3028. </summary>
  3029. <value>
  3030. The translation of this aligned box.
  3031. </value>
  3032. <event cref="E:Cognex.VisionPro.ICogChangedEvent.Changed">
  3033. <para>Fires when this property changes.</para>
  3034. <para>The following state flags may be affected:</para>
  3035. <list type="bullet">
  3036. <item> SfTranslation </item>
  3037. <item> SfCenter </item>
  3038. <item> SfGetSurfaces </item>
  3039. <item> SfGetLineSegments </item>
  3040. <item> SfGetVertices </item>
  3041. <item> SfComputeBoundingBox </item>
  3042. </list>
  3043. </event>
  3044. </member>
  3045. <member name="P:Cognex.VisionPro3D.Cog3DAlignedBox.Center">
  3046. <summary>
  3047. Gets the center position of this aligned box.
  3048. </summary>
  3049. <value>
  3050. The center point of this aligned box.
  3051. </value>
  3052. </member>
  3053. <member name="P:Cognex.VisionPro3D.Cog3DAlignedBox.Size">
  3054. <summary>
  3055. Gets/sets the size of this aligned box. The setter may change the
  3056. value of Center. It does not change the value of Translation.
  3057. </summary>
  3058. <value>
  3059. The size of this aligned box.
  3060. </value>
  3061. <exception cref="T:System.ArgumentException">
  3062. If any member of <paramref name="size" /> is less than 0.
  3063. </exception>
  3064. <event cref="E:Cognex.VisionPro.ICogChangedEvent.Changed">
  3065. <para>Fires when this property changes.</para>
  3066. <para>The following state flags may be affected:</para>
  3067. <list type="bullet">
  3068. <item> SfSize </item>
  3069. <item> SfCenter </item>
  3070. <item> SfGetSurfaces </item>
  3071. <item> SfGetLineSegments </item>
  3072. <item> SfGetVertices </item>
  3073. <item> SfComputePerimeter </item>
  3074. <item> SfComputeArea </item>
  3075. <item> SfComputeVolume </item>
  3076. <item> SfComputeBoundingBox </item>
  3077. <item> SfIsDegenerateCurve </item>
  3078. <item> SfIsDegenerateSurface </item>
  3079. <item> SfIsDegenerateVolume </item>
  3080. </list>
  3081. </event>
  3082. </member>
  3083. <member name="P:Cognex.VisionPro3D.Cog3DAlignedBox.ShapeState">
  3084. <summary>
  3085. Gets/sets the ShapeState for this shape.
  3086. </summary>
  3087. <value>
  3088. The ShapeState of this Shape. Must be Cog3DShapeStateConstants.Vertex, .Curve, .Surface, or .Volume.
  3089. </value>
  3090. <exception cref="T:System.ArgumentException">
  3091. The ShapeState for this shape must be Cog3DShapeStateConstants.Vertex, .Curve, .Surface, or .Volume.
  3092. </exception>
  3093. <event cref="E:Cognex.VisionPro.ICogChangedEvent.Changed">
  3094. <para>Fires when this property changes.</para>
  3095. <para>The following state flags may be affected:</para>
  3096. <list type="bullet">
  3097. <item> SfShapeState </item>
  3098. </list>
  3099. </event>
  3100. </member>
  3101. <member name="M:Cognex.VisionPro3D.Cog3DAlignedBox.ComputeDistanceVolume(Cognex.VisionPro3D.Cog3DVect3)">
  3102. <inheritdoc />
  3103. </member>
  3104. <member name="M:Cognex.VisionPro3D.Cog3DAlignedBox.ComputeNearestPointVolume(Cognex.VisionPro3D.Cog3DVect3)">
  3105. <inheritdoc />
  3106. </member>
  3107. <member name="P:Cognex.VisionPro3D.Cog3DAlignedBox.IsDegenerateVolume">
  3108. <inheritdoc />
  3109. </member>
  3110. <member name="M:Cognex.VisionPro3D.Cog3DAlignedBox.ComputeVolume">
  3111. <inheritdoc />
  3112. </member>
  3113. <member name="M:Cognex.VisionPro3D.Cog3DAlignedBox.ComputeDistanceSurface(Cognex.VisionPro3D.Cog3DVect3)">
  3114. <inheritdoc />
  3115. </member>
  3116. <member name="M:Cognex.VisionPro3D.Cog3DAlignedBox.ComputeNearestPointSurface(Cognex.VisionPro3D.Cog3DVect3)">
  3117. <inheritdoc />
  3118. </member>
  3119. <member name="P:Cognex.VisionPro3D.Cog3DAlignedBox.IsDegenerateSurface">
  3120. <inheritdoc />
  3121. </member>
  3122. <member name="M:Cognex.VisionPro3D.Cog3DAlignedBox.ComputeArea">
  3123. <inheritdoc />
  3124. </member>
  3125. <member name="M:Cognex.VisionPro3D.Cog3DAlignedBox.ComputeDistanceCurve(Cognex.VisionPro3D.Cog3DVect3)">
  3126. <inheritdoc />
  3127. </member>
  3128. <member name="M:Cognex.VisionPro3D.Cog3DAlignedBox.ComputeNearestPointCurve(Cognex.VisionPro3D.Cog3DVect3)">
  3129. <inheritdoc />
  3130. </member>
  3131. <member name="P:Cognex.VisionPro3D.Cog3DAlignedBox.IsDegenerateCurve">
  3132. <inheritdoc />
  3133. </member>
  3134. <member name="M:Cognex.VisionPro3D.Cog3DAlignedBox.ComputePerimeter">
  3135. <inheritdoc />
  3136. </member>
  3137. <member name="M:Cognex.VisionPro3D.Cog3DAlignedBox.ComputeDistanceVertex(Cognex.VisionPro3D.Cog3DVect3)">
  3138. <inheritdoc />
  3139. </member>
  3140. <member name="M:Cognex.VisionPro3D.Cog3DAlignedBox.ComputeNearestPointVertex(Cognex.VisionPro3D.Cog3DVect3)">
  3141. <inheritdoc />
  3142. </member>
  3143. <member name="M:Cognex.VisionPro3D.Cog3DAlignedBox.MapShape(Cognex.VisionPro3D.ICog3DTransform)">
  3144. <inheritdoc />
  3145. </member>
  3146. <member name="M:Cognex.VisionPro3D.Cog3DAlignedBox.ComputeBoundingBox">
  3147. <inheritdoc />
  3148. </member>
  3149. <member name="P:Cognex.VisionPro3D.Cog3DAlignedBox.SelectedSpaceName3D">
  3150. <inheritdoc />
  3151. </member>
  3152. <member name="M:Cognex.VisionPro3D.Cog3DAlignedBox.ComputeDistance(Cognex.VisionPro3D.Cog3DVect3)">
  3153. <inheritdoc />
  3154. </member>
  3155. <member name="M:Cognex.VisionPro3D.Cog3DAlignedBox.ComputeNearestPoint(Cognex.VisionPro3D.Cog3DVect3)">
  3156. <inheritdoc />
  3157. </member>
  3158. <member name="P:Cognex.VisionPro3D.Cog3DAlignedBox.IsEmpty">
  3159. <inheritdoc />
  3160. </member>
  3161. <member name="P:Cognex.VisionPro3D.Cog3DAlignedBox.IsFinite">
  3162. <inheritdoc />
  3163. </member>
  3164. <member name="M:Cognex.VisionPro3D.Cog3DAlignedBox.Clone">
  3165. <inheritdoc />
  3166. </member>
  3167. <member name="M:Cognex.VisionPro3D.Cog3DAlignedBox.Finalize">
  3168. <inheritdoc cref="M:Cognex.VisionPro3D.ICog3DBase.FinalizerForThisClass" />
  3169. </member>
  3170. <member name="M:Cognex.VisionPro3D.Cog3DAlignedBox.Dispose">
  3171. <inheritdoc cref="M:Cognex.VisionPro3D.ICog3DBase.DestructorForThisClass" />
  3172. </member>
  3173. <member name="M:Cognex.VisionPro3D.Cog3DAlignedBox.#ctor(Cognex.VisionPro3D.Cog3DVect3,Cognex.VisionPro3D.Cog3DVect3,Cognex.VisionPro3D.Cog3DShapeStateConstants)">
  3174. <summary>
  3175. Constructs an aligned box using 2 vertices: the origin vertex and the opposite vertex.
  3176. After construction, the translation vector for this shape corresponds to the vertex
  3177. with the most negative X, Y, and Z coordinates.
  3178. </summary>
  3179. <param name="originVertex">
  3180. The first vertex used for defining this shape.
  3181. </param>
  3182. <param name="oppositeVertex">
  3183. The second vertex used for defining this shape.
  3184. </param>
  3185. <param name="shapeState">
  3186. The state of this aligned box. Must be Cog3DShapeStateConstants.Vertex, Cog3DShapeStateConstants.Curve,
  3187. Cog3DShapeStateConstants.Surface, or Cog3DShapeStateConstants.Volume.
  3188. </param>
  3189. <exception cref="T:System.ArgumentException">
  3190. If <paramref name="shapeState" /> is not one of Cog3DShapeStateConstants.Vertex, .Curve, .Surface, and .Volume.
  3191. </exception>
  3192. </member>
  3193. <member name="M:Cognex.VisionPro3D.Cog3DAlignedBox.#ctor(Cognex.VisionPro3D.Cog3DVect3,System.Double,System.Double,System.Double,Cognex.VisionPro3D.Cog3DShapeStateConstants)">
  3194. <summary>
  3195. Constructs an aligned box using the specified size, translation, and Cog3DShapeStateConstants.
  3196. </summary>
  3197. <param name="size">
  3198. The X, Y, and Z extents of this aligned box. X, Y, and Z must be &gt; 0.
  3199. </param>
  3200. <param name="translationX">
  3201. The X translation of this aligned box.
  3202. </param>
  3203. <param name="translationY">
  3204. The Y translation of this aligned box.
  3205. </param>
  3206. <param name="translationZ">
  3207. The Z translation of this aligned box.
  3208. </param>
  3209. <param name="shapeState">
  3210. The state of this aligned box. Must be Cog3DShapeStateConstants.Vertex, Cog3DShapeStateConstants.Curve,
  3211. Cog3DShapeStateConstants.Surface, or Cog3DShapeStateConstants.Volume.
  3212. </param>
  3213. <exception cref="T:System.ArgumentException">
  3214. If any member of <paramref name="size" /> is less than 0.
  3215. </exception>
  3216. <exception cref="T:System.ArgumentException">
  3217. If <paramref name="shapeState" /> is not one of Cog3DShapeStateConstants.Vertex, .Curve, .Surface, and .Volume.
  3218. </exception>
  3219. </member>
  3220. <member name="M:Cognex.VisionPro3D.Cog3DAlignedBox.#ctor(Cognex.VisionPro3D.Cog3DAlignedBox)">
  3221. <inheritdoc cref="M:Cognex.VisionPro3D.ICog3DBase.DeepCopyConstructorForThisClass(System.Object)" />
  3222. </member>
  3223. <member name="M:Cognex.VisionPro3D.Cog3DAlignedBox.#ctor">
  3224. <summary>
  3225. Constructs a degenerate, aligned box with size of (0,0,0), translation of (0,0,0), and Cog3DShapeStateConstants of Volume.
  3226. </summary>
  3227. </member>
  3228. <member name="T:Cognex.VisionPro3D.Cog3DAlignedBox">
  3229. <summary>
  3230. This class encapsulates an axis-aligned (edges are parallel to the coordinate
  3231. axes) 3D box. An aligned box is parameterized by a size vector and a translation
  3232. vector. The size vector specifies the extents of the aligned box. The translation
  3233. vector moves the box from the coordinate space origin to its pose in 3D space.
  3234. </summary>
  3235. </member>
  3236. <member name="M:Cognex.VisionPro3D.Cog3DBox.GetObjectData(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
  3237. <inheritdoc cref="M:Cognex.VisionPro3D.ICog3DBase.GetObjectData(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)" />
  3238. </member>
  3239. <member name="M:Cognex.VisionPro3D.Cog3DBox.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
  3240. <inheritdoc cref="M:Cognex.VisionPro3D.ICog3DBase.SerializationConstructor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)" />
  3241. </member>
  3242. <member name="M:Cognex.VisionPro3D.Cog3DBox.RealEqual(Cognex.VisionPro3D.Cog3DBox,Cognex.VisionPro3D.Cog3DBox,System.Double)">
  3243. <inheritdoc cref="M:Cognex.VisionPro3D.ICog3DBase.RealEqual(System.Object,System.Object,System.Double)" />
  3244. </member>
  3245. <member name="M:Cognex.VisionPro3D.Cog3DBox.ToString">
  3246. <inheritdoc cref="M:Cognex.VisionPro3D.ICog3DBase.ToString" />
  3247. </member>
  3248. <member name="M:Cognex.VisionPro3D.Cog3DBox.SetOriginVertexXVectorYVectorZ(Cognex.VisionPro3D.Cog3DVect3,Cognex.VisionPro3D.Cog3DVect3,Cognex.VisionPro3D.Cog3DVect3,System.Double)">
  3249. <summary>
  3250. Set the box's origin vertex, extent X vector, extent Y vector, and Z height.
  3251. </summary>
  3252. <param name="originVertex">
  3253. The origin vertex of the box.
  3254. </param>
  3255. <param name="xVector">
  3256. The extent X vector of the box.
  3257. Note that this vector corresponds to the Size.X extent in ScaledUnitBox space.
  3258. See the Remarks section.
  3259. </param>
  3260. <param name="yVector">
  3261. The extent Y vector of the box.
  3262. Note that this vector corresponds to the Size.Y extent in ScaledUnitBox space.
  3263. See the Remarks section.
  3264. </param>
  3265. <param name="z">
  3266. The Z height of the box.
  3267. Note that this vector corresponds to the Size.Z extent in ScaledUnitBox space.
  3268. See the Remarks section.
  3269. </param>
  3270. <exception cref="T:System.ArgumentException">
  3271. If <paramref name="xVector" /> or <paramref name="yVector" /> is (0,0,0), or
  3272. <paramref name="xVector" /> and <paramref name="yVector" /> are parallel.
  3273. </exception>
  3274. <remarks>
  3275. Notes:
  3276. <list type="bullet"><item> If <paramref name="yVector" /> is not perpendicular to
  3277. <paramref name="xVector" />
  3278. internally a new yVector is generated as follows and used instead:
  3279. <list type="bullet"><item>Create a plane with normal direction of
  3280. <paramref name="xVector" />; </item><item> Project <paramref name="yVector" /> to this plane, and get the
  3281. projected vector yVectorInternal;</item><item> Scale yVectorInternal to have the same length as
  3282. <paramref name="yVector" />. </item></list>
  3283. Otherwise, yVectorInternal = <paramref name="yVector" />. </item><item> Size.X will be <paramref name="xVector" />.Length, and Size.Y will be
  3284. <paramref name="yVector" />.Length, and Size.Z will be <paramref name="z" />. </item><item> The implicit extent Z vector's direction is decided by the cross
  3285. product of <paramref name="xVector" /> and yVectorInternal. </item><item> Assume that the extent Z vector is named as zVectorInternal,
  3286. then the center of the box will be:
  3287. <paramref name="originVertex" /> +
  3288. (<paramref name="xVector" /> + yVectorInternal +
  3289. zVectorInternal * <paramref name="z" />/zVectorInternal.Length)/2
  3290. </item></list></remarks>
  3291. <event cref="E:Cognex.VisionPro.ICogChangedEvent.Changed">
  3292. <para>Fires when some properties change.</para>
  3293. <para>The following state flags may be affected:</para>
  3294. <list type="bullet">
  3295. <item> SfGetShapeFromScaledUnitBox </item>
  3296. <item> SfCenter </item>
  3297. <item> SfSize </item>
  3298. <item> SfGetSurfaces </item>
  3299. <item> SfGetLineSegments </item>
  3300. <item> SfGetVertices </item>
  3301. <item> SfGetOriginVertexXVectorYVectorZ </item>
  3302. <item> SfComputeBoundingBox </item>
  3303. <item> SfComputePerimeter </item>
  3304. <item> SfComputeArea </item>
  3305. <item> SfComputeVolume </item>
  3306. <item> SfIsDegenerateCurve </item>
  3307. <item> SfIsDegenerateSurface </item>
  3308. <item> SfIsDegenerateVolume </item>
  3309. </list>
  3310. </event>
  3311. </member>
  3312. <member name="M:Cognex.VisionPro3D.Cog3DBox.GetOriginVertexXVectorYVectorZ(Cognex.VisionPro3D.Cog3DVect3@,Cognex.VisionPro3D.Cog3DVect3@,Cognex.VisionPro3D.Cog3DVect3@,System.Double@)">
  3313. <summary>
  3314. Get the box's origin vertex, extent X vector, extent Y vector, and Z height.
  3315. </summary>
  3316. <param name="originVertex">
  3317. The output argument for the origin vertex of the box.
  3318. </param>
  3319. <param name="xVector">
  3320. The output argument for the extent X vector of the box.
  3321. Note that this vector corresponds to the Size.X extent in ScaledUnitBox space.
  3322. See the Remarks section.
  3323. </param>
  3324. <param name="yVector">
  3325. The output argument for the extent Y vector of the box.
  3326. Note that this vector corresponds to the Size.Y extent in ScaledUnitBox space.
  3327. See the Remarks section.
  3328. </param>
  3329. <param name="z">
  3330. The output argument for the Z height of the box.
  3331. Note that Z height corresponds to the Size.Z extent in ScaledUnitBox space.
  3332. See the Remarks section.
  3333. </param>
  3334. <exception cref="T:Cognex.VisionPro3D.Cog3DException">
  3335. If the box is degenerate.
  3336. </exception>
  3337. <remarks>
  3338. <para>
  3339. <paramref name="z" /> will be Size.Z. </para>
  3340. <para> ShapeFromScaledUnitBox will map point cc3Dvect(0,0,0) to
  3341. <paramref name="originVertex" />,
  3342. map vector (Size.X,0,0) to
  3343. (<paramref name="originVertex" /> + <paramref name="xVector" />),
  3344. and map vector cc3DVect(0,Size.Y,0) to
  3345. (<paramref name="originVertex" /> + <paramref name="yVector" />).
  3346. </para>
  3347. </remarks>
  3348. </member>
  3349. <member name="M:Cognex.VisionPro3D.Cog3DBox.GetSurfaces">
  3350. <summary>
  3351. Computes the surfaces of this box.
  3352. </summary>
  3353. <returns>
  3354. The list of surfaces of this box.
  3355. </returns>
  3356. <remarks>
  3357. Notes:
  3358. <list type="bullet"><item> Assuming a unit box, the order of the returned rectangles is
  3359. (using a pair of opposite vertices to describe each rectangle):
  3360. <list type="bullet"><item> 0 Cog3DVect3(0,0,0), Cog3DVect3(1,1,0) </item><item> 1 Cog3DVect3(0,0,1), Cog3DVect3(1,1,1) </item><item> 2 Cog3DVect3(0,0,0), Cog3DVect3(1,0,1) </item><item> 3 Cog3DVect3(1,0,0), Cog3DVect3(1,1,1) </item><item> 4 Cog3DVect3(0,1,0), Cog3DVect3(1,1,1) </item><item> 5 Cog3DVect3(0,0,0), Cog3DVect3(0,1,1) </item></list></item><item> Each element of the returned list has the
  3361. ShapeState value of Cog3DShapeStateConstants.Surface no matter the current ShapeState
  3362. value of the box. </item><item> Some elements of the returned list might be degenerate rectangles
  3363. and some elements might be duplicate if this box is
  3364. degenerate. </item></list></remarks>
  3365. </member>
  3366. <member name="M:Cognex.VisionPro3D.Cog3DBox.GetLineSegments">
  3367. <summary>
  3368. Computes the line segments for the edges of this box.
  3369. </summary>
  3370. <returns>
  3371. The list of line segments for the edges of this box.
  3372. </returns>
  3373. <remarks>
  3374. Notes:
  3375. <list type="bullet"><item> Assuming a unit box, the order of the returned line segments is:
  3376. <list type="bullet"><item> 0 Cog3DLineSeg(Cog3DVect3(0,0,0), Cog3DVect3(1,0,0), Cog3DShapeStateConstants.Curve) </item><item> 1 Cog3DLineSeg(Cog3DVect3(1,0,0), Cog3DVect3(1,1,0), Cog3DShapeStateConstants.Curve) </item><item> 2 Cog3DLineSeg(Cog3DVect3(1,1,0), Cog3DVect3(0,1,0), Cog3DShapeStateConstants.Curve) </item><item> 3 Cog3DLineSeg(Cog3DVect3(0,1,0), Cog3DVect3(0,0,0), Cog3DShapeStateConstants.Curve) </item><item> 4 Cog3DLineSeg(Cog3DVect3(0,0,1), Cog3DVect3(1,0,1), Cog3DShapeStateConstants.Curve) </item><item> 5 Cog3DLineSeg(Cog3DVect3(1,0,1), Cog3DVect3(1,1,1), Cog3DShapeStateConstants.Curve) </item><item> 6 Cog3DLineSeg(Cog3DVect3(1,1,1), Cog3DVect3(0,1,1), Cog3DShapeStateConstants.Curve) </item><item> 7 Cog3DLineSeg(Cog3DVect3(0,1,1), Cog3DVect3(0,0,1), Cog3DShapeStateConstants.Curve) </item><item> 8 Cog3DLineSeg(Cog3DVect3(0,0,0), Cog3DVect3(0,0,1), Cog3DShapeStateConstants.Curve) </item><item> 9 Cog3DLineSeg(Cog3DVect3(1,0,0), Cog3DVect3(1,0,1), Cog3DShapeStateConstants.Curve) </item><item> 10 Cog3DLineSeg(Cog3DVect3(1,1,0), Cog3DVect3(1,1,1), Cog3DShapeStateConstants.Curve) </item><item> 11 Cog3DLineSeg(Cog3DVect3(0,1,0), Cog3DVect3(0,1,1), Cog3DShapeStateConstants.Curve) </item></list></item><item> Each element of the returned list has the
  3377. ShapeState value of Cog3DShapeStateConstants.Curve no matter the current ShapeState
  3378. value of the box. </item><item> Some elements of the returned list might be degenerate line
  3379. segments and some elements might be duplicate if this box is
  3380. degenerate. </item></list></remarks>
  3381. </member>
  3382. <member name="M:Cognex.VisionPro3D.Cog3DBox.GetVertices">
  3383. <summary>
  3384. Computes the set of vertices defining this box. Assuming a
  3385. unit box, the order of the returned vertices is: (0,0,0) (1,0,0)
  3386. (1,1,0) (0,1,0) (0,0,1) (1,0,1) (1,1,1), (0,1,1).
  3387. </summary>
  3388. <returns>
  3389. The set of vertices defining this box.
  3390. </returns>
  3391. </member>
  3392. <member name="M:Cognex.VisionPro3D.Cog3DBox.MapRigid(Cognex.VisionPro3D.Cog3DTransformRigid)">
  3393. <summary>
  3394. Maps this box through the specified rigid transform and
  3395. returns a new Cog3DBox.
  3396. </summary>
  3397. <param name="newFromOld">
  3398. The rigid transform to use when mapping this box.
  3399. </param>
  3400. <returns>
  3401. The Cog3DBox resulting from mapping this shape through the specified rigid transform.
  3402. </returns>
  3403. <exception cref="T:System.ArgumentNullException">
  3404. If <paramref name="newFromOld" /> is null.
  3405. </exception>
  3406. </member>
  3407. <member name="M:Cognex.VisionPro3D.Cog3DBox.SetShapeFromScaledUnitBox(Cognex.VisionPro3D.Cog3DTransformRigid)">
  3408. <summary>
  3409. Set the ShapeFromScaledUnitBox transform of this box.
  3410. It may change the
  3411. value of Center. It does not change the value of Size.
  3412. </summary>
  3413. <param name="shapeFromScaledUnitBox">
  3414. A Cog3DTransformRigid used to specify the ShapeFromScaledUnitBox
  3415. transform of this box. This transform
  3416. specifies the pose of the ScaledUnitBox in 3D space.
  3417. </param>
  3418. <exception cref="T:System.ArgumentNullException">
  3419. If <paramref name="shapeFromScaledUnitBox" /> is null.
  3420. </exception>
  3421. <event cref="E:Cognex.VisionPro.ICogChangedEvent.Changed">
  3422. <para>Fires when some properties change.</para>
  3423. <para>The following state flags may be affected:</para>
  3424. <list type="bullet">
  3425. <item> SfGetShapeFromScaledUnitBox </item>
  3426. <item> SfCenter </item>
  3427. <item> SfGetSurfaces </item>
  3428. <item> SfGetLineSegments </item>
  3429. <item> SfGetVertices </item>
  3430. <item> SfGetOriginVertexXVectorYVectorZ </item>
  3431. <item> SfComputeBoundingBox </item>
  3432. </list>
  3433. </event>
  3434. </member>
  3435. <member name="M:Cognex.VisionPro3D.Cog3DBox.GetShapeFromScaledUnitBox">
  3436. <summary>
  3437. Get the ShapeFromScaledUnitBox transform of this box.
  3438. </summary>
  3439. <returns>
  3440. The ShapeFromScaledUnitBox transform of this box. This transform
  3441. specifies the pose of the ScaledUnitBox in 3D space.
  3442. </returns>
  3443. </member>
  3444. <member name="P:Cognex.VisionPro3D.Cog3DBox.ShapeFromScaledUnitBox">
  3445. <summary>
  3446. Deprecated. Please use GetShapeFromScaledUnitBox() and
  3447. SetShapeFromScaledUnitBox()instead.
  3448. </summary>
  3449. </member>
  3450. <member name="P:Cognex.VisionPro3D.Cog3DBox.Center">
  3451. <summary>
  3452. Gets the center position of this box.
  3453. </summary>
  3454. <value>
  3455. The center point of this box.
  3456. </value>
  3457. </member>
  3458. <member name="P:Cognex.VisionPro3D.Cog3DBox.Size">
  3459. <summary>
  3460. Gets/sets the size of this box. The setter may change the
  3461. value of Center. It does not change the value of ShapeFromScaledUnitBox.
  3462. </summary>
  3463. <value>
  3464. The size of this box.
  3465. </value>
  3466. <exception cref="T:System.ArgumentException">
  3467. If any member of <paramref name="size" /> is less than 0.
  3468. </exception>
  3469. <event cref="E:Cognex.VisionPro.ICogChangedEvent.Changed">
  3470. <para>Fires when this property changes.</para>
  3471. <para>The following state flags may be affected:</para>
  3472. <list type="bullet">
  3473. <item> SfSize </item>
  3474. <item> SfCenter </item>
  3475. <item> SfGetSurfaces </item>
  3476. <item> SfGetLineSegments </item>
  3477. <item> SfGetVertices </item>
  3478. <item> SfComputePerimeter </item>
  3479. <item> SfComputeArea </item>
  3480. <item> SfComputeVolume </item>
  3481. <item> SfGetOriginVertexXVectorYVectorZ </item>
  3482. <item> SfComputeBoundingBox </item>
  3483. <item> SfIsDegenerateCurve </item>
  3484. <item> SfIsDegenerateSurface </item>
  3485. <item> SfIsDegenerateVolume </item>
  3486. </list>
  3487. </event>
  3488. </member>
  3489. <member name="P:Cognex.VisionPro3D.Cog3DBox.ShapeState">
  3490. <summary>
  3491. Gets/sets the ShapeState for this shape.
  3492. </summary>
  3493. <value>
  3494. The ShapeState of this Shape. Must be Cog3DShapeStateConstants.Vertex, .Curve, .Surface, or .Volume.
  3495. </value>
  3496. <exception cref="T:System.ArgumentException">
  3497. The ShapeState for this shape must be Cog3DShapeStateConstants.Vertex, .Curve, .Surface, or .Volume.
  3498. </exception>
  3499. <event cref="E:Cognex.VisionPro.ICogChangedEvent.Changed">
  3500. <para>Fires when this property changes.</para>
  3501. <para>The following state flags may be affected:</para>
  3502. <list type="bullet">
  3503. <item> SfShapeState </item>
  3504. </list>
  3505. </event>
  3506. </member>
  3507. <member name="M:Cognex.VisionPro3D.Cog3DBox.ComputeDistanceVolume(Cognex.VisionPro3D.Cog3DVect3)">
  3508. <inheritdoc />
  3509. </member>
  3510. <member name="M:Cognex.VisionPro3D.Cog3DBox.ComputeNearestPointVolume(Cognex.VisionPro3D.Cog3DVect3)">
  3511. <inheritdoc />
  3512. </member>
  3513. <member name="P:Cognex.VisionPro3D.Cog3DBox.IsDegenerateVolume">
  3514. <inheritdoc />
  3515. </member>
  3516. <member name="M:Cognex.VisionPro3D.Cog3DBox.ComputeVolume">
  3517. <inheritdoc />
  3518. </member>
  3519. <member name="M:Cognex.VisionPro3D.Cog3DBox.ComputeDistanceSurface(Cognex.VisionPro3D.Cog3DVect3)">
  3520. <inheritdoc />
  3521. </member>
  3522. <member name="M:Cognex.VisionPro3D.Cog3DBox.ComputeNearestPointSurface(Cognex.VisionPro3D.Cog3DVect3)">
  3523. <inheritdoc />
  3524. </member>
  3525. <member name="P:Cognex.VisionPro3D.Cog3DBox.IsDegenerateSurface">
  3526. <inheritdoc />
  3527. </member>
  3528. <member name="M:Cognex.VisionPro3D.Cog3DBox.ComputeArea">
  3529. <inheritdoc />
  3530. </member>
  3531. <member name="M:Cognex.VisionPro3D.Cog3DBox.ComputeDistanceCurve(Cognex.VisionPro3D.Cog3DVect3)">
  3532. <inheritdoc />
  3533. </member>
  3534. <member name="M:Cognex.VisionPro3D.Cog3DBox.ComputeNearestPointCurve(Cognex.VisionPro3D.Cog3DVect3)">
  3535. <inheritdoc />
  3536. </member>
  3537. <member name="P:Cognex.VisionPro3D.Cog3DBox.IsDegenerateCurve">
  3538. <inheritdoc />
  3539. </member>
  3540. <member name="M:Cognex.VisionPro3D.Cog3DBox.ComputePerimeter">
  3541. <inheritdoc />
  3542. </member>
  3543. <member name="M:Cognex.VisionPro3D.Cog3DBox.ComputeDistanceVertex(Cognex.VisionPro3D.Cog3DVect3)">
  3544. <inheritdoc />
  3545. </member>
  3546. <member name="M:Cognex.VisionPro3D.Cog3DBox.ComputeNearestPointVertex(Cognex.VisionPro3D.Cog3DVect3)">
  3547. <inheritdoc />
  3548. </member>
  3549. <member name="M:Cognex.VisionPro3D.Cog3DBox.MapShape(Cognex.VisionPro3D.ICog3DTransform)">
  3550. <inheritdoc />
  3551. </member>
  3552. <member name="M:Cognex.VisionPro3D.Cog3DBox.ComputeBoundingBox">
  3553. <inheritdoc />
  3554. </member>
  3555. <member name="P:Cognex.VisionPro3D.Cog3DBox.SelectedSpaceName3D">
  3556. <inheritdoc />
  3557. </member>
  3558. <member name="M:Cognex.VisionPro3D.Cog3DBox.ComputeDistance(Cognex.VisionPro3D.Cog3DVect3)">
  3559. <inheritdoc />
  3560. </member>
  3561. <member name="M:Cognex.VisionPro3D.Cog3DBox.ComputeNearestPoint(Cognex.VisionPro3D.Cog3DVect3)">
  3562. <inheritdoc />
  3563. </member>
  3564. <member name="P:Cognex.VisionPro3D.Cog3DBox.IsEmpty">
  3565. <inheritdoc />
  3566. </member>
  3567. <member name="P:Cognex.VisionPro3D.Cog3DBox.IsFinite">
  3568. <inheritdoc />
  3569. </member>
  3570. <member name="M:Cognex.VisionPro3D.Cog3DBox.Clone">
  3571. <inheritdoc />
  3572. </member>
  3573. <member name="M:Cognex.VisionPro3D.Cog3DBox.Finalize">
  3574. <inheritdoc cref="M:Cognex.VisionPro3D.ICog3DBase.FinalizerForThisClass" />
  3575. </member>
  3576. <member name="M:Cognex.VisionPro3D.Cog3DBox.Dispose">
  3577. <inheritdoc cref="M:Cognex.VisionPro3D.ICog3DBase.DestructorForThisClass" />
  3578. </member>
  3579. <member name="M:Cognex.VisionPro3D.Cog3DBox.#ctor(Cognex.VisionPro3D.Cog3DBox)">
  3580. <inheritdoc cref="M:Cognex.VisionPro3D.ICog3DBase.DeepCopyConstructorForThisClass(System.Object)" />
  3581. </member>
  3582. <member name="M:Cognex.VisionPro3D.Cog3DBox.#ctor(Cognex.VisionPro3D.Cog3DVect3,Cognex.VisionPro3D.Cog3DTransformRigid,Cognex.VisionPro3D.Cog3DShapeStateConstants)">
  3583. <summary>
  3584. Constructs a box using the specified size, rigid transform, and Cog3DShapeStateConstants.
  3585. </summary>
  3586. <param name="size">
  3587. The X, Y, and Z extents of this aligned box. X, Y, and Z must be &gt; 0.
  3588. </param>
  3589. <param name="shapeFromScaledUnitBox">
  3590. The rigid transform that maps the ScaledUnitBox to a pose in 3D space.
  3591. </param>
  3592. <param name="shapeState">
  3593. The state of this box. Must be Cog3DShapeStateConstants.Vertex, .Curve, .Surface,
  3594. or .Volume.
  3595. </param>
  3596. <exception cref="T:System.ArgumentException">
  3597. If any member of <paramref name="size" /> is less than 0.
  3598. </exception>
  3599. <exception cref="T:System.ArgumentNullException">
  3600. If <paramref name="shapeFromScaledUnitBox" /> is null.
  3601. </exception>
  3602. <exception cref="T:System.ArgumentException">
  3603. The ShapeState for this shape must be Cog3DShapeStateConstants.Vertex, .Curve, .Surface, or .Volume.
  3604. </exception>
  3605. </member>
  3606. <member name="M:Cognex.VisionPro3D.Cog3DBox.#ctor">
  3607. <summary>
  3608. Constructs a degenerate box with size of (0,0,0), translation of (0,0,0),
  3609. ShapeFromScaledUnitBox of identity transform,
  3610. and Cog3DShapeStateConstants of Volume.
  3611. </summary>
  3612. </member>
  3613. <member name="T:Cognex.VisionPro3D.Cog3DBox">
  3614. <summary>
  3615. This class encapsulates an oriented 3D box.
  3616. A Cog3DBox is defined by a size vector and a 3D rigid transform. The size vector
  3617. defines an axis-aligned box which has the following pair of opposite
  3618. vertices: cc3DVect(0,0,0) and size(). This is referred to as the "ScaledUnitBox".
  3619. The rigid transform (ShapeFromScaledUnitBox)
  3620. maps the ScaledUnitBox to the desired pose in 3D space.
  3621. </summary>
  3622. </member>
  3623. <member name="M:Cognex.VisionPro3D.Cog3DRectangle.GetObjectData(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
  3624. <inheritdoc cref="M:Cognex.VisionPro3D.ICog3DBase.GetObjectData(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)" />
  3625. </member>
  3626. <member name="M:Cognex.VisionPro3D.Cog3DRectangle.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
  3627. <inheritdoc cref="M:Cognex.VisionPro3D.ICog3DBase.SerializationConstructor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)" />
  3628. </member>
  3629. <member name="M:Cognex.VisionPro3D.Cog3DRectangle.RealEqual(Cognex.VisionPro3D.Cog3DRectangle,Cognex.VisionPro3D.Cog3DRectangle,System.Double)">
  3630. <inheritdoc cref="M:Cognex.VisionPro3D.ICog3DBase.RealEqual(System.Object,System.Object,System.Double)" />
  3631. </member>
  3632. <member name="M:Cognex.VisionPro3D.Cog3DRectangle.ToString">
  3633. <inheritdoc cref="M:Cognex.VisionPro3D.ICog3DBase.ToString" />
  3634. </member>
  3635. <member name="M:Cognex.VisionPro3D.Cog3DRectangle.SetOriginVertexXVectorYVector(Cognex.VisionPro3D.Cog3DVect3,Cognex.VisionPro3D.Cog3DVect3,Cognex.VisionPro3D.Cog3DVect3)">
  3636. <summary>
  3637. Sets the rectangle's origin vertex, extent X vector and extent Y vector.
  3638. </summary>
  3639. <param name="originVertex">
  3640. The origin vertex of the rectangle.
  3641. </param>
  3642. <param name="xVector">
  3643. The extent X vector of the rectangle.
  3644. </param>
  3645. <param name="yVector">
  3646. The extent Y vector of the rectangle.
  3647. </param>
  3648. <exception cref="T:System.ArgumentException">
  3649. If <paramref name="xVector" /> or <paramref name="yVector" />
  3650. is (0,0,0), or <paramref name="xVector" /> and
  3651. <paramref name="yVector" /> are parallel.
  3652. </exception>
  3653. <remarks>
  3654. Notes:
  3655. <list type="bullet"><item> If <paramref name="yVector" /> is not perpendicular to
  3656. <paramref name="xVector" />
  3657. internally a new yVector is generated as follows and used instead:
  3658. <list type="bullet"><item>Create a plane with normal direction of
  3659. <paramref name="xVector" />; </item><item> Project <paramref name="yVector" /> to this plane, and get the
  3660. projected vector yVectorInternal;</item><item> Scale yVectorInternal to have the same length as
  3661. <paramref name="yVector" />. </item></list>
  3662. Otherwise, yVectorInternal = <paramref name="yVector" />. </item><item> Size.X will be <paramref name="xVector" />.Length, and
  3663. Size().Y will be <paramref name="yVector" />.Length. </item><item> Center will be <paramref name="originVertex" /> +
  3664. (<paramref name="xVector" /> + yVectorInternal)/2
  3665. </item></list></remarks>
  3666. <event cref="E:Cognex.VisionPro.ICogChangedEvent.Changed">
  3667. <para>Fires when some properties change.</para>
  3668. <para>The following state flags may be affected:</para>
  3669. <list type="bullet">
  3670. <item> SfGetShapeFromScaledUnitRectangle </item>
  3671. <item> SfCenter </item>
  3672. <item> SfSize </item>
  3673. <item> SfGetLineSegments </item>
  3674. <item> SfGetVertices </item>
  3675. <item> SfGetOriginVertexXVectorYVector </item>
  3676. <item> SfComputeBoundingBox </item>
  3677. <item> SfComputePerimeter </item>
  3678. <item> SfComputeArea </item>
  3679. <item> SfIsDegenerateCurve </item>
  3680. <item> SfIsDegenerateSurface </item>
  3681. </list>
  3682. </event>
  3683. </member>
  3684. <member name="M:Cognex.VisionPro3D.Cog3DRectangle.GetOriginVertexXVectorYVector(Cognex.VisionPro3D.Cog3DVect3@,Cognex.VisionPro3D.Cog3DVect3@,Cognex.VisionPro3D.Cog3DVect3@)">
  3685. <summary>
  3686. Gets the rectangle's origin vertex, extent X vector and extent Y vector.
  3687. </summary>
  3688. <param name="originVertex">
  3689. The output argument keeping the origin vertex of the rectangle.
  3690. </param>
  3691. <param name="xVector">
  3692. The output argument keeping the extent X vector of the rectangle.
  3693. </param>
  3694. <param name="yVector">
  3695. The output argument keeping the extent Y vector of the rectangle.
  3696. </param>
  3697. <exception cref="T:Cognex.VisionPro3D.Cog3DException">
  3698. If the rectangle is degenerate.
  3699. </exception>
  3700. <remarks>
  3701. ShapeFromScaledUnitRectangle will map point cc3Dvect(0,0,0) to
  3702. <paramref name="originVertex" />, map vector (Size.X,0,0) to
  3703. (<paramref name="originVertex" /> + <paramref name="xVector" /> ),
  3704. and map vector cc3DVect(0,Size.Y,0) to
  3705. (<paramref name="originVertex" /> + <paramref name="yVector" /> ).
  3706. </remarks>
  3707. </member>
  3708. <member name="M:Cognex.VisionPro3D.Cog3DRectangle.GetLineSegments">
  3709. <summary>
  3710. Computes the line segments for the edges of this rectangle.
  3711. </summary>
  3712. <returns>
  3713. The list of line segments for the edges of this rectangle.
  3714. </returns>
  3715. <remarks>
  3716. Notes:
  3717. <list type="bullet"><item> Assuming a unit rectangle, the order of the returned line segments is:
  3718. <list type="bullet"><item> 0 Cog3DLineSeg(Cog3DVect3(0,0,0), Cog3DVect3(1,0,0), Cog3DShapeStateConstants.Curve) </item><item> 1 Cog3DLineSeg(Cog3DVect3(1,0,0), Cog3DVect3(1,1,0), Cog3DShapeStateConstants.Curve) </item><item> 2 Cog3DLineSeg(Cog3DVect3(1,1,0), Cog3DVect3(0,1,0), Cog3DShapeStateConstants.Curve) </item><item> 3 Cog3DLineSeg(Cog3DVect3(0,1,0), Cog3DVect3(0,0,0), Cog3DShapeStateConstants.Curve) </item></list></item><item> Each element of the returned list has the
  3719. ShapeState value of Cog3DShapeStateConstants.Curve no matter the current ShapeState
  3720. value of the rectangle. </item><item> Some elements of the returned list might be degenerate line
  3721. segments and some elements might be duplicate if this rectangle is
  3722. degenerate. </item></list></remarks>
  3723. </member>
  3724. <member name="M:Cognex.VisionPro3D.Cog3DRectangle.GetVertices">
  3725. <summary>
  3726. Computes the set of vertices defining this rectangle. Assuming a
  3727. unit rectangle, the order of the returned vertices is: (0,0,0) (1,0,0)
  3728. (1,1,0) (0,1,0).
  3729. </summary>
  3730. <returns>
  3731. The set of vertices defining this rectangle.
  3732. </returns>
  3733. </member>
  3734. <member name="M:Cognex.VisionPro3D.Cog3DRectangle.MapRigid(Cognex.VisionPro3D.Cog3DTransformRigid)">
  3735. <summary>
  3736. Maps this rectangle through the specified rigid transform and
  3737. returns a new Cog3DRectangle.
  3738. </summary>
  3739. <param name="newFromOld">
  3740. The rigid transform to use when mapping this rectangle.
  3741. </param>
  3742. <returns>
  3743. The Cog3DRectangle resulting from mapping this shape through the specified rigid transform.
  3744. </returns>
  3745. <exception cref="T:System.ArgumentNullException">
  3746. If <paramref name="newFromOld" /> is null.
  3747. </exception>
  3748. </member>
  3749. <member name="M:Cognex.VisionPro3D.Cog3DRectangle.SetShapeFromScaledUnitRectangle(Cognex.VisionPro3D.Cog3DTransformRigid)">
  3750. <summary>
  3751. Set the ShapeFromScaledUnitRectangle transform of this rectangle.
  3752. It may change the
  3753. value of Center. It does not change the value of Size.
  3754. </summary>
  3755. <param name="shapeFromScaledUnitRectangle">
  3756. A Cog3DTransformRigid used to specify the ShapeFromScaledUnitRectangle
  3757. transform of this rectangle. This transform
  3758. specifies the pose of the ScaledUnitRectangle in 3D space.
  3759. </param>
  3760. <exception cref="T:System.ArgumentNullException">
  3761. If <paramref name="shapeFromScaledUnitRectangle" /> is null.
  3762. </exception>
  3763. <event cref="E:Cognex.VisionPro.ICogChangedEvent.Changed">
  3764. <para>Fires when some properties change.</para>
  3765. <para>The following state flags may be affected:</para>
  3766. <list type="bullet">
  3767. <item> SfGetShapeFromScaledUnitRectangle </item>
  3768. <item> SfCenter </item>
  3769. <item> SfGetLineSegments </item>
  3770. <item> SfGetVertices </item>
  3771. <item> SfGetOriginVertexXVectorYVector </item>
  3772. <item> SfComputeBoundingBox </item>
  3773. </list>
  3774. </event>
  3775. </member>
  3776. <member name="M:Cognex.VisionPro3D.Cog3DRectangle.GetShapeFromScaledUnitRectangle">
  3777. <summary>
  3778. Get the ShapeFromScaledUnitRectangle transform of this rectangle.
  3779. </summary>
  3780. <returns>
  3781. The ShapeFromScaledUnitRectangle transform of this rectangle. This transform
  3782. specifies the pose of the ScaledUnitRectangle in 3D space.
  3783. </returns>
  3784. </member>
  3785. <member name="P:Cognex.VisionPro3D.Cog3DRectangle.ShapeFromScaledUnitRectangle">
  3786. <summary>
  3787. Deprecated. Please use GetShapeFromScaledUnitRectangle() and
  3788. SetShapeFromScaledUnitRectangle()instead.
  3789. </summary>
  3790. </member>
  3791. <member name="P:Cognex.VisionPro3D.Cog3DRectangle.Center">
  3792. <summary>
  3793. Gets the center position of this rectangle.
  3794. </summary>
  3795. <value>
  3796. The center point of this rectangle.
  3797. </value>
  3798. </member>
  3799. <member name="P:Cognex.VisionPro3D.Cog3DRectangle.Size">
  3800. <summary>
  3801. Gets/sets the size of this rectangle. The setter may change the
  3802. value of Center. It does not change the value of ShapeFromScaledUnitRectangle.
  3803. </summary>
  3804. <value>
  3805. The size of this rectangle.
  3806. </value>
  3807. <exception cref="T:System.ArgumentException">
  3808. If any member of <paramref name="size" /> is less than 0.
  3809. </exception>
  3810. <event cref="E:Cognex.VisionPro.ICogChangedEvent.Changed">
  3811. <para>Fires when this property changes.</para>
  3812. <para>The following state flags may be affected:</para>
  3813. <list type="bullet">
  3814. <item> SfSize </item>
  3815. <item> SfCenter </item>
  3816. <item> SfGetLineSegments </item>
  3817. <item> SfGetVertices </item>
  3818. <item> SfComputePerimeter </item>
  3819. <item> SfComputeArea </item>
  3820. <item> SfGetOriginVertexXVectorYVector </item>
  3821. <item> SfComputeBoundingBox </item>
  3822. <item> SfIsDegenerateCurve </item>
  3823. <item> SfIsDegenerateSurface </item>
  3824. </list>
  3825. </event>
  3826. </member>
  3827. <member name="P:Cognex.VisionPro3D.Cog3DRectangle.ShapeState">
  3828. <summary>
  3829. Gets/sets the ShapeState for this shape.
  3830. </summary>
  3831. <value>
  3832. The ShapeState of this Shape. Must be Cog3DShapeStateConstants.Vertex, .Curve, or .Surface.
  3833. </value>
  3834. <exception cref="T:System.ArgumentException">
  3835. The ShapeState for this shape must be Cog3DShapeStateConstants.Vertex, .Curve, or .Surface.
  3836. </exception>
  3837. <event cref="E:Cognex.VisionPro.ICogChangedEvent.Changed">
  3838. <para>Fires when this property changes.</para>
  3839. <para>The following state flags may be affected:</para>
  3840. <list type="bullet">
  3841. <item> SfShapeState </item>
  3842. </list>
  3843. </event>
  3844. </member>
  3845. <member name="M:Cognex.VisionPro3D.Cog3DRectangle.ComputeDistanceSurface(Cognex.VisionPro3D.Cog3DVect3)">
  3846. <inheritdoc />
  3847. </member>
  3848. <member name="M:Cognex.VisionPro3D.Cog3DRectangle.ComputeNearestPointSurface(Cognex.VisionPro3D.Cog3DVect3)">
  3849. <inheritdoc />
  3850. </member>
  3851. <member name="P:Cognex.VisionPro3D.Cog3DRectangle.IsDegenerateSurface">
  3852. <inheritdoc />
  3853. </member>
  3854. <member name="M:Cognex.VisionPro3D.Cog3DRectangle.ComputeArea">
  3855. <inheritdoc />
  3856. </member>
  3857. <member name="M:Cognex.VisionPro3D.Cog3DRectangle.ComputeDistanceCurve(Cognex.VisionPro3D.Cog3DVect3)">
  3858. <inheritdoc />
  3859. </member>
  3860. <member name="M:Cognex.VisionPro3D.Cog3DRectangle.ComputeNearestPointCurve(Cognex.VisionPro3D.Cog3DVect3)">
  3861. <inheritdoc />
  3862. </member>
  3863. <member name="P:Cognex.VisionPro3D.Cog3DRectangle.IsDegenerateCurve">
  3864. <inheritdoc />
  3865. </member>
  3866. <member name="M:Cognex.VisionPro3D.Cog3DRectangle.ComputePerimeter">
  3867. <inheritdoc />
  3868. </member>
  3869. <member name="M:Cognex.VisionPro3D.Cog3DRectangle.ComputeDistanceVertex(Cognex.VisionPro3D.Cog3DVect3)">
  3870. <inheritdoc />
  3871. </member>
  3872. <member name="M:Cognex.VisionPro3D.Cog3DRectangle.ComputeNearestPointVertex(Cognex.VisionPro3D.Cog3DVect3)">
  3873. <inheritdoc />
  3874. </member>
  3875. <member name="M:Cognex.VisionPro3D.Cog3DRectangle.MapShape(Cognex.VisionPro3D.ICog3DTransform)">
  3876. <inheritdoc />
  3877. </member>
  3878. <member name="M:Cognex.VisionPro3D.Cog3DRectangle.ComputeBoundingBox">
  3879. <inheritdoc />
  3880. </member>
  3881. <member name="P:Cognex.VisionPro3D.Cog3DRectangle.SelectedSpaceName3D">
  3882. <inheritdoc />
  3883. </member>
  3884. <member name="M:Cognex.VisionPro3D.Cog3DRectangle.ComputeDistance(Cognex.VisionPro3D.Cog3DVect3)">
  3885. <inheritdoc />
  3886. </member>
  3887. <member name="M:Cognex.VisionPro3D.Cog3DRectangle.ComputeNearestPoint(Cognex.VisionPro3D.Cog3DVect3)">
  3888. <inheritdoc />
  3889. </member>
  3890. <member name="P:Cognex.VisionPro3D.Cog3DRectangle.IsEmpty">
  3891. <inheritdoc />
  3892. </member>
  3893. <member name="P:Cognex.VisionPro3D.Cog3DRectangle.IsFinite">
  3894. <inheritdoc />
  3895. </member>
  3896. <member name="M:Cognex.VisionPro3D.Cog3DRectangle.Clone">
  3897. <inheritdoc />
  3898. </member>
  3899. <member name="M:Cognex.VisionPro3D.Cog3DRectangle.Finalize">
  3900. <inheritdoc cref="M:Cognex.VisionPro3D.ICog3DBase.FinalizerForThisClass" />
  3901. </member>
  3902. <member name="M:Cognex.VisionPro3D.Cog3DRectangle.Dispose">
  3903. <inheritdoc cref="M:Cognex.VisionPro3D.ICog3DBase.DestructorForThisClass" />
  3904. </member>
  3905. <member name="M:Cognex.VisionPro3D.Cog3DRectangle.#ctor(Cognex.VisionPro3D.Cog3DRectangle)">
  3906. <inheritdoc cref="M:Cognex.VisionPro3D.ICog3DBase.DeepCopyConstructorForThisClass(System.Object)" />
  3907. </member>
  3908. <member name="M:Cognex.VisionPro3D.Cog3DRectangle.#ctor(Cognex.VisionPro3D.Cog3DVect2,Cognex.VisionPro3D.Cog3DTransformRigid,Cognex.VisionPro3D.Cog3DShapeStateConstants)">
  3909. <summary>
  3910. Constructs a rectangle using the specified size, rigid transform, and Cog3DShapeStateConstants.
  3911. </summary>
  3912. <param name="size">
  3913. The X, Y extents of this rectangle. X and Y must be &gt;= 0.
  3914. </param>
  3915. <param name="shapeFromScaledUnitRectangle">
  3916. The rigid transform that maps the ScaledUnitRectangle to a pose in 3D space.
  3917. </param>
  3918. <param name="shapeState">
  3919. The state of this rectangle. Must be Cog3DShapeStateConstants.Vertex, .Curve, or .Surface.
  3920. </param>
  3921. <exception cref="T:System.ArgumentException">
  3922. If any member of <paramref name="size" /> is less than 0.
  3923. </exception>
  3924. <exception cref="T:System.ArgumentNullException">
  3925. If <paramref name="shapeFromScaledUnitRectangle" /> is null.
  3926. </exception>
  3927. <exception cref="T:System.ArgumentException">
  3928. The ShapeState for this shape must be Cog3DShapeStateConstants.Vertex, .Curve, or .Surface.
  3929. </exception>
  3930. </member>
  3931. <member name="M:Cognex.VisionPro3D.Cog3DRectangle.#ctor">
  3932. <summary>
  3933. Constructs a degenerate rectangle with Size of (0,0),
  3934. ShapeFromScaledUnitRectangle of identity transform,
  3935. and ShapeState of Cog3DShapeStateConstants.Surface.
  3936. </summary>
  3937. </member>
  3938. <member name="T:Cognex.VisionPro3D.Cog3DRectangle">
  3939. <summary>
  3940. This class encapsulates an oriented 3D rectangle.
  3941. A Cog3DRectangle is defined by a size vector and a 3D rigid transform. The size vector
  3942. defines an axis-aligned rectangle on the XY plane (whose
  3943. edges are parallel to x axis or y axis), whose vertex with minimum x
  3944. and minimum y is at the origin (cc3DVect(0,0,0)), and the opposite
  3945. vertex's coordinates are defined by the size vector
  3946. (Cog3DVect3(Size.X, Size.Y, 0)). This is referred to as the "ScaledUnitRectangle".
  3947. The rigid transform (ShapeFromScaledUnitRectangle)
  3948. maps the ScaledUnitRectangle to the desired pose in 3D space.
  3949. </summary>
  3950. </member>
  3951. <member name="M:Cognex.VisionPro3D.Cog3DPlane.GetObjectData(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
  3952. <inheritdoc cref="M:Cognex.VisionPro3D.ICog3DBase.GetObjectData(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)" />
  3953. </member>
  3954. <member name="M:Cognex.VisionPro3D.Cog3DPlane.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
  3955. <inheritdoc cref="M:Cognex.VisionPro3D.ICog3DBase.SerializationConstructor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)" />
  3956. </member>
  3957. <member name="M:Cognex.VisionPro3D.Cog3DPlane.RealEqual(Cognex.VisionPro3D.Cog3DPlane,Cognex.VisionPro3D.Cog3DPlane,System.Double)">
  3958. <inheritdoc cref="M:Cognex.VisionPro3D.ICog3DBase.RealEqual(System.Object,System.Object,System.Double)" />
  3959. </member>
  3960. <member name="M:Cognex.VisionPro3D.Cog3DPlane.ToString">
  3961. <inheritdoc cref="M:Cognex.VisionPro3D.ICog3DBase.ToString" />
  3962. </member>
  3963. <member name="M:Cognex.VisionPro3D.Cog3DPlane.ProjectVectorOntoPlane(Cognex.VisionPro3D.Cog3DVect3)">
  3964. <summary>
  3965. Computes the vector resulting from projecting the specified vector
  3966. onto this plane.
  3967. </summary>
  3968. <param name="vector3D">
  3969. The vector to be projected onto this plane.
  3970. </param>
  3971. <returns>
  3972. The vector resulting from projecting the specified vector onto this plane.
  3973. </returns>
  3974. </member>
  3975. <member name="M:Cognex.VisionPro3D.Cog3DPlane.ComputeSignedDistance(Cognex.VisionPro3D.Cog3DVect3)">
  3976. <summary>
  3977. Computes the signed distance from this plane to the specified point.
  3978. The distance is positive if the point is on the same side of the plane
  3979. as the normal.
  3980. </summary>
  3981. <param name="point3D">
  3982. The point to use for computing the distance.
  3983. </param>
  3984. <returns>
  3985. The signed distance from this plane to the specified point.
  3986. </returns>
  3987. </member>
  3988. <member name="M:Cognex.VisionPro3D.Cog3DPlane.SetNormalAndOffset(Cognex.VisionPro3D.Cog3DVect3,System.Double)">
  3989. <summary>
  3990. Sets this plane using the specified normal and an offset.
  3991. The offset is the translation of the plane from the origin
  3992. along the normal direction.
  3993. The specified normal is normalized to a unit vector.
  3994. <para> Note that the following point is on the plane:
  3995. <paramref name="offset" /> * <paramref name="normal3D" /> / <paramref name="normal3D" />.Length
  3996. </para></summary>
  3997. <param name="normal3D">
  3998. The normal of the plane.
  3999. The specified normal is normalized to a unit vector.
  4000. </param>
  4001. <param name="offset">
  4002. The translation of the plane from the origin
  4003. along the normal direction.
  4004. </param>
  4005. <exception cref="T:System.ArgumentException">
  4006. If <paramref name="normal3D" /> is (0,0,0).
  4007. </exception>
  4008. <event cref="E:Cognex.VisionPro.ICogChangedEvent.Changed">
  4009. <para>Fires when some properties change.</para>
  4010. <para>The following state flags may be affected:</para>
  4011. <list type="bullet">
  4012. <item> SfNormal </item>
  4013. <item> SfGetTilt </item>
  4014. <item> SfGetRotation </item>
  4015. <item> SfOffset </item>
  4016. <item> SfIsDegenerateSurface </item>
  4017. </list>
  4018. </event>
  4019. </member>
  4020. <member name="M:Cognex.VisionPro3D.Cog3DPlane.SetPointAndNormal(Cognex.VisionPro3D.Cog3DVect3,Cognex.VisionPro3D.Cog3DVect3)">
  4021. <summary>
  4022. Sets this plane using the specified point (a point in the plane)
  4023. and the specified normal.
  4024. The specified normal is normalized to a unit vector.
  4025. </summary>
  4026. <param name="pointOnPlane3D">
  4027. A point on the plane.
  4028. </param>
  4029. <param name="normal3D">
  4030. The normal of the plane.
  4031. The specified normal is normalized to a unit vector.
  4032. </param>
  4033. <exception cref="T:System.ArgumentException">
  4034. If <paramref name="normal3D" /> is (0,0,0).
  4035. </exception>
  4036. <event cref="E:Cognex.VisionPro.ICogChangedEvent.Changed">
  4037. <para>Fires when some properties change.</para>
  4038. <para>The following state flags may be affected:</para>
  4039. <list type="bullet">
  4040. <item> SfNormal </item>
  4041. <item> SfGetTilt </item>
  4042. <item> SfGetRotation </item>
  4043. <item> SfOffset </item>
  4044. <item> SfIsDegenerateSurface </item>
  4045. </list>
  4046. </event>
  4047. </member>
  4048. <member name="M:Cognex.VisionPro3D.Cog3DPlane.SetPoints(Cognex.VisionPro3D.Cog3DVect3,Cognex.VisionPro3D.Cog3DVect3,Cognex.VisionPro3D.Cog3DVect3)">
  4049. <summary>
  4050. Sets this plane according to the specified 3 points. If the 3 points are
  4051. collinear or coincident, then the plane is degenerate, else constructs
  4052. a plane with a normal determined by (pB - pA) crossProduct (pC - pA).
  4053. </summary>
  4054. <param name="pointA3D">
  4055. One of the 3 points used to define this plane.
  4056. </param>
  4057. <param name="pointB3D">
  4058. One of the 3 points used to define this plane.
  4059. </param>
  4060. <param name="pointC3D">
  4061. One of the 3 points used to define this plane.
  4062. </param>
  4063. <event cref="E:Cognex.VisionPro.ICogChangedEvent.Changed">
  4064. <para>Fires when some properties change.</para>
  4065. <para>The following state flags may be affected:</para>
  4066. <list type="bullet">
  4067. <item> SfNormal </item>
  4068. <item> SfGetTilt </item>
  4069. <item> SfGetRotation </item>
  4070. <item> SfOffset </item>
  4071. <item> SfIsDegenerateSurface </item>
  4072. </list>
  4073. </event>
  4074. </member>
  4075. <member name="M:Cognex.VisionPro3D.Cog3DPlane.MapRigid(Cognex.VisionPro3D.Cog3DTransformRigid)">
  4076. <summary>
  4077. Maps this plane through the specified rigid transform and
  4078. returns a Cog3DPlane.
  4079. </summary>
  4080. <param name="newFromOld">
  4081. The rigid transform to use when mapping this plane.
  4082. </param>
  4083. <returns>
  4084. The Cog3DPlane resulting from mapping this plane through the
  4085. specified rigid transform.
  4086. </returns>
  4087. <exception cref="T:System.ArgumentNullException">
  4088. If <paramref name="newFromOld" /> is null.
  4089. </exception>
  4090. </member>
  4091. <member name="M:Cognex.VisionPro3D.Cog3DPlane.GetRotation">
  4092. <summary>
  4093. Computes the rotation of this plane, where "rotation" is
  4094. defined as the angle (in radians) between the projection of the plane Normal on the
  4095. XY-plane and the X-axis, and normalized to the range [0, Math.PI * 2).
  4096. </summary>
  4097. <returns>
  4098. The angle (in radians) between the projection of the plane Normal on the
  4099. XY-plane and the X-axis.
  4100. </returns>
  4101. </member>
  4102. <member name="M:Cognex.VisionPro3D.Cog3DPlane.GetTilt">
  4103. <summary>
  4104. Computes the tilt of this plane, where "tilt" is defined as the
  4105. angle (in radians) between the plane Normal and the Z-axis, and
  4106. normalized to the range [0, Math.PI].
  4107. </summary>
  4108. <returns>
  4109. The angle (in radians) between the plane Normal and the Z-axis.
  4110. </returns>
  4111. </member>
  4112. <member name="P:Cognex.VisionPro3D.Cog3DPlane.Offset">
  4113. <summary>
  4114. Gets/sets the offset for this plane. The offset is the translation from the origin
  4115. along the normal direction.
  4116. </summary>
  4117. <value>
  4118. The offset of this plane. The offset is the translation from the origin
  4119. along the normal direction.
  4120. </value>
  4121. <exception cref="T:Cognex.VisionPro3D.Cog3DException">
  4122. If the plane is degenerate.
  4123. </exception>
  4124. <event cref="E:Cognex.VisionPro.ICogChangedEvent.Changed">
  4125. <para>Fires when this property changes.</para>
  4126. <para>The following state flags may be affected:</para>
  4127. <list type="bullet">
  4128. <item> SfOffset </item>
  4129. </list>
  4130. </event>
  4131. </member>
  4132. <member name="P:Cognex.VisionPro3D.Cog3DPlane.Normal">
  4133. <summary>
  4134. Gets/sets the normal for this plane. The getter returns a unit vector.
  4135. </summary>
  4136. <value>
  4137. The normal of this plane.
  4138. </value>
  4139. <exception cref="T:System.ArgumentException">
  4140. From the setter if <paramref name="normal" /> is degenerate i.e. (0,0,0).
  4141. </exception>
  4142. <exception cref="T:Cognex.VisionPro3D.Cog3DException">
  4143. If the plane is degenerate.
  4144. </exception>
  4145. <event cref="E:Cognex.VisionPro.ICogChangedEvent.Changed">
  4146. <para>Fires when this property changes.</para>
  4147. <para>The following state flags may be affected:</para>
  4148. <list type="bullet">
  4149. <item> SfNormal </item>
  4150. <item> SfGetTilt </item>
  4151. <item> SfGetRotation </item>
  4152. </list>
  4153. </event>
  4154. </member>
  4155. <member name="P:Cognex.VisionPro3D.Cog3DPlane.ShapeState">
  4156. <summary>
  4157. Get/sets the ShapeState for this shape.
  4158. </summary>
  4159. <value>
  4160. The ShapeState of this Shape is always Cog3DShapeStateConstants.Surface.
  4161. </value>
  4162. <exception cref="T:System.ArgumentException">
  4163. If the ShapeState for this shape is not Cog3DShapeStateConstants.Surface.
  4164. </exception>
  4165. </member>
  4166. <member name="M:Cognex.VisionPro3D.Cog3DPlane.ComputeDistanceSurface(Cognex.VisionPro3D.Cog3DVect3)">
  4167. <inheritdoc />
  4168. </member>
  4169. <member name="M:Cognex.VisionPro3D.Cog3DPlane.ComputeNearestPointSurface(Cognex.VisionPro3D.Cog3DVect3)">
  4170. <inheritdoc />
  4171. </member>
  4172. <member name="P:Cognex.VisionPro3D.Cog3DPlane.IsDegenerateSurface">
  4173. <inheritdoc />
  4174. </member>
  4175. <member name="M:Cognex.VisionPro3D.Cog3DPlane.ComputeArea">
  4176. <inheritdoc />
  4177. </member>
  4178. <member name="M:Cognex.VisionPro3D.Cog3DPlane.MapShape(Cognex.VisionPro3D.ICog3DTransform)">
  4179. <inheritdoc />
  4180. </member>
  4181. <member name="M:Cognex.VisionPro3D.Cog3DPlane.ComputeBoundingBox">
  4182. <inheritdoc />
  4183. </member>
  4184. <member name="P:Cognex.VisionPro3D.Cog3DPlane.SelectedSpaceName3D">
  4185. <inheritdoc />
  4186. </member>
  4187. <member name="M:Cognex.VisionPro3D.Cog3DPlane.ComputeDistance(Cognex.VisionPro3D.Cog3DVect3)">
  4188. <inheritdoc />
  4189. </member>
  4190. <member name="M:Cognex.VisionPro3D.Cog3DPlane.ComputeNearestPoint(Cognex.VisionPro3D.Cog3DVect3)">
  4191. <inheritdoc />
  4192. </member>
  4193. <member name="P:Cognex.VisionPro3D.Cog3DPlane.IsEmpty">
  4194. <inheritdoc />
  4195. </member>
  4196. <member name="P:Cognex.VisionPro3D.Cog3DPlane.IsFinite">
  4197. <inheritdoc />
  4198. </member>
  4199. <member name="M:Cognex.VisionPro3D.Cog3DPlane.Clone">
  4200. <inheritdoc />
  4201. </member>
  4202. <member name="M:Cognex.VisionPro3D.Cog3DPlane.Finalize">
  4203. <summary>
  4204. Finalize this object.
  4205. </summary>
  4206. </member>
  4207. <member name="M:Cognex.VisionPro3D.Cog3DPlane.Dispose">
  4208. <inheritdoc cref="M:Cognex.VisionPro3D.ICog3DBase.DestructorForThisClass" />
  4209. </member>
  4210. <member name="M:Cognex.VisionPro3D.Cog3DPlane.#ctor(Cognex.VisionPro3D.Cog3DVect3,System.Double)">
  4211. <summary>
  4212. Constructs a plane using the specified normal and an offset.
  4213. The offset is the translation of the plane from the origin
  4214. along the normal direction.
  4215. The specified normal is normalized to a unit vector.
  4216. <para> Note that the following point is on the plane:
  4217. <paramref name="offset" /> * <paramref name="normal3D" /> / <paramref name="normal3D" />.Length
  4218. </para></summary>
  4219. <param name="normal3D">
  4220. The normal of the plane being constructed.
  4221. The specified normal is normalized to a unit vector.
  4222. </param>
  4223. <param name="offset">
  4224. The translation of the plane from the origin
  4225. along the normal direction.
  4226. </param>
  4227. <exception cref="T:System.ArgumentException">
  4228. If <paramref name="normal3D" /> is (0,0,0).
  4229. </exception>
  4230. </member>
  4231. <member name="M:Cognex.VisionPro3D.Cog3DPlane.#ctor(Cognex.VisionPro3D.Cog3DVect3,Cognex.VisionPro3D.Cog3DVect3,Cognex.VisionPro3D.Cog3DVect3)">
  4232. <summary>
  4233. Constructs a plane using the specified 3 points. If the 3 points are
  4234. collinear or coincident, then the plane is degenerate, else constructs
  4235. a plane with a normal determined by (pointB3D - pointA3D) crossProduct (pointC3D - pointA3D).
  4236. </summary>
  4237. <param name="pointA3D">
  4238. One of the 3 points used to define this plane.
  4239. </param>
  4240. <param name="pointB3D">
  4241. One of the 3 points used to define this plane.
  4242. </param>
  4243. <param name="pointC3D">
  4244. One of the 3 points used to define this plane.
  4245. </param>
  4246. </member>
  4247. <member name="M:Cognex.VisionPro3D.Cog3DPlane.#ctor(Cognex.VisionPro3D.Cog3DVect3,Cognex.VisionPro3D.Cog3DVect3)">
  4248. <summary>
  4249. Constructs a plane using the specified point (a point in the plane)
  4250. and the specified normal.
  4251. The specified normal is normalized to a unit vector.
  4252. </summary>
  4253. <param name="pointOnPlane3D">
  4254. A point on the plane being constructed.
  4255. </param>
  4256. <param name="normal3D">
  4257. The normal of the plane being constructed.
  4258. The specified normal is normalized to a unit vector.
  4259. </param>
  4260. <exception cref="T:System.ArgumentException">
  4261. If <paramref name="normal3D" /> is (0,0,0).
  4262. </exception>
  4263. </member>
  4264. <member name="M:Cognex.VisionPro3D.Cog3DPlane.#ctor(Cognex.VisionPro3D.Cog3DPlane)">
  4265. <inheritdoc cref="M:Cognex.VisionPro3D.ICog3DBase.DeepCopyConstructorForThisClass(System.Object)" />
  4266. </member>
  4267. <member name="M:Cognex.VisionPro3D.Cog3DPlane.#ctor">
  4268. <summary>
  4269. Constructs a degenerate plane consistent with
  4270. Cog3DPlane(Cog3DVect3(), Cog3DVect3(), Cog3DVect3()).
  4271. </summary>
  4272. </member>
  4273. <member name="T:Cognex.VisionPro3D.Cog3DPlane">
  4274. <summary>
  4275. This class encapsulates a plane.
  4276. Planes have 3 parameterizations: 3 points, point-in-the-plane plus normal,
  4277. normal plus offset-from-origin. The offset-from-origin is
  4278. the translation from the origin along the normal direction.
  4279. </summary>
  4280. </member>
  4281. <member name="M:Cognex.VisionPro3D.Cog3DRay.GetObjectData(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
  4282. <inheritdoc cref="M:Cognex.VisionPro3D.ICog3DBase.GetObjectData(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)" />
  4283. </member>
  4284. <member name="M:Cognex.VisionPro3D.Cog3DRay.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
  4285. <inheritdoc cref="M:Cognex.VisionPro3D.ICog3DBase.SerializationConstructor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)" />
  4286. </member>
  4287. <member name="M:Cognex.VisionPro3D.Cog3DRay.RealEqual(Cognex.VisionPro3D.Cog3DRay,Cognex.VisionPro3D.Cog3DRay,System.Double)">
  4288. <inheritdoc cref="M:Cognex.VisionPro3D.ICog3DBase.RealEqual(System.Object,System.Object,System.Double)" />
  4289. </member>
  4290. <member name="M:Cognex.VisionPro3D.Cog3DRay.ToString">
  4291. <inheritdoc cref="M:Cognex.VisionPro3D.ICog3DBase.ToString" />
  4292. </member>
  4293. <member name="M:Cognex.VisionPro3D.Cog3DRay.CreateLine">
  4294. <summary>
  4295. Creates the Cog3DLine coincident with this ray.
  4296. </summary>
  4297. <returns>
  4298. The Cog3DLine coincident with this ray.
  4299. </returns>
  4300. </member>
  4301. <member name="M:Cognex.VisionPro3D.Cog3DRay.MapRigid(Cognex.VisionPro3D.Cog3DTransformRigid)">
  4302. <summary>
  4303. Maps this ray through the specified rigid transform and
  4304. return a Cog3DRay.
  4305. </summary>
  4306. <param name="transform">
  4307. The rigid transform to use when mapping this ray.
  4308. </param>
  4309. <returns>
  4310. The Cog3DRay resulting from mapping this ray through the specified rigid transform.
  4311. </returns>
  4312. <exception cref="T:System.ArgumentNullException">
  4313. If <paramref name="transform" /> is null.
  4314. </exception>
  4315. </member>
  4316. <member name="P:Cognex.VisionPro3D.Cog3DRay.Direction">
  4317. <summary>
  4318. Gets/sets the direction of this ray. The getter returns a unit vector.
  4319. </summary>
  4320. <value>
  4321. The direction of the ray.
  4322. </value>
  4323. <exception cref="T:System.ArgumentException">
  4324. If <paramref name="direction3D" /> is degenerate i.e. (0,0,0).
  4325. </exception>
  4326. <exception cref="T:Cognex.VisionPro3D.Cog3DException">
  4327. From the getter if the ray is degenerate.
  4328. </exception>
  4329. <event cref="E:Cognex.VisionPro.ICogChangedEvent.Changed">
  4330. <para>Fires when this property changes.</para>
  4331. <para>The following state flags may be affected:</para>
  4332. <list type="bullet">
  4333. <item> SfDirection </item>
  4334. <item> SfIsDegenerateCurve </item>
  4335. </list>
  4336. </event>
  4337. </member>
  4338. <member name="P:Cognex.VisionPro3D.Cog3DRay.P1">
  4339. <summary>
  4340. Gets/sets the start point of the ray.
  4341. </summary>
  4342. <value>
  4343. The start point of the ray.
  4344. </value>
  4345. <event cref="E:Cognex.VisionPro.ICogChangedEvent.Changed">
  4346. <para>Fires when this property changes.</para>
  4347. <para>The following state flags may be affected:</para>
  4348. <list type="bullet">
  4349. <item> SfP1 </item>
  4350. </list>
  4351. </event>
  4352. </member>
  4353. <member name="P:Cognex.VisionPro3D.Cog3DRay.ShapeState">
  4354. <summary>
  4355. Gets/sets the ShapeState for this shape.
  4356. </summary>
  4357. <value>
  4358. The ShapeState of this Shape. Must be Cog3DShapeStateConstants.Vertex or Cog3DShapeStateConstants.Curve.
  4359. </value>
  4360. <exception cref="T:System.ArgumentException">
  4361. If the ShapeState for this shape is neither Cog3DShapeStateConstants.Vertex nor Cog3DShapeStateConstants.Curve.
  4362. </exception>
  4363. <event cref="E:Cognex.VisionPro.ICogChangedEvent.Changed">
  4364. <para>Fires when this property changes.</para>
  4365. <para>The following state flags may be affected:</para>
  4366. <list type="bullet">
  4367. <item> SfShapeState </item>
  4368. </list>
  4369. </event>
  4370. </member>
  4371. <member name="M:Cognex.VisionPro3D.Cog3DRay.ComputeDistanceCurve(Cognex.VisionPro3D.Cog3DVect3)">
  4372. <inheritdoc />
  4373. </member>
  4374. <member name="M:Cognex.VisionPro3D.Cog3DRay.ComputeNearestPointCurve(Cognex.VisionPro3D.Cog3DVect3)">
  4375. <inheritdoc />
  4376. </member>
  4377. <member name="P:Cognex.VisionPro3D.Cog3DRay.IsDegenerateCurve">
  4378. <inheritdoc />
  4379. </member>
  4380. <member name="M:Cognex.VisionPro3D.Cog3DRay.ComputePerimeter">
  4381. <inheritdoc />
  4382. </member>
  4383. <member name="M:Cognex.VisionPro3D.Cog3DRay.ComputeDistanceVertex(Cognex.VisionPro3D.Cog3DVect3)">
  4384. <inheritdoc />
  4385. </member>
  4386. <member name="M:Cognex.VisionPro3D.Cog3DRay.ComputeNearestPointVertex(Cognex.VisionPro3D.Cog3DVect3)">
  4387. <inheritdoc />
  4388. </member>
  4389. <member name="M:Cognex.VisionPro3D.Cog3DRay.MapShape(Cognex.VisionPro3D.ICog3DTransform)">
  4390. <inheritdoc />
  4391. </member>
  4392. <member name="M:Cognex.VisionPro3D.Cog3DRay.ComputeBoundingBox">
  4393. <inheritdoc />
  4394. </member>
  4395. <member name="P:Cognex.VisionPro3D.Cog3DRay.SelectedSpaceName3D">
  4396. <inheritdoc />
  4397. </member>
  4398. <member name="M:Cognex.VisionPro3D.Cog3DRay.ComputeDistance(Cognex.VisionPro3D.Cog3DVect3)">
  4399. <inheritdoc />
  4400. </member>
  4401. <member name="M:Cognex.VisionPro3D.Cog3DRay.ComputeNearestPoint(Cognex.VisionPro3D.Cog3DVect3)">
  4402. <inheritdoc />
  4403. </member>
  4404. <member name="P:Cognex.VisionPro3D.Cog3DRay.IsEmpty">
  4405. <inheritdoc />
  4406. </member>
  4407. <member name="P:Cognex.VisionPro3D.Cog3DRay.IsFinite">
  4408. <inheritdoc />
  4409. </member>
  4410. <member name="M:Cognex.VisionPro3D.Cog3DRay.Clone">
  4411. <inheritdoc />
  4412. </member>
  4413. <member name="M:Cognex.VisionPro3D.Cog3DRay.Finalize">
  4414. <inheritdoc cref="M:Cognex.VisionPro3D.ICog3DBase.FinalizerForThisClass" />
  4415. </member>
  4416. <member name="M:Cognex.VisionPro3D.Cog3DRay.Dispose">
  4417. <inheritdoc cref="M:Cognex.VisionPro3D.ICog3DBase.DestructorForThisClass" />
  4418. </member>
  4419. <member name="M:Cognex.VisionPro3D.Cog3DRay.#ctor(Cognex.VisionPro3D.Cog3DVect3,Cognex.VisionPro3D.Cog3DVect3,Cognex.VisionPro3D.Cog3DRay.ParameterizationType,Cognex.VisionPro3D.Cog3DShapeStateConstants)">
  4420. <summary>
  4421. Constructs a Cog3DRay using parameterizationType to interpret v1 and v2.
  4422. </summary>
  4423. <param name="v1">
  4424. The start point of the ray.
  4425. </param>
  4426. <param name="v2">
  4427. If parameterizationType is Points,
  4428. then v2 is interpreted as a point along the ray.
  4429. If parameterizationType is PointAndDirection,
  4430. then v2 is interpreted as a direction vector.
  4431. </param>
  4432. <param name="parameterizationType">
  4433. Specifies how v1 and v2 are interpreted.
  4434. </param>
  4435. <param name="shapeState">
  4436. The state of this ray. Must be Cog3DShapeStateConstants.Vertex or Cog3DShapeStateConstants.Curve.
  4437. </param>
  4438. <exception cref="T:System.ArgumentException">
  4439. If <paramref name="shapeState" /> is not Cog3DShapeStateConstants.Vertex or Cog3DShapeStateConstants.Curve.
  4440. </exception>
  4441. </member>
  4442. <member name="M:Cognex.VisionPro3D.Cog3DRay.#ctor(Cognex.VisionPro3D.Cog3DRay)">
  4443. <inheritdoc cref="M:Cognex.VisionPro3D.ICog3DBase.DeepCopyConstructorForThisClass(System.Object)" />
  4444. </member>
  4445. <member name="M:Cognex.VisionPro3D.Cog3DRay.#ctor">
  4446. <summary>
  4447. Constructs a degenerate Cog3DRay consistent with
  4448. Cog3DRay(Cog3DVect3(), Cog3DVect3(), Cog3DShapeStateConstants.Points, Cog3DShapeStateConstants.Curve).
  4449. </summary>
  4450. </member>
  4451. <member name="T:Cognex.VisionPro3D.Cog3DRay.ParameterizationType">
  4452. <summary>
  4453. This enum allows the client to specify whether the parameters
  4454. being specified represent the ray's origin and a point on
  4455. the ray or if the parameters specify the ray's origin and a
  4456. direction vector.
  4457. </summary>
  4458. </member>
  4459. <member name="T:Cognex.VisionPro3D.Cog3DRay">
  4460. <summary>
  4461. This class encapsulates a directed 3D ray. It is parameterized as
  4462. a start point (represented using P1) and a direction (represented
  4463. using Direction). A ray is infinite like a line, but only extends in
  4464. one direction.
  4465. </summary>
  4466. </member>
  4467. <member name="M:Cognex.VisionPro3D.Cog3DLine.GetObjectData(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
  4468. <inheritdoc cref="M:Cognex.VisionPro3D.ICog3DBase.GetObjectData(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)" />
  4469. </member>
  4470. <member name="M:Cognex.VisionPro3D.Cog3DLine.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
  4471. <inheritdoc cref="M:Cognex.VisionPro3D.ICog3DBase.SerializationConstructor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)" />
  4472. </member>
  4473. <member name="M:Cognex.VisionPro3D.Cog3DLine.RealEqual(Cognex.VisionPro3D.Cog3DLine,Cognex.VisionPro3D.Cog3DLine,System.Double)">
  4474. <inheritdoc cref="M:Cognex.VisionPro3D.ICog3DBase.RealEqual(System.Object,System.Object,System.Double)" />
  4475. </member>
  4476. <member name="M:Cognex.VisionPro3D.Cog3DLine.ToString">
  4477. <inheritdoc cref="M:Cognex.VisionPro3D.ICog3DBase.ToString" />
  4478. </member>
  4479. <member name="M:Cognex.VisionPro3D.Cog3DLine.SetPointAndDirection(Cognex.VisionPro3D.Cog3DVect3,Cognex.VisionPro3D.Cog3DVect3)">
  4480. <summary>
  4481. Sets this line according to the specified point and direction.
  4482. </summary>
  4483. <param name="point3D">
  4484. One point on the line.
  4485. </param>
  4486. <param name="direction3D">
  4487. The direction of the line.
  4488. </param>
  4489. <exception cref="T:System.ArgumentException">
  4490. if <paramref name="direction3D" /> is
  4491. a degenerate direction, i.e. (0,0,0).
  4492. </exception>
  4493. <event cref="E:Cognex.VisionPro.ICogChangedEvent.Changed">
  4494. <para>Fires when some properties change.</para>
  4495. <para>The following state flags may be affected:</para>
  4496. <list type="bullet">
  4497. <item> SfDirection </item>
  4498. <item> SfPointNearestOrigin </item>
  4499. <item> SfIsDegenerateCurve </item>
  4500. </list>
  4501. </event>
  4502. </member>
  4503. <member name="M:Cognex.VisionPro3D.Cog3DLine.SetPoints(Cognex.VisionPro3D.Cog3DVect3,Cognex.VisionPro3D.Cog3DVect3)">
  4504. <summary>
  4505. Sets this line according to the specified 2 points. If the 2 points are
  4506. coincident, then the line is degenerate, else constructs
  4507. a line with a direction from pointA3D to pointB3D.
  4508. </summary>
  4509. <param name="pointA3D">
  4510. One of the 2 points used to define this line.
  4511. </param>
  4512. <param name="pointB3D">
  4513. One of the 2 points used to define this line.
  4514. </param>
  4515. <event cref="E:Cognex.VisionPro.ICogChangedEvent.Changed">
  4516. <para>Fires when some properties change.</para>
  4517. <para>The following state flags may be affected:</para>
  4518. <list type="bullet">
  4519. <item> SfDirection </item>
  4520. <item> SfPointNearestOrigin </item>
  4521. <item> SfIsDegenerateCurve </item>
  4522. </list>
  4523. </event>
  4524. </member>
  4525. <member name="M:Cognex.VisionPro3D.Cog3DLine.MapRigid(Cognex.VisionPro3D.Cog3DTransformRigid)">
  4526. <summary>
  4527. Maps this line through the specified rigid transform and
  4528. returns a Cog3DLine.
  4529. </summary>
  4530. <param name="transform">
  4531. The rigid transform to use when mapping this line.
  4532. </param>
  4533. <returns>
  4534. The Cog3DLine resulting from mapping this Line through the specified rigid transform.
  4535. </returns>
  4536. <exception cref="T:System.ArgumentNullException">
  4537. If <paramref name="transform" /> is null.
  4538. </exception>
  4539. </member>
  4540. <member name="P:Cognex.VisionPro3D.Cog3DLine.Direction">
  4541. <summary>
  4542. Gets the direction of this line. It returns a unit vector.
  4543. </summary>
  4544. <value>
  4545. The direction of the Line.
  4546. </value>
  4547. <exception cref="T:Cognex.VisionPro3D.Cog3DException">
  4548. If the line is degenerate.
  4549. </exception>
  4550. </member>
  4551. <member name="P:Cognex.VisionPro3D.Cog3DLine.PointNearestOrigin">
  4552. <summary>
  4553. Gets the point on this line nearest to the origin.
  4554. </summary>
  4555. <value>
  4556. The point on the line nearest the origin.
  4557. </value>
  4558. </member>
  4559. <member name="P:Cognex.VisionPro3D.Cog3DLine.ShapeState">
  4560. <summary>
  4561. Gets/sets the ShapeState for this shape.
  4562. </summary>
  4563. <value>
  4564. The ShapeState of this Shape is always Cog3DShapeStateConstants.Curve.
  4565. </value>
  4566. <exception cref="T:System.ArgumentException">
  4567. If the ShapeState for this shape is not Cog3DShapeStateConstants.Curve.
  4568. </exception>
  4569. </member>
  4570. <member name="M:Cognex.VisionPro3D.Cog3DLine.ComputeDistanceCurve(Cognex.VisionPro3D.Cog3DVect3)">
  4571. <inheritdoc />
  4572. </member>
  4573. <member name="M:Cognex.VisionPro3D.Cog3DLine.ComputeNearestPointCurve(Cognex.VisionPro3D.Cog3DVect3)">
  4574. <inheritdoc />
  4575. </member>
  4576. <member name="P:Cognex.VisionPro3D.Cog3DLine.IsDegenerateCurve">
  4577. <inheritdoc />
  4578. </member>
  4579. <member name="M:Cognex.VisionPro3D.Cog3DLine.ComputePerimeter">
  4580. <inheritdoc />
  4581. </member>
  4582. <member name="M:Cognex.VisionPro3D.Cog3DLine.MapShape(Cognex.VisionPro3D.ICog3DTransform)">
  4583. <inheritdoc />
  4584. </member>
  4585. <member name="M:Cognex.VisionPro3D.Cog3DLine.ComputeBoundingBox">
  4586. <inheritdoc />
  4587. </member>
  4588. <member name="P:Cognex.VisionPro3D.Cog3DLine.SelectedSpaceName3D">
  4589. <inheritdoc />
  4590. </member>
  4591. <member name="M:Cognex.VisionPro3D.Cog3DLine.ComputeDistance(Cognex.VisionPro3D.Cog3DVect3)">
  4592. <inheritdoc />
  4593. </member>
  4594. <member name="M:Cognex.VisionPro3D.Cog3DLine.ComputeNearestPoint(Cognex.VisionPro3D.Cog3DVect3)">
  4595. <inheritdoc />
  4596. </member>
  4597. <member name="P:Cognex.VisionPro3D.Cog3DLine.IsEmpty">
  4598. <inheritdoc />
  4599. </member>
  4600. <member name="P:Cognex.VisionPro3D.Cog3DLine.IsFinite">
  4601. <inheritdoc />
  4602. </member>
  4603. <member name="M:Cognex.VisionPro3D.Cog3DLine.Clone">
  4604. <inheritdoc />
  4605. </member>
  4606. <member name="M:Cognex.VisionPro3D.Cog3DLine.Finalize">
  4607. <inheritdoc cref="M:Cognex.VisionPro3D.ICog3DBase.FinalizerForThisClass" />
  4608. </member>
  4609. <member name="M:Cognex.VisionPro3D.Cog3DLine.Dispose">
  4610. <inheritdoc cref="M:Cognex.VisionPro3D.ICog3DBase.DestructorForThisClass" />
  4611. </member>
  4612. <member name="M:Cognex.VisionPro3D.Cog3DLine.#ctor(Cognex.VisionPro3D.Cog3DLineSeg)">
  4613. <summary>
  4614. Constructs a Cog3DLine from the specified lineSeg.
  4615. The direction of the line is the same as the lineSeg's direction.
  4616. </summary>
  4617. <param name="lineSeg">
  4618. The lineSeg to use when constructing this Cog3DLine.
  4619. </param>
  4620. <exception cref="T:System.ArgumentNullException">
  4621. If the input argument is null.
  4622. </exception>
  4623. </member>
  4624. <member name="M:Cognex.VisionPro3D.Cog3DLine.#ctor(Cognex.VisionPro3D.Cog3DVect3,Cognex.VisionPro3D.Cog3DVect3,Cognex.VisionPro3D.Cog3DLine.ParameterizationType)">
  4625. <summary>
  4626. Constructs a Cog3DLine using parameterizationType to interpret v1 and v2.
  4627. If parameterizationType is Points and v1 is equal to v2, then the line is degenerate.
  4628. </summary>
  4629. <param name="v1">
  4630. A point on the line.
  4631. </param>
  4632. <param name="v2">
  4633. If <paramref name="parameterizationType" /> is Points,
  4634. then <paramref name="v2" /> is interpreted as a point on
  4635. the line and the line's direction
  4636. is from <paramref name="v1" /> to <paramref name="v2" />.
  4637. If <paramref name="parameterizationType" /> is PointAndDirection,
  4638. then <paramref name="v2" /> is interpreted as a direction
  4639. vector and will be normalized to a unit vector.
  4640. </param>
  4641. <param name="parameterizationType">
  4642. Specifies how v1 and v2 are interpreted.
  4643. </param>
  4644. <exception cref="T:System.ArgumentException">
  4645. If <paramref name="parameterizationType" /> is PointAndDirection and
  4646. <paramref name="v2" /> is a degenerate direction i.e. (0,0,0).
  4647. </exception>
  4648. </member>
  4649. <member name="M:Cognex.VisionPro3D.Cog3DLine.#ctor(Cognex.VisionPro3D.Cog3DLine)">
  4650. <inheritdoc cref="M:Cognex.VisionPro3D.ICog3DBase.DeepCopyConstructorForThisClass(System.Object)" />
  4651. </member>
  4652. <member name="M:Cognex.VisionPro3D.Cog3DLine.#ctor">
  4653. <summary>
  4654. Default constructor. Constructs a degenerate Cog3DLine consistent with
  4655. Cog3DLine(Cog3DVect3(), Cog3DVect3(), ParameterizationType.Points).
  4656. </summary>
  4657. </member>
  4658. <member name="T:Cognex.VisionPro3D.Cog3DLine.ParameterizationType">
  4659. <summary>
  4660. This enum allows the client to specify whether the parameters
  4661. being specified represent two points on
  4662. the Line or if the parameters specify the Line's one point and a
  4663. direction vector.
  4664. </summary>
  4665. </member>
  4666. <member name="T:Cognex.VisionPro3D.Cog3DLine">
  4667. <summary>
  4668. This class encapsulates an infinite, directed 3D line.
  4669. </summary>
  4670. </member>
  4671. <member name="M:Cognex.VisionPro3D.Cog3DLineSeg.GetObjectData(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
  4672. <inheritdoc cref="M:Cognex.VisionPro3D.ICog3DBase.GetObjectData(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)" />
  4673. </member>
  4674. <member name="M:Cognex.VisionPro3D.Cog3DLineSeg.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
  4675. <inheritdoc cref="M:Cognex.VisionPro3D.ICog3DBase.SerializationConstructor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)" />
  4676. </member>
  4677. <member name="M:Cognex.VisionPro3D.Cog3DLineSeg.RealEqual(Cognex.VisionPro3D.Cog3DLineSeg,Cognex.VisionPro3D.Cog3DLineSeg,System.Double)">
  4678. <inheritdoc cref="M:Cognex.VisionPro3D.ICog3DBase.RealEqual(System.Object,System.Object,System.Double)" />
  4679. </member>
  4680. <member name="M:Cognex.VisionPro3D.Cog3DLineSeg.ToString">
  4681. <inheritdoc cref="M:Cognex.VisionPro3D.ICog3DBase.ToString" />
  4682. </member>
  4683. <member name="M:Cognex.VisionPro3D.Cog3DLineSeg.CreateLine">
  4684. <summary>
  4685. Creates a Cog3DLine coincident with this lineSeg.
  4686. </summary>
  4687. <returns>
  4688. A Cog3DLine coincident with this LineSeg.
  4689. </returns>
  4690. </member>
  4691. <member name="M:Cognex.VisionPro3D.Cog3DLineSeg.MapRigid(Cognex.VisionPro3D.Cog3DTransformRigid)">
  4692. <summary>
  4693. Maps this LineSeg through the specified rigid transform and
  4694. returns a Cog3DLineSeg.
  4695. </summary>
  4696. <param name="transform">
  4697. The rigid transform to use when mapping this lineSeg.
  4698. </param>
  4699. <returns>
  4700. The Cog3DLineSeg resulting from mapping this lineSeg through the specified rigid transform.
  4701. </returns>
  4702. <exception cref="T:System.ArgumentNullException">
  4703. If <paramref name="transform" /> is null.
  4704. </exception>
  4705. </member>
  4706. <member name="P:Cognex.VisionPro3D.Cog3DLineSeg.Length">
  4707. <summary>
  4708. Gets the length of this lineSeg.
  4709. </summary>
  4710. <value>
  4711. The length of this lineSeg.
  4712. </value>
  4713. </member>
  4714. <member name="P:Cognex.VisionPro3D.Cog3DLineSeg.P2">
  4715. <summary>
  4716. Gets/sets the end point of this lineSeg.
  4717. </summary>
  4718. <value>
  4719. The end point of this lineSeg.
  4720. </value>
  4721. <event cref="E:Cognex.VisionPro.ICogChangedEvent.Changed">
  4722. <para>Fires when this property changes.</para>
  4723. <para>The following state flags may be affected:</para>
  4724. <list type="bullet">
  4725. <item> SfP2 </item>
  4726. <item> SfLength </item>
  4727. <item> SfComputePerimeter </item>
  4728. <item> SfComputeBoundingBox </item>
  4729. <item> SfIsDegenerateCurve </item>
  4730. </list>
  4731. </event>
  4732. </member>
  4733. <member name="P:Cognex.VisionPro3D.Cog3DLineSeg.P1">
  4734. <summary>
  4735. Gets/sets the start point of this lineSeg.
  4736. </summary>
  4737. <value>
  4738. The start point of this lineSeg.
  4739. </value>
  4740. <event cref="E:Cognex.VisionPro.ICogChangedEvent.Changed">
  4741. <para>Fires when this property changes.</para>
  4742. <para>The following state flags may be affected:</para>
  4743. <list type="bullet">
  4744. <item> SfP1 </item>
  4745. <item> SfLength </item>
  4746. <item> SfComputePerimeter </item>
  4747. <item> SfComputeBoundingBox </item>
  4748. <item> SfIsDegenerateCurve </item>
  4749. </list>
  4750. </event>
  4751. </member>
  4752. <member name="P:Cognex.VisionPro3D.Cog3DLineSeg.ShapeState">
  4753. <summary>
  4754. Gets/sets the ShapeState for this shape.
  4755. </summary>
  4756. <value>
  4757. The ShapeState of this Shape. Must be
  4758. Cog3DShapeStateConstants.Vertex or Cog3DShapeStateConstants.Curve.
  4759. </value>
  4760. <exception cref="T:System.ArgumentException">
  4761. If the ShapeState for this shape is neither Cog3DShapeStateConstants.Vertex
  4762. nor Cog3DShapeStateConstants.Curve.
  4763. </exception>
  4764. <event cref="E:Cognex.VisionPro.ICogChangedEvent.Changed">
  4765. <para>Fires when this property changes.</para>
  4766. <para>The following state flags may be affected:</para>
  4767. <list type="bullet">
  4768. <item> SfShapeState </item>
  4769. </list>
  4770. </event>
  4771. </member>
  4772. <member name="M:Cognex.VisionPro3D.Cog3DLineSeg.ComputeDistanceCurve(Cognex.VisionPro3D.Cog3DVect3)">
  4773. <inheritdoc />
  4774. </member>
  4775. <member name="M:Cognex.VisionPro3D.Cog3DLineSeg.ComputeNearestPointCurve(Cognex.VisionPro3D.Cog3DVect3)">
  4776. <inheritdoc />
  4777. </member>
  4778. <member name="P:Cognex.VisionPro3D.Cog3DLineSeg.IsDegenerateCurve">
  4779. <inheritdoc />
  4780. </member>
  4781. <member name="M:Cognex.VisionPro3D.Cog3DLineSeg.ComputePerimeter">
  4782. <inheritdoc />
  4783. </member>
  4784. <member name="M:Cognex.VisionPro3D.Cog3DLineSeg.ComputeDistanceVertex(Cognex.VisionPro3D.Cog3DVect3)">
  4785. <inheritdoc />
  4786. </member>
  4787. <member name="M:Cognex.VisionPro3D.Cog3DLineSeg.ComputeNearestPointVertex(Cognex.VisionPro3D.Cog3DVect3)">
  4788. <inheritdoc />
  4789. </member>
  4790. <member name="M:Cognex.VisionPro3D.Cog3DLineSeg.MapShape(Cognex.VisionPro3D.ICog3DTransform)">
  4791. <inheritdoc />
  4792. </member>
  4793. <member name="M:Cognex.VisionPro3D.Cog3DLineSeg.ComputeBoundingBox">
  4794. <inheritdoc />
  4795. </member>
  4796. <member name="P:Cognex.VisionPro3D.Cog3DLineSeg.SelectedSpaceName3D">
  4797. <inheritdoc />
  4798. </member>
  4799. <member name="M:Cognex.VisionPro3D.Cog3DLineSeg.ComputeDistance(Cognex.VisionPro3D.Cog3DVect3)">
  4800. <inheritdoc />
  4801. </member>
  4802. <member name="M:Cognex.VisionPro3D.Cog3DLineSeg.ComputeNearestPoint(Cognex.VisionPro3D.Cog3DVect3)">
  4803. <inheritdoc />
  4804. </member>
  4805. <member name="P:Cognex.VisionPro3D.Cog3DLineSeg.IsEmpty">
  4806. <inheritdoc />
  4807. </member>
  4808. <member name="P:Cognex.VisionPro3D.Cog3DLineSeg.IsFinite">
  4809. <inheritdoc />
  4810. </member>
  4811. <member name="M:Cognex.VisionPro3D.Cog3DLineSeg.Clone">
  4812. <inheritdoc />
  4813. </member>
  4814. <member name="M:Cognex.VisionPro3D.Cog3DLineSeg.Finalize">
  4815. <inheritdoc cref="M:Cognex.VisionPro3D.ICog3DBase.FinalizerForThisClass" />
  4816. </member>
  4817. <member name="M:Cognex.VisionPro3D.Cog3DLineSeg.Dispose">
  4818. <inheritdoc cref="M:Cognex.VisionPro3D.ICog3DBase.DestructorForThisClass" />
  4819. </member>
  4820. <member name="M:Cognex.VisionPro3D.Cog3DLineSeg.#ctor(Cognex.VisionPro3D.Cog3DVect3,Cognex.VisionPro3D.Cog3DVect3,Cognex.VisionPro3D.Cog3DShapeStateConstants)">
  4821. <summary>
  4822. Constructs a Cog3DLineSeg using p1 and p2.
  4823. </summary>
  4824. <param name="p1">
  4825. The start point of the LineSeg.
  4826. </param>
  4827. <param name="p2">
  4828. The end point of the LineSeg.
  4829. </param>
  4830. <param name="shapeState">
  4831. The state of this LineSeg. Must be Cog3DShapeStateConstants.Vertex or Cog3DShapeStateConstants.Curve.
  4832. </param>
  4833. <exception cref="T:System.ArgumentException">
  4834. If <paramref name="shapeState" /> is not Cog3DShapeStateConstants.Vertex or Cog3DShapeStateConstants.Curve.
  4835. </exception>
  4836. </member>
  4837. <member name="M:Cognex.VisionPro3D.Cog3DLineSeg.#ctor(Cognex.VisionPro3D.Cog3DLineSeg)">
  4838. <inheritdoc cref="M:Cognex.VisionPro3D.ICog3DBase.DeepCopyConstructorForThisClass(System.Object)" />
  4839. </member>
  4840. <member name="M:Cognex.VisionPro3D.Cog3DLineSeg.#ctor">
  4841. <summary>
  4842. Constructs a degenerate Cog3DLineSeg consistent with
  4843. Cog3DLineSeg(Cog3DVect3(), Cog3DVect3(), Cog3DShapeStateConstants.Curve).
  4844. </summary>
  4845. </member>
  4846. <member name="T:Cognex.VisionPro3D.Cog3DLineSeg">
  4847. <summary>
  4848. This class encapsulates a directed 3D line segment which
  4849. has a start point (represented by P1) and an end point (represented
  4850. by P2). The direction of a 3D line segment is from its start point
  4851. (P1) to its end point (P2).
  4852. </summary>
  4853. </member>
  4854. <member name="M:Cognex.VisionPro3D.Cog3DShapeBase.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
  4855. <inheritdoc cref="M:Cognex.VisionPro3D.ICog3DBase.SerializationConstructor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)" />
  4856. </member>
  4857. <member name="M:Cognex.VisionPro3D.Cog3DShapeBase.#ctor(Cognex.VisionPro3D.Cog3DShapeBase)">
  4858. <summary>
  4859. Copy constructor.
  4860. </summary>
  4861. <exception cref="T:System.ArgumentNullException">
  4862. If other is null.
  4863. </exception>
  4864. <exception cref="!:ObjectDisposedExceptio">
  4865. If other is disposed.
  4866. </exception>
  4867. </member>
  4868. <member name="M:Cognex.VisionPro3D.Cog3DShapeBase.#ctor">
  4869. <summary>
  4870. Default constructor.
  4871. </summary>
  4872. </member>
  4873. <member name="T:Cognex.VisionPro3D.Cog3DShapeBase">
  4874. <summary>
  4875. This class is the base class for all Cognex-implemented 3D shapes.
  4876. </summary>
  4877. </member>
  4878. <member name="M:Cognex.VisionPro3D.ICog3DVolume.ComputeDistanceVolume(Cognex.VisionPro3D.Cog3DVect3)">
  4879. <summary>
  4880. Determines the distance from ComputeNearestPointVolume(<paramref name="point3D" />)
  4881. to the specified point <paramref name="point3D" />.
  4882. </summary>
  4883. <param name="point3D">
  4884. The specified point to use when computing the distance to this volume shape.
  4885. </param>
  4886. <returns>
  4887. The distance from ComputeNearestPointVolume() on this volume shape
  4888. to the specified point.
  4889. </returns>
  4890. </member>
  4891. <member name="M:Cognex.VisionPro3D.ICog3DVolume.ComputeNearestPointVolume(Cognex.VisionPro3D.Cog3DVect3)">
  4892. <summary>
  4893. Determines the point on this volume shape that is nearest to the specified point.
  4894. If the nearest point on this volume shape is not unique, returns one of the nearest points.
  4895. </summary>
  4896. <param name="point3D">
  4897. The specified point to use when computing the nearest point on this volume shape.
  4898. </param>
  4899. <returns>
  4900. The point on this volume shape that is nearest to the specified point.
  4901. </returns>
  4902. </member>
  4903. <member name="P:Cognex.VisionPro3D.ICog3DVolume.IsDegenerateVolume">
  4904. <summary>
  4905. Determines whether or not this volume shape is degenerate. This occurs
  4906. when volume shapes have a volume of 0.
  4907. </summary>
  4908. <value>
  4909. True, if this volume shape is degenerate (volume = 0), else returns false.
  4910. </value>
  4911. </member>
  4912. <member name="M:Cognex.VisionPro3D.ICog3DVolume.ComputeVolume">
  4913. <summary>
  4914. Determines the volume of this shape.
  4915. </summary>
  4916. <returns>
  4917. The volume of this shape or returns 0, if this volume shape is empty or degenerate.
  4918. </returns>
  4919. </member>
  4920. <member name="T:Cognex.VisionPro3D.ICog3DVolume">
  4921. <summary>
  4922. This interface is used to represent a 3D volume or a shape
  4923. composed/represented by a set of 3D volumes. It defines
  4924. the common methods for such shapes. In this context, volume means a
  4925. 3 dimensional shape representation e.g. box, alignedBox, etc.
  4926. </summary>
  4927. </member>
  4928. <member name="M:Cognex.VisionPro3D.ICog3DSurface.ComputeDistanceSurface(Cognex.VisionPro3D.Cog3DVect3)">
  4929. <summary>
  4930. Determines the distance from ComputeNearestPointSurface(<paramref name="point3D" />)
  4931. to the specified point <paramref name="point3D" />.
  4932. </summary>
  4933. <param name="point3D">
  4934. The specified point to use when computing the distance to this surface shape.
  4935. </param>
  4936. <returns>
  4937. The distance from ComputeNearestPointSurface() on this surface shape
  4938. to the specified point.
  4939. </returns>
  4940. </member>
  4941. <member name="M:Cognex.VisionPro3D.ICog3DSurface.ComputeNearestPointSurface(Cognex.VisionPro3D.Cog3DVect3)">
  4942. <summary>
  4943. Determines the point on this surface shape that is nearest to the specified point.
  4944. If the nearest point on this surface shape is not unique, returns one of the nearest points.
  4945. </summary>
  4946. <param name="point3D">
  4947. The specified point to use when computing the nearest point on this surface shape.
  4948. </param>
  4949. <returns>
  4950. The point on this surface shape that is nearest to the specified point.
  4951. </returns>
  4952. </member>
  4953. <member name="P:Cognex.VisionPro3D.ICog3DSurface.IsDegenerateSurface">
  4954. <summary>
  4955. Determines whether or not this surface shape is degenerate. This occurs
  4956. when surface shapes have an area of 0.
  4957. </summary>
  4958. <value>
  4959. True, if this surface shape is degenerate (area = 0), else returns false.
  4960. </value>
  4961. </member>
  4962. <member name="M:Cognex.VisionPro3D.ICog3DSurface.ComputeArea">
  4963. <summary>
  4964. Determines the area of this shape.
  4965. For an infinite shape, like Cog3DPlane, the area is 0.
  4966. </summary>
  4967. <returns>
  4968. The area of this shape or returns 0, if this surface shape is empty or degenerate.
  4969. </returns>
  4970. <remarks>
  4971. <list type="bullet">
  4972. <item> For a Cog3DCylinder shape, no matter whether is is degenerate or not,
  4973. its area is computed as: StartCircle.ComputeArea * 2 + Radius *Height .</item>
  4974. <item> For a Cog3DBox or Cog3DAlignedBox shape, no matter whether is is degenerate or not,
  4975. its area is computed as: (Size.X * Size.Y + Size.X * Size.Z + Size.Y * Size.Z) * 2 . </item>
  4976. </list>
  4977. </remarks>
  4978. </member>
  4979. <member name="T:Cognex.VisionPro3D.ICog3DSurface">
  4980. <summary>
  4981. This interface is used to represent a 3D Surface or a shape
  4982. composed/represented by a set of 3D Surfaces. It defines
  4983. the common methods for such shapes. In this context, surface means a
  4984. 2 dimensional shape representation e.g. circle, box, plane, etc.
  4985. </summary>
  4986. </member>
  4987. <member name="M:Cognex.VisionPro3D.ICog3DCurve.ComputeDistanceCurve(Cognex.VisionPro3D.Cog3DVect3)">
  4988. <summary>
  4989. Determines the distance from ComputeNearestPointCurve(<paramref name="point3D" />)
  4990. to the specified point <paramref name="point3D" />.
  4991. </summary>
  4992. <param name="point3D">
  4993. The specified point to use when computing the distance to this curve shape.
  4994. </param>
  4995. <returns>
  4996. The distance from ComputeNearestPointCurve() on this curve shape
  4997. to the specified point.
  4998. </returns>
  4999. </member>
  5000. <member name="M:Cognex.VisionPro3D.ICog3DCurve.ComputeNearestPointCurve(Cognex.VisionPro3D.Cog3DVect3)">
  5001. <summary>
  5002. Determines the point on this curve shape that is nearest to the specified point.
  5003. If the nearest point on this curve shape is not unique, returns one of the nearest points.
  5004. </summary>
  5005. <param name="point3D">
  5006. The specified point to use when computing the nearest point on this curve shape.
  5007. </param>
  5008. <returns>
  5009. The point on this curve shape that is nearest to the specified point.
  5010. </returns>
  5011. </member>
  5012. <member name="P:Cognex.VisionPro3D.ICog3DCurve.IsDegenerateCurve">
  5013. <summary>
  5014. Determines whether or not this curve shape is degenerate. This occurs
  5015. when curve shapes have a perimeter of 0.
  5016. </summary>
  5017. <value>
  5018. True, if this curve shape is degenerate (perimeter = 0), else returns false.
  5019. </value>
  5020. </member>
  5021. <member name="M:Cognex.VisionPro3D.ICog3DCurve.ComputePerimeter">
  5022. <summary>
  5023. Determines the perimeter of this shape. For a wireframe shape, the
  5024. perimeter is the total length of all the wires. For an infinite shape, like Cog3DLine,
  5025. the perimeter is 0.
  5026. </summary>
  5027. <returns>
  5028. The perimeter of this shape.
  5029. </returns>
  5030. <remarks>
  5031. <list type="bullet">
  5032. <item> For a Cog3DCylinder shape, no matter whether is is degenerate or not,
  5033. its perimeter is computed as StartCircle.ComputePerimeter() * 2 .</item>
  5034. <item> For a Cog3DRectangle shape, no matter whether is is degenerate or not,
  5035. its perimeter is computed as (Size.X + Size.Y) * 2 . </item>
  5036. <item> For a Cog3DBox or Cog3DAlignedBox shape, no matter whether is is degenerate or not,
  5037. its perimeter is computed as (Size.X + Size.Y + Size.Z) * 4. </item>
  5038. </list>
  5039. </remarks>
  5040. </member>
  5041. <member name="T:Cognex.VisionPro3D.ICog3DCurve">
  5042. <summary>
  5043. This interface is used to represent a 3D curve or a shape
  5044. composed/represented by a set of 3D curves. It defines
  5045. the common methods for such shapes. In this context, curve means a
  5046. 1 dimensional shape representation e.g. line, lineSeg, circle, wireframe, etc.
  5047. </summary>
  5048. </member>
  5049. <member name="M:Cognex.VisionPro3D.ICog3DVertex.ComputeDistanceVertex(Cognex.VisionPro3D.Cog3DVect3)">
  5050. <summary>
  5051. Determines the distance from ComputeNearestPointVertex(<paramref name="point3D" />)
  5052. to the specified point <paramref name="point3D" />.
  5053. </summary>
  5054. <param name="point3D">
  5055. The specified point to use when computing the distance to this shape.
  5056. </param>
  5057. <returns>
  5058. The distance from the nearest vertex on this shape to the specified point.
  5059. </returns>
  5060. </member>
  5061. <member name="M:Cognex.VisionPro3D.ICog3DVertex.ComputeNearestPointVertex(Cognex.VisionPro3D.Cog3DVect3)">
  5062. <summary>
  5063. Determines the vertex on this shape that is nearest to the specified point.
  5064. If the nearest vertex is not unique, returns one of the nearest vertices.
  5065. </summary>
  5066. <param name="point3D">
  5067. The specified point to use when computing the nearest vertex on this shape.
  5068. </param>
  5069. <returns>
  5070. The vertex on this shape nearest to the specified point.
  5071. </returns>
  5072. </member>
  5073. <member name="T:Cognex.VisionPro3D.ICog3DVertex">
  5074. <summary>
  5075. This interface is used to represent a 3D vertex or a shape
  5076. composed/represented by a set of 3D vertices. It defines
  5077. the common methods for such shapes.
  5078. </summary>
  5079. </member>
  5080. <member name="P:Cognex.VisionPro3D.ICog3DShape.SelectedSpaceName3D">
  5081. <summary>
  5082. The 3D coordinate space in which this shape is to be interpreted.
  5083. </summary>
  5084. <value>
  5085. The default value is ".".
  5086. </value>
  5087. <exception cref="T:Cognex.VisionPro.Exceptions.CogSpaceTreeInvalidNameSyntaxException">
  5088. If the value is an invalid space name syntax.
  5089. </exception>
  5090. </member>
  5091. <member name="P:Cognex.VisionPro3D.ICog3DShape.ShapeState">
  5092. <summary>
  5093. Gets/sets the shape state of this shape.
  5094. </summary>
  5095. <value>
  5096. The shape state of this shape.
  5097. </value>
  5098. </member>
  5099. <member name="M:Cognex.VisionPro3D.ICog3DShape.MapShape(Cognex.VisionPro3D.ICog3DTransform)">
  5100. <summary>
  5101. Creates a new shape by mapping this shape through the specified transform.
  5102. </summary>
  5103. <param name="transform">
  5104. The transform to use when mapping this shape.
  5105. </param>
  5106. <returns>
  5107. The new shape that results from mapping this shape through the specified transform.
  5108. </returns>
  5109. <exception cref="T:System.ArgumentNullException">
  5110. If <paramref name="transform" /> is null.
  5111. </exception>
  5112. <exception cref="T:System.ArgumentException">
  5113. If the specified transform is not a Cog3DTransformRigid.
  5114. </exception>
  5115. </member>
  5116. <member name="M:Cognex.VisionPro3D.ICog3DShape.ComputeBoundingBox">
  5117. <summary>
  5118. Computes the axis-aligned bounding box for this shape.
  5119. </summary>
  5120. <returns>
  5121. The axis-aligned bounding box.
  5122. </returns>
  5123. <exception cref="T:Cognex.VisionPro3D.Cog3DException">
  5124. If this shape's IsFinite is false.
  5125. </exception>
  5126. </member>
  5127. <member name="M:Cognex.VisionPro3D.ICog3DShape.ComputeDistance(Cognex.VisionPro3D.Cog3DVect3)">
  5128. <summary>
  5129. Computes the distance from this shape to the specified point.
  5130. The point on this shape used to compute the distance is a function of ShapeState.
  5131. </summary>
  5132. <param name="point3D">
  5133. The specified point to use when computing the distance to this shape.
  5134. </param>
  5135. <returns>
  5136. The distance from this shape to the specified point.
  5137. </returns>
  5138. </member>
  5139. <member name="M:Cognex.VisionPro3D.ICog3DShape.ComputeNearestPoint(Cognex.VisionPro3D.Cog3DVect3)">
  5140. <summary>
  5141. Computes the point on this shape that is nearest to the specified point.
  5142. The nearest point on this shape to the specified point is a function of ShapeState.
  5143. If the nearest point is not unique, returns one of the nearest points.
  5144. </summary>
  5145. <param name="point3D">
  5146. The specified point to use when computing the nearest point on the shape.
  5147. </param>
  5148. <returns>
  5149. The point on this shape nearest to the specified point.
  5150. </returns>
  5151. </member>
  5152. <member name="P:Cognex.VisionPro3D.ICog3DShape.IsEmpty">
  5153. <summary>
  5154. Indicates if the set of points lying on the boundary of this shape is empty.
  5155. </summary>
  5156. <value>
  5157. True if the set of points that lie on the boundary of this shape is empty, and false otherwise.
  5158. </value>
  5159. </member>
  5160. <member name="P:Cognex.VisionPro3D.ICog3DShape.IsFinite">
  5161. <summary>
  5162. Indicates if this shape has finite extents.
  5163. </summary>
  5164. <value>
  5165. True if this shape has finite extents, and false otherwise.
  5166. </value>
  5167. </member>
  5168. <member name="M:Cognex.VisionPro3D.ICog3DShape.Clone">
  5169. <summary>
  5170. Creates a deep copy of this shape.
  5171. </summary>
  5172. <returns>
  5173. A deep copy of this shape.
  5174. </returns>
  5175. </member>
  5176. <member name="T:Cognex.VisionPro3D.ICog3DShape">
  5177. <summary>
  5178. This is the most basic interface class for all 3D shapes. It specifies
  5179. the properties and methods provided by all shapes. All shapes
  5180. implement this interface.
  5181. </summary>
  5182. </member>
  5183. <member name="T:Cognex.VisionPro3D.Cog3DShapeStateConstants">
  5184. <summary>
  5185. This enum defines the available shape states for 3D shapes.
  5186. The shape state is used to disambiguate the behavior of various methods and properties of 3D shapes.
  5187. Cog3DShapeStateConstants.Vertex causes a shape to be treated as a set of vertices.
  5188. Cog3DShapeStateConstants.Curve causes a shape to be treated as a wireframe.
  5189. As an example, calling the ICog3DShape.ComputeDistance() method of a Cog3DBox returns different
  5190. distances depending on how the Cog3DBox's shape state is set.
  5191. </summary>
  5192. </member>
  5193. <member name="T:Cognex.VisionPro3D.Cog3DShapeIntersectionStatusConstants">
  5194. <summary>
  5195. This enum defines the possible shape intersection status for 3D shapes.
  5196. </summary>
  5197. </member>
  5198. <member name="F:Cognex.VisionPro3D.Cog3DShapeIntersectionStatusConstants.None">
  5199. <summary>
  5200. Two Shapes have no intersection.
  5201. </summary>
  5202. </member>
  5203. <member name="F:Cognex.VisionPro3D.Cog3DShapeIntersectionStatusConstants.Overlap">
  5204. <summary>
  5205. One shape is coincident with the other shape, or is on the other shape, or has overlap with the other shape.
  5206. </summary>
  5207. </member>
  5208. <member name="F:Cognex.VisionPro3D.Cog3DShapeIntersectionStatusConstants.Intersect">
  5209. <summary>
  5210. Two Shapes intersect.
  5211. </summary>
  5212. </member>
  5213. <member name="M:Cognex.VisionPro3D.Cog3DVect3ShapeCollection.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
  5214. <inheritdoc cref="M:Cognex.VisionPro3D.ICog3DBase.SerializationConstructor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)" />
  5215. </member>
  5216. <member name="M:Cognex.VisionPro3D.Cog3DVect3ShapeCollection.Finalize">
  5217. <inheritdoc cref="M:Cognex.VisionPro3D.ICog3DBase.FinalizerForThisClass" />
  5218. </member>
  5219. <member name="M:Cognex.VisionPro3D.Cog3DVect3ShapeCollection.Dispose">
  5220. <inheritdoc cref="M:Cognex.VisionPro3D.ICog3DBase.DestructorForThisClass" />
  5221. </member>
  5222. <member name="M:Cognex.VisionPro3D.Cog3DVect3ShapeCollection.#ctor(Cognex.VisionPro3D.Cog3DVect3ShapeCollection)">
  5223. <summary>
  5224. Construct a deep copy of the supplied Cog3DVect3Collection.
  5225. </summary>
  5226. <param name="other">
  5227. The Cog3DVect3Collection object to be copied. May not be null.
  5228. </param>
  5229. <exception cref="T:System.ArgumentNullException">
  5230. If the input argument is null.
  5231. </exception>
  5232. </member>
  5233. <member name="M:Cognex.VisionPro3D.Cog3DVect3ShapeCollection.#ctor(System.Int32)">
  5234. <summary>
  5235. Construct this default (empty) Cog3DVect3Collection
  5236. with the specified capacity.
  5237. </summary>
  5238. </member>
  5239. <member name="M:Cognex.VisionPro3D.Cog3DVect3ShapeCollection.#ctor">
  5240. <summary>
  5241. Construct this default (empty) Cog3DVect3Collection.
  5242. </summary>
  5243. </member>
  5244. <member name="T:Cognex.VisionPro3D.Cog3DVect3ShapeCollection">
  5245. <summary>
  5246. This class holds a collection of Cog3DVect3 and a SelectedSpaceName3D.
  5247. </summary>
  5248. </member>
  5249. <member name="M:Cognex.VisionPro3D.Cog3DCoordinateSpaceTree.MoveSubtree(System.String,System.String,Cognex.VisionPro.CogAddSpaceConstants)">
  5250. <summary> Move the subtree rooted at spaceName and attach it to
  5251. the newParentSpaceName, using spaceName's existing parent
  5252. transform. </summary>
  5253. <param name="spaceName">
  5254. <para> A valid nonqualified or
  5255. fully-qualified
  5256. <see cref="!:u:Framework.Coordinates.Theory.CoordSpaceNames">space
  5257. name</see> that indicates the root space of the subtree to
  5258. move. </para>
  5259. </param>
  5260. <param name="newParentSpaceName">
  5261. <para> The valid nonqualified or
  5262. fully-qualified
  5263. <see cref="!:u:Framework.Coordinates.Theory.CoordSpaceNames">name</see>
  5264. of the parent space to which to append the
  5265. subtree.</para>
  5266. </param>
  5267. <param name="duplicateHandling">
  5268. <para> A
  5269. <see cref="!:T:Cognex.VisionPro.CogAddSpaceConstants" /> value that
  5270. specifies what do if the parent coordinate space contains an
  5271. immediate child with the same name as <paramref name="spaceName" />.
  5272. The options are to return an error, replace the named child
  5273. with the copied subtree, or do nothing. </para>
  5274. </param>
  5275. <remarks>
  5276. <para> Moves the subtree rooted at the given space name
  5277. to the new parent space name. Attaches the given space name
  5278. using its existing parent transform. </para>
  5279. </remarks>
  5280. <exception cref="!:T:System.ArgumentException">
  5281. <para>
  5282. <paramref name="spaceName" /> cannot be the root
  5283. space. <paramref name="newParentSpaceName" /> cannot be a descendant
  5284. of <paramref name="spaceName" />. </para>
  5285. </exception>
  5286. <exception cref="!:T:System.ArgumentOutOfRangeException">
  5287. <para> The <paramref name="duplicateHandling" /> value is not a
  5288. member of <see cref="!:T:Cognex.VisionPro.CogAddSpaceConstants" />.
  5289. </para>
  5290. </exception>
  5291. <exception cref="!:T:Cognex.VisionPro.Exceptions.CogSpaceTreeDuplicateChildNameException">
  5292. <para>
  5293. <paramref name="spaceName" /> is already a child of the
  5294. <paramref name="newParentSpaceName" /> and
  5295. the <paramref name="duplicateHandling" /> argument is
  5296. <see cref="!:T:Cognex.VisionPro.CogAddSpaceConstants">DuplicateIsError
  5297. </see>. </para>
  5298. </exception>
  5299. <exception cref="!:T:Cognex.VisionPro.Exceptions.CogSpaceTreeInvalidNameSyntaxException">
  5300. <para>
  5301. <paramref name="spaceName" /> or
  5302. <paramref name="newParentSpaceName" /> is not a
  5303. <see cref="!:u:Framework.Coordinates.Theory.CoordSpaceNames">legal
  5304. space name</see>. </para>
  5305. </exception>
  5306. <exception cref="!:T:Cognex.VisionPro.Exceptions.CogSpaceTreeNameNotUniqueException">
  5307. <para>
  5308. <paramref name="spaceName" /> or
  5309. <paramref name="newParentSpaceName" /> is a nonqualified space name
  5310. and more than one instance of it exists in this tree. </para>
  5311. </exception>
  5312. <exception cref="!:T:Cognex.VisionPro.Exceptions.CogSpaceTreeNameNotInTreeException">
  5313. <para>
  5314. <paramref name="spaceName" /> or
  5315. <paramref name="newParentSpaceName" /> does not exist in this tree.
  5316. </para>
  5317. </exception>
  5318. <event cref="!:E:Cognex.VisionPro3D.Cog3DCoordinateSpaceTree.SubtreeMoved">
  5319. Fires when a subtree is moved. </event>
  5320. </member>
  5321. <member name="M:Cognex.VisionPro3D.Cog3DCoordinateSpaceTree.CopySubtree(System.String)">
  5322. <summary> Return a copy of the subtree rooted at SpaceName. </summary>
  5323. <param name="spaceName">
  5324. <para> A valid nonqualified or fully-qualified
  5325. <see cref="!:u:Framework.Coordinates.Theory.CoordSpaceNames">space
  5326. name</see> that indicates the root space of the subtree to
  5327. copy. </para>
  5328. </param>
  5329. <returns>
  5330. <para> The copied coordinate space subtree. </para>
  5331. </returns>
  5332. <remarks>
  5333. <para> Returns a copy of the subtree rooted at the given
  5334. space name. The returned tree contains a shallow copy of any trees
  5335. embedded in this tree using the
  5336. <see cref="!:M:Cognex.VisionPro3D.Cog3DCoordinateSpaceTree.AddTree(System.String,Cognex.VisionPro3D.Cog3DCoordinateSpaceTree,Cognex.VisionPro3D.ICog3DTransform,Cognex.VisionPro.CogAddSpaceConstants)" />
  5337. method. </para>
  5338. </remarks>
  5339. <exception cref="!:T:Cognex.VisionPro.Exceptions.CogSpaceTreeInvalidNameSyntaxException">
  5340. <para>
  5341. <paramref name="spaceName" /> is not a
  5342. <see cref="!:u:Framework.Coordinates.Theory.CoordSpaceNames">legal
  5343. space name</see>. </para>
  5344. </exception>
  5345. <exception cref="!:T:Cognex.VisionPro.Exceptions.CogSpaceTreeNameNotUniqueException">
  5346. <para>
  5347. <paramref name="spaceName" /> is a nonqualified space name
  5348. and more than one instance of it exists in this tree. </para>
  5349. </exception>
  5350. <exception cref="!:T:Cognex.VisionPro.Exceptions.CogSpaceTreeNameNotInTreeException">
  5351. <para>
  5352. <paramref name="spaceName" /> does not exist in this tree.
  5353. </para>
  5354. </exception>
  5355. </member>
  5356. <member name="M:Cognex.VisionPro3D.Cog3DCoordinateSpaceTree.DeleteSubtree(System.String)">
  5357. <summary> Delete the subtree rooted at spaceName. spaceName and all
  5358. of its children will be removed from the tree. </summary>
  5359. <param name="spaceName">
  5360. <para> A valid nonqualified or fully-qualified
  5361. <see cref="!:u:Framework.Coordinates.Theory.CoordSpaceNames">space
  5362. name</see> that indicates the root space of the subtree to
  5363. delete. </para>
  5364. </param>
  5365. <remarks>
  5366. <para> Deletes the subtree rooted at the given space
  5367. name. All children of the space are also removed from the
  5368. tree. </para>
  5369. <para> If this method encounters the root node of
  5370. a tree embedded using the
  5371. <see cref="!:M:Cognex.VisionPro3D.Cog3DCoordinateSpaceTree.AddTree(System.String,Cognex.VisionPro3D.Cog3DCoordinateSpaceTree,Cognex.VisionPro3D.ICog3DTransform,Cognex.VisionPro.CogAddSpaceConstants)" />
  5372. method, it unlinks the embedded tree, and other clients of
  5373. that embedded tree can continue to use it. </para>
  5374. </remarks>
  5375. <exception cref="!:T:System.ArgumentException">
  5376. <para>
  5377. <paramref name="spaceName" /> cannot be the root space.
  5378. </para>
  5379. </exception>
  5380. <exception cref="!:T:Cognex.VisionPro.Exceptions.CogSpaceTreeInvalidNameSyntaxException">
  5381. <para>
  5382. <paramref name="spaceName" /> is not a
  5383. <see cref="!:u:Framework.Coordinates.Theory.CoordSpaceNames">legal
  5384. space name</see>. </para>
  5385. </exception>
  5386. <exception cref="!:T:Cognex.VisionPro.Exceptions.CogSpaceTreeNameNotUniqueException">
  5387. <para>
  5388. <paramref name="spaceName" /> is a nonqualified space name
  5389. and more than one instance of it exists in this tree. </para>
  5390. </exception>
  5391. <exception cref="!:T:Cognex.VisionPro.Exceptions.CogSpaceTreeNameNotInTreeException">
  5392. <para>
  5393. <paramref name="spaceName" /> does not exist in this tree.
  5394. </para>
  5395. </exception>
  5396. <event cref="!:E:Cognex.VisionPro3D.Cog3DCoordinateSpaceTree.SubtreeDeleted">
  5397. Fires when a subtree is deleted. </event>
  5398. </member>
  5399. <member name="M:Cognex.VisionPro3D.Cog3DCoordinateSpaceTree.ChangeTransform(System.String,Cognex.VisionPro3D.ICog3DTransform)">
  5400. <summary> Change the transform which maps points from the given
  5401. child space into its parent space. The new transform is given
  5402. by newParentFromChild. </summary>
  5403. <param name="childSpaceName">
  5404. <para> A valid nonqualified or
  5405. fully-qualified
  5406. <see cref="!:u:Framework.Coordinates.Theory.CoordSpaceNames">space
  5407. name</see> that indicates the coordinate space to modify. </para>
  5408. </param>
  5409. <param name="newParentFromChild">
  5410. <para> A 3D transform that maps
  5411. points from the child space you are changing to its parent coordinate
  5412. space. </para>
  5413. </param>
  5414. <remarks>
  5415. <para> Changes the transform that maps points from the
  5416. given child space name into its parent space. </para>
  5417. </remarks>
  5418. <exception cref="!:T:System.ArgumentNullException">
  5419. <para>
  5420. <paramref name="newParentFromChild" /> is null. </para>
  5421. </exception>
  5422. <exception cref="!:T:System.ArgumentException">
  5423. <para>
  5424. <paramref name="childSpaceName" /> is the root space.</para>
  5425. </exception>
  5426. <exception cref="!:T:Cognex.VisionPro.Exceptions.CogSpaceTreeInvalidNameSyntaxException">
  5427. <para>
  5428. <paramref name="childSpaceName" /> is not a
  5429. <see cref="!:u:Framework.Coordinates.Theory.CoordSpaceNames">legal
  5430. space name</see>. </para>
  5431. </exception>
  5432. <exception cref="!:T:Cognex.VisionPro.Exceptions.CogSpaceTreeNameNotUniqueException">
  5433. <para>
  5434. <paramref name="childSpaceName" /> is a nonqualified space name
  5435. and more than one instance of it exists in this tree. </para>
  5436. </exception>
  5437. <exception cref="!:T:Cognex.VisionPro.Exceptions.CogSpaceTreeNameNotInTreeException">
  5438. <para>
  5439. <paramref name="childSpaceName" /> does not exist in this tree.
  5440. </para>
  5441. </exception>
  5442. <event cref="!:E:Cognex.VisionPro3D.Cog3DCoordinateSpaceTree.TransformChanged">
  5443. Fires when the transform changes. </event>
  5444. </member>
  5445. <member name="M:Cognex.VisionPro3D.Cog3DCoordinateSpaceTree.ChangeName(System.String,System.String)">
  5446. <summary> Change the given space name to newSpaceName. </summary>
  5447. <param name="spaceName">
  5448. <para> A valid nonqualified or fully-qualified
  5449. <see cref="!:u:Framework.Coordinates.Theory.CoordSpaceNames">space
  5450. name</see> to change. This space must exist in the tree. </para>
  5451. </param>
  5452. <param name="newSpaceName">
  5453. <para> A valid nonqualified
  5454. <see cref="!:u:Framework.Coordinates.Theory.CoordSpaceNames">space
  5455. name</see> for the new coordinate space. </para>
  5456. </param>
  5457. <remarks>
  5458. <para>Change the
  5459. <see cref="!:u:Framework.Coordinates.Theory.CoordSpaceNames">name</see>
  5460. of a space in this tree. If the <paramref name="spaceName" /> is a
  5461. fully-qualified pathname this method modifies only the trailing
  5462. nonqualified name. The new space name must meet the syntactical
  5463. requirements of a nonqualified space names. </para>
  5464. <NOTE>If you want to modify the tree's root name the
  5465. <see cref="!:P:Cognex.VisionPro3D.Cog3DCoordinateSpaceTree.RootName" />
  5466. property permits less restrictive space names. </NOTE>
  5467. </remarks>
  5468. <exception cref="!:T:Cognex.VisionPro.Exceptions.CogSpaceTreeDuplicateChildNameException">
  5469. <para>
  5470. <paramref name="newSpaceName" /> is already a child of
  5471. <paramref name="spaceName" />'s parent space. </para>
  5472. </exception>
  5473. <exception cref="!:T:Cognex.VisionPro.Exceptions.CogSpaceTreeInvalidNameSyntaxException">
  5474. <para>
  5475. <paramref name="spaceName" /> or <paramref name="newSpaceName" />
  5476. is not a <see cref="!:u:Framework.Coordinates.Theory.CoordSpaceNames">legal
  5477. space name</see>. </para>
  5478. </exception>
  5479. <exception cref="!:T:Cognex.VisionPro.Exceptions.CogSpaceTreeNameNotUniqueException">
  5480. <para>
  5481. <paramref name="spaceName" /> is a nonqualified space name
  5482. and more than one instance of it exists in this tree. </para>
  5483. </exception>
  5484. <exception cref="!:T:Cognex.VisionPro.Exceptions.CogSpaceTreeNameNotInTreeException">
  5485. <para>
  5486. <paramref name="spaceName" /> does not exist in this tree.
  5487. </para>
  5488. </exception>
  5489. <event cref="!:E:Cognex.VisionPro3D.Cog3DCoordinateSpaceTree.NameChanged">
  5490. Fires when the name changes. </event>
  5491. </member>
  5492. <member name="M:Cognex.VisionPro3D.Cog3DCoordinateSpaceTree.GetTransform(System.String,System.String)">
  5493. <summary> Return a composed transform which can map points from
  5494. the 'from' coordinate space to the 'to' space. </summary>
  5495. <param name="toSpaceName">
  5496. <para> A valid nonqualified or fully-qualified
  5497. <see cref="!:u:Framework.Coordinates.Theory.CoordSpaceNames">space
  5498. name</see> that indicates the coordinate space to which to map
  5499. points. </para>
  5500. </param>
  5501. <param name="fromSpaceName">
  5502. <para> A valid nonqualified or
  5503. fully-qualified
  5504. <see cref="!:u:Framework.Coordinates.Theory.CoordSpaceNames">space
  5505. name</see>. This name indicates the coordinate space from which
  5506. to map points into the <paramref name="toSpaceName" />. </para>
  5507. </param>
  5508. <returns>
  5509. <para> The resulting 3D transform. </para>
  5510. </returns>
  5511. <remarks>
  5512. <para>Returns a composed transform that maps points
  5513. from one coordinate space to another. </para>
  5514. </remarks>
  5515. <exception cref="!:T:Cognex.VisionPro.Exceptions.CogSpaceTreeInvalidNameSyntaxException">
  5516. <para>
  5517. <paramref name="toSpaceName" /> or
  5518. <paramref name="fromSpaceName" /> is not a
  5519. <see cref="!:u:Framework.Coordinates.Theory.CoordSpaceNames">legal
  5520. space name</see>. </para>
  5521. </exception>
  5522. <exception cref="!:T:Cognex.VisionPro.Exceptions.CogSpaceTreeNameNotUniqueException">
  5523. <para>
  5524. <paramref name="toSpaceName" /> or
  5525. <paramref name="fromSpaceName" /> is a nonqualified space name
  5526. and more than one instance of it exists in this tree. </para>
  5527. </exception>
  5528. <exception cref="!:T:Cognex.VisionPro.Exceptions.CogSpaceTreeNameNotInTreeException">
  5529. <para>
  5530. <paramref name="toSpaceName" /> or
  5531. <paramref name="fromSpaceName" /> does not exist in this tree.
  5532. </para>
  5533. </exception>
  5534. </member>
  5535. <member name="M:Cognex.VisionPro3D.Cog3DCoordinateSpaceTree.AddTree(System.String,Cognex.VisionPro3D.Cog3DCoordinateSpaceTree,Cognex.VisionPro3D.ICog3DTransform,Cognex.VisionPro.CogAddSpaceConstants)">
  5536. <summary> Add a tree of coordinate spaces to the given
  5537. parentSpaceName of this tree using the supplied
  5538. parentFromTreeRoot transform. The tree is added by reference,
  5539. so any changes to it will be visible to clients of both
  5540. trees. </summary>
  5541. <param name="parentSpaceName">
  5542. <para> A valid nonqualified or
  5543. fully-qualified
  5544. <see cref="!:u:Framework.Coordinates.Theory.CoordSpaceNames">space
  5545. name</see> that indicates the parent space. </para>
  5546. </param>
  5547. <param name="treeToAdd">
  5548. <para> The coordinate space tree to add
  5549. to the given <paramref name="parentSpaceName" />. </para>
  5550. </param>
  5551. <param name="parentFromTreeRoot">
  5552. <para> A 3D transformation
  5553. that transforms points from the root of the space tree you are
  5554. adding to the parent space. </para>
  5555. </param>
  5556. <param name="duplicateHandling">
  5557. <para> A
  5558. <see cref="!:T:Cognex.VisionPro.CogAddSpaceConstants" /> value that
  5559. specifies what do if the parent coordinate space already
  5560. contains an immediate child with the same name as the root of
  5561. <paramref name="treeToAdd" />. The options are to return an
  5562. error, replace the named child with the given tree, or do
  5563. nothing. </para>
  5564. </param>
  5565. <remarks>
  5566. <para> Adds a tree of coordinate spaces to the given
  5567. parent space name of this tree. You must also supply a
  5568. transformation that defines the relationship between the parent
  5569. space and the root of the new spaces. </para>
  5570. <para> Trees are added
  5571. by-reference. If you copy the parent tree, the copy contains an
  5572. additional reference to the supplied tree. You must avoid
  5573. creating new trees that contain circular references to other
  5574. coordinate space trees. </para>
  5575. </remarks>
  5576. <exception cref="!:T:System.ArgumentNullException">
  5577. <para>
  5578. <paramref name="treeToAdd" /> or
  5579. <paramref name="parentFromTreeRoot" /> is null. </para>
  5580. </exception>
  5581. <exception cref="!:T:System.ArgumentOutOfRangeException">
  5582. <para> The <paramref name="duplicateHandling" /> value is not a
  5583. member of <see cref="!:T:Cognex.VisionPro.CogAddSpaceConstants" />.
  5584. </para>
  5585. </exception>
  5586. <exception cref="!:T:Cognex.VisionPro.Exceptions.CogSpaceTreeDuplicateChildNameException">
  5587. <para> The root name of <paramref name="treeToAdd" /> is already a
  5588. child of <paramref name="parentSpaceName" /> and
  5589. the <paramref name="duplicateHandling" /> argument is
  5590. <see cref="!:T:Cognex.VisionPro.CogAddSpaceConstants">DuplicateIsError
  5591. </see>. </para>
  5592. </exception>
  5593. <exception cref="!:T:Cognex.VisionPro.Exceptions.CogSpaceTreeInvalidNameSyntaxException">
  5594. <para>
  5595. <paramref name="parentSpaceName" /> is not a
  5596. <see cref="!:u:Framework.Coordinates.Theory.CoordSpaceNames">legal
  5597. space name</see>. </para>
  5598. </exception>
  5599. <exception cref="!:T:Cognex.VisionPro.Exceptions.CogSpaceTreeNameNotUniqueException">
  5600. <para>
  5601. <paramref name="parentSpaceName" /> is a nonqualified space name
  5602. and more than one instance of it exists in this tree. </para>
  5603. </exception>
  5604. <exception cref="!:T:Cognex.VisionPro.Exceptions.CogSpaceTreeNameNotInTreeException">
  5605. <para>
  5606. <paramref name="parentSpaceName" /> does not exist in this tree.
  5607. </para>
  5608. </exception>
  5609. <event cref="!:E:Cognex.VisionPro3D.Cog3DCoordinateSpaceTree.TreeAdded">
  5610. Fires when a tree is added to this tree. </event>
  5611. </member>
  5612. <member name="M:Cognex.VisionPro3D.Cog3DCoordinateSpaceTree.AddSpaceWithID(System.String,System.String,Cognex.VisionPro3D.ICog3DTransform,System.Int32,System.Int32,System.Int32,System.Int32)">
  5613. <summary> For Cognex internal use only. </summary>
  5614. </member>
  5615. <member name="M:Cognex.VisionPro3D.Cog3DCoordinateSpaceTree.AddSpace(System.String,System.String,Cognex.VisionPro3D.ICog3DTransform,Cognex.VisionPro.CogAddSpaceConstants)">
  5616. <summary> Add a new coordinate space, with the given name and
  5617. transform, to this tree. Attach it to the specified
  5618. pre-existing parent space. </summary>
  5619. <param name="parentSpaceName">
  5620. <para> A valid nonqualified or
  5621. fully-qualified
  5622. <see cref="!:u:Framework.Coordinates.Theory.CoordSpaceNames">space
  5623. name</see> that indicates the parent space. </para>
  5624. </param>
  5625. <param name="newSpaceName">
  5626. <para> A valid nonqualified
  5627. <see cref="!:u:Framework.Coordinates.Theory.CoordSpaceNames">space
  5628. name</see> for the new coordinate space. </para>
  5629. </param>
  5630. <param name="parentFromNew">
  5631. <para> A 3D transform that maps
  5632. points from the space you are adding to the parent coordinate
  5633. space. </para>
  5634. </param>
  5635. <param name="duplicateHandling">
  5636. <para> A
  5637. <see cref="!:T:Cognex.VisionPro.CogAddSpaceConstants" /> value that
  5638. specifies what do if the parent coordinate space already
  5639. contains an immediate child with the same name as
  5640. <paramref name="newSpaceName" />. The options are to return an
  5641. error, replace the transform of the named child, or do
  5642. nothing. </para>
  5643. </param>
  5644. <remarks>
  5645. <para> Adds a new user coordinate space to this tree.
  5646. You must specify the name of the parent space for the newly added
  5647. space, and supply a transformation that defines the relationship
  5648. between the parent space and the new space.</para>
  5649. </remarks>
  5650. <exception cref="!:T:System.ArgumentNullException">
  5651. <para>
  5652. <paramref name="parentFromNew" /> is null. </para>
  5653. </exception>
  5654. <exception cref="!:T:System.ArgumentOutOfRangeException">
  5655. <para> The <paramref name="duplicateHandling" /> value is not a
  5656. member of <see cref="!:T:Cognex.VisionPro.CogAddSpaceConstants" />.
  5657. </para>
  5658. </exception>
  5659. <exception cref="!:T:Cognex.VisionPro.Exceptions.CogSpaceTreeDuplicateChildNameException">
  5660. <para>
  5661. <paramref name="newSpaceName" /> is already a
  5662. child of <paramref name="parentSpaceName" /> and
  5663. the <paramref name="duplicateHandling" /> argument is
  5664. <see cref="!:T:Cognex.VisionPro.CogAddSpaceConstants">DuplicateIsError
  5665. </see>. </para>
  5666. </exception>
  5667. <exception cref="!:T:Cognex.VisionPro.Exceptions.CogSpaceTreeInvalidNameSyntaxException">
  5668. <para>
  5669. <paramref name="parentSpaceName" /> or
  5670. <paramref name="newSpaceName" />
  5671. is not a <see cref="!:u:Framework.Coordinates.Theory.CoordSpaceNames">legal
  5672. space name</see>. </para>
  5673. </exception>
  5674. <exception cref="!:T:Cognex.VisionPro.Exceptions.CogSpaceTreeNameNotUniqueException">
  5675. <para>
  5676. <paramref name="parentSpaceName" /> is a nonqualified space name
  5677. and more than one instance of it exists in this tree. </para>
  5678. </exception>
  5679. <exception cref="!:T:Cognex.VisionPro.Exceptions.CogSpaceTreeNameNotInTreeException">
  5680. <para>
  5681. <paramref name="parentSpaceName" /> does not exist in this tree.
  5682. </para>
  5683. </exception>
  5684. <event cref="!:E:Cognex.VisionPro3D.Cog3DCoordinateSpaceTree.SpaceAdded">
  5685. Fires when a coordinate space is added to this tree. </event>
  5686. </member>
  5687. <member name="M:Cognex.VisionPro3D.Cog3DCoordinateSpaceTree.VerifyChild(System.String,System.String,Cognex.VisionPro.CogSpaceTreePathnameConstants,System.Boolean,System.String@)">
  5688. <summary> Return true if the given childSpaceName is a direct or
  5689. indirect child of parentSpaceName. Otherwise, return false.
  5690. The formatted child name, or "", can be obtained through the
  5691. foundChildName output argument. </summary>
  5692. <param name="parentSpaceName">
  5693. <para> A valid nonqualified or
  5694. fully-qualified
  5695. <see cref="!:u:Framework.Coordinates.Theory.CoordSpaceNames">
  5696. name</see> that indicates the parent space. </para>
  5697. </param>
  5698. <param name="childSpaceName">
  5699. <para> A valid nonqualified or
  5700. fully-qualified
  5701. <see cref="!:u:Framework.Coordinates.Theory.CoordSpaceNames">
  5702. name</see> that indicates the child space to verify. </para>
  5703. </param>
  5704. <param name="pathnameFormat">
  5705. <para> A
  5706. <see cref="!:T:Cognex.VisionPro.CogSpaceTreePathnameConstants" /> value
  5707. that indicates how the returned name should be
  5708. formatted. </para>
  5709. </param>
  5710. <param name="childrenOnly">
  5711. <para> If false, the parent space is
  5712. considered a valid descendant of itself, which allows you to
  5713. find space names that are at or descended from the given parent
  5714. space name. If true, the parent space is not a valid descendant
  5715. of itself. </para>
  5716. </param>
  5717. <param name="foundChildName">
  5718. <para> If this method returns true,
  5719. <paramref name="foundChildName" /> contains the formatted child
  5720. space name. Otherwise, it contains "". </para>
  5721. </param>
  5722. <returns>
  5723. <para> True if the given <paramref name="childSpaceName" />
  5724. is a descendant of <paramref name="parentSpaceName" />;
  5725. otherwise, false. </para>
  5726. </returns>
  5727. <remarks>
  5728. <para> Returns true if the given
  5729. <paramref name="childSpaceName" /> is a descendant of
  5730. <paramref name="parentSpaceName" />. Otherwise, returns false. Both
  5731. spaces must exist in the tree. </para>
  5732. <para> If
  5733. <paramref name="childrenOnly" /> is true a coordinate
  5734. space will only be considered as child if it is a descendant of
  5735. the given parent space. In some applications, however, you may
  5736. need to test whether a space is a descendant of the given parent
  5737. <ITALIC>or</ITALIC> is the parent space itself. To do this, set the
  5738. <paramref name="childrenOnly" /> parameter to false. </para>
  5739. </remarks>
  5740. <exception cref="!:T:System.ArgumentOutOfRangeException">
  5741. <para> The <paramref name="pathnameFormat" /> value is not a member
  5742. of <see cref="!:T:Cognex.VisionPro.CogSpaceTreePathnameConstants" />.
  5743. </para>
  5744. </exception>
  5745. <exception cref="!:T:Cognex.VisionPro.Exceptions.CogSpaceTreeInvalidNameSyntaxException">
  5746. <para>
  5747. <paramref name="parentSpaceName" /> or
  5748. <paramref name="childSpaceName" />
  5749. is not a <see cref="!:u:Framework.Coordinates.Theory.CoordSpaceNames">legal
  5750. space name</see>. </para>
  5751. </exception>
  5752. <exception cref="!:T:Cognex.VisionPro.Exceptions.CogSpaceTreeNameNotUniqueException">
  5753. <para>
  5754. <paramref name="parentSpaceName" /> or
  5755. <paramref name="childSpaceName" /> is a nonqualified space name
  5756. and more than one instance of it exists in this tree. </para>
  5757. </exception>
  5758. <exception cref="!:T:Cognex.VisionPro.Exceptions.CogSpaceTreeNameNotInTreeException">
  5759. <para>
  5760. <paramref name="parentSpaceName" /> or
  5761. <paramref name="childSpaceName" /> does not exist in this tree.
  5762. </para>
  5763. </exception>
  5764. </member>
  5765. <member name="M:Cognex.VisionPro3D.Cog3DCoordinateSpaceTree.VerifyName(System.String,Cognex.VisionPro.CogSpaceTreePathnameConstants,System.String@)">
  5766. <summary> Return true if the given spaceName is a unique name in
  5767. this tree. Return false if spaceName cannot be found. The
  5768. formatted name, or "", can be obtained through the
  5769. foundName output argument. </summary>
  5770. <param name="spaceName">
  5771. <para> A valid nonqualified or
  5772. fully-qualified
  5773. <see cref="!:u:Framework.Coordinates.Theory.CoordSpaceNames">space
  5774. name</see> to find in this coordinate space tree. </para>
  5775. </param>
  5776. <param name="pathnameFormat">
  5777. <para> A
  5778. <see cref="!:T:Cognex.VisionPro.CogSpaceTreePathnameConstants" /> value
  5779. that indicates how the returned name should be
  5780. formatted. </para>
  5781. </param>
  5782. <param name="foundName">
  5783. <para> If this method returns true,
  5784. <paramref name="foundName" /> contains the formatted
  5785. space name. Otherwise, it contains "". </para>
  5786. </param>
  5787. <returns>
  5788. <para>True if the given <paramref name="spaceName" />
  5789. is unique in this tree. False if the name is not found in the
  5790. tree. </para>
  5791. </returns>
  5792. <remarks>
  5793. <para> You can use this method to verify that a given
  5794. space name is legal and exists in the coordinate space tree. It
  5795. returns true if the given <paramref name="spaceName" /> is a
  5796. unique name in this tree; false if <paramref name="spaceName" />
  5797. cannot be found.</para>
  5798. <para> This method is is similar to
  5799. <see cref="!:M:Cognex.VisionPro3D.Cog3DCoordinateSpaceTree.LookUpName(System.String,Cognex.VisionPro.CogSpaceTreePathnameConstants)" />,
  5800. however it does not generate an error if <paramref name="spaceName" />
  5801. does not exist in the tree. </para>
  5802. </remarks>
  5803. <exception cref="!:T:System.ArgumentOutOfRangeException">
  5804. <para> The <paramref name="pathnameFormat" /> value is not a member
  5805. of <see cref="!:T:Cognex.VisionPro.CogSpaceTreePathnameConstants" />.
  5806. </para>
  5807. </exception>
  5808. <exception cref="!:T:Cognex.VisionPro.Exceptions.CogSpaceTreeInvalidNameSyntaxException">
  5809. <para>
  5810. <paramref name="spaceName" />
  5811. is not a <see cref="!:u:Framework.Coordinates.Theory.CoordSpaceNames">legal
  5812. space name</see>. </para>
  5813. </exception>
  5814. <exception cref="!:T:Cognex.VisionPro.Exceptions.CogSpaceTreeNameNotUniqueException">
  5815. <para>
  5816. <paramref name="spaceName" /> is a nonqualified space name
  5817. and more than one instance of it exists in this tree. </para>
  5818. </exception>
  5819. </member>
  5820. <member name="M:Cognex.VisionPro3D.Cog3DCoordinateSpaceTree.FindNames(System.String)">
  5821. <summary> Find the given spaceName in this tree and return a
  5822. collection containing the fully-qualified pathname(s) that are
  5823. found. The collection may contain zero, one, or more items. </summary>
  5824. <param name="spaceName">
  5825. <para> A valid nonqualified or
  5826. fully-qualified
  5827. <see cref="!:u:Framework.Coordinates.Theory.CoordSpaceNames">space
  5828. name</see> to find in this coordinate space tree. </para>
  5829. </param>
  5830. <returns>
  5831. <para> A collection of space names; or an empty
  5832. collection if the given name does not exist in the tree.
  5833. </para>
  5834. </returns>
  5835. <remarks>
  5836. <para> Finds the given coordinate space name in this
  5837. tree and returns a collection containing zero or more
  5838. fully-qualified pathnames that are found. The returned
  5839. collection contains more than one space name only if the given
  5840. <paramref name="spaceName" /> is nonqualified and exists at
  5841. multiple locations within the coordinate space tree. </para>
  5842. <para> You can use this method to determine if a space name is
  5843. valid and exists in this tree, or to convert a nonqualified
  5844. space name to one or more fully-qualified space names. This
  5845. method is similar to
  5846. <see cref="!:M:Cognex.VisionPro3D.Cog3DCoordinateSpaceTree.LookUpName(System.String,Cognex.VisionPro.CogSpaceTreePathnameConstants)" />,
  5847. but it does not generate an error if the given space name
  5848. exists more than once in the tree, or does not
  5849. exist in the tree at all. </para>
  5850. </remarks>
  5851. <exception cref="!:T:Cognex.VisionPro.Exceptions.CogSpaceTreeInvalidNameSyntaxException">
  5852. <para>
  5853. <paramref name="spaceName" />
  5854. is not a <see cref="!:u:Framework.Coordinates.Theory.CoordSpaceNames">legal
  5855. space name</see>. </para>
  5856. </exception>
  5857. </member>
  5858. <member name="M:Cognex.VisionPro3D.Cog3DCoordinateSpaceTree.AllChildNames(System.String,Cognex.VisionPro.CogSpaceTreePathnameConstants,System.Boolean)">
  5859. <summary> Returns a collection of names that includes all the
  5860. children, grandchildren, great-grandchildren, etc. of the given
  5861. space. If there are no children, the collection will hold zero
  5862. items. </summary>
  5863. <param name="spaceName">
  5864. <para> A valid nonqualified or
  5865. fully-qualified
  5866. <see cref="!:u:Framework.Coordinates.Theory.CoordSpaceNames">space
  5867. name</see> to find in this coordinate space tree. </para>
  5868. </param>
  5869. <param name="pathnameFormat">
  5870. <para> A
  5871. <see cref="!:T:Cognex.VisionPro.CogSpaceTreePathnameConstants" /> value
  5872. that indicates how the returned name(s) should be
  5873. formatted. </para>
  5874. </param>
  5875. <param name="childrenOnly">
  5876. <para> If false, the supplied space
  5877. name is included as a separate item in the returned collection
  5878. of space names. If true, the supplied space name does not appear
  5879. as a collection item. </para>
  5880. </param>
  5881. <returns>
  5882. <para> A collection that contains a listing of
  5883. the child coordinate space names of the given space name. If no
  5884. children exist, the collection has no items. </para>
  5885. </returns>
  5886. <remarks>
  5887. <para> Returns a collection of names that includes all
  5888. the descendants of the given space. If no children exist and
  5889. <paramref name="childrenOnly" /> is true, the collection has no
  5890. items. </para>
  5891. </remarks>
  5892. <exception cref="!:T:System.ArgumentOutOfRangeException">
  5893. <para> The <paramref name="pathnameFormat" /> value is not a member
  5894. of <see cref="!:T:Cognex.VisionPro.CogSpaceTreePathnameConstants" />.
  5895. </para>
  5896. </exception>
  5897. <exception cref="!:T:Cognex.VisionPro.Exceptions.CogSpaceTreeInvalidNameSyntaxException">
  5898. <para>
  5899. <paramref name="spaceName" />
  5900. is not a <see cref="!:u:Framework.Coordinates.Theory.CoordSpaceNames">legal
  5901. space name</see>. </para>
  5902. </exception>
  5903. <exception cref="!:T:Cognex.VisionPro.Exceptions.CogSpaceTreeNameNotUniqueException">
  5904. <para>
  5905. <paramref name="spaceName" /> is a nonqualified space name
  5906. and more than one instance of it exists in this tree. </para>
  5907. </exception>
  5908. <exception cref="!:T:Cognex.VisionPro.Exceptions.CogSpaceTreeNameNotInTreeException">
  5909. <para>
  5910. <paramref name="spaceName" /> does not exist in this tree.
  5911. </para>
  5912. </exception>
  5913. </member>
  5914. <member name="M:Cognex.VisionPro3D.Cog3DCoordinateSpaceTree.ChildNames(System.String,Cognex.VisionPro.CogSpaceTreePathnameConstants)">
  5915. <summary> Returns a collection of names containing the given
  5916. space's immediate children. If there are no children, the
  5917. collection will hold zero items. </summary>
  5918. <param name="spaceName">
  5919. <para> A valid nonqualified or
  5920. fully-qualified
  5921. <see cref="!:u:Framework.Coordinates.Theory.CoordSpaceNames">space
  5922. name</see> to find in this coordinate space tree. </para>
  5923. </param>
  5924. <param name="pathnameFormat">
  5925. <para> A
  5926. <see cref="!:T:Cognex.VisionPro.CogSpaceTreePathnameConstants" /> value
  5927. that indicates how the returned name(s) should be
  5928. formatted. </para>
  5929. </param>
  5930. <returns>
  5931. <para> A collection of child space names, or an empty
  5932. collection if no child spaces exist for the given coordinate
  5933. space name. </para>
  5934. </returns>
  5935. <remarks>
  5936. <para>Returns a collection of names containing the
  5937. given space's immediate children. If no children exist, the
  5938. collection will hold zero items. </para>
  5939. </remarks>
  5940. <exception cref="!:T:System.ArgumentOutOfRangeException">
  5941. <para> The <paramref name="pathnameFormat" /> value is not a member
  5942. of <see cref="!:T:Cognex.VisionPro.CogSpaceTreePathnameConstants" />.
  5943. </para>
  5944. </exception>
  5945. <exception cref="!:T:Cognex.VisionPro.Exceptions.CogSpaceTreeInvalidNameSyntaxException">
  5946. <para>
  5947. <paramref name="spaceName" />
  5948. is not a <see cref="!:u:Framework.Coordinates.Theory.CoordSpaceNames">legal
  5949. space name</see>. </para>
  5950. </exception>
  5951. <exception cref="!:T:Cognex.VisionPro.Exceptions.CogSpaceTreeNameNotUniqueException">
  5952. <para>
  5953. <paramref name="spaceName" /> is a nonqualified space name
  5954. and more than one instance of it exists in this tree. </para>
  5955. </exception>
  5956. <exception cref="!:T:Cognex.VisionPro.Exceptions.CogSpaceTreeNameNotInTreeException">
  5957. <para>
  5958. <paramref name="spaceName" /> does not exist in this tree.
  5959. </para>
  5960. </exception>
  5961. </member>
  5962. <member name="M:Cognex.VisionPro3D.Cog3DCoordinateSpaceTree.ParentName(System.String,Cognex.VisionPro.CogSpaceTreePathnameConstants)">
  5963. <summary> Returns the name of the given space's parent. The
  5964. parent name for the root space is the empty name ("") because
  5965. the root space has no parent. </summary>
  5966. <param name="spaceName">
  5967. <para> A valid nonqualified or
  5968. fully-qualified
  5969. <see cref="!:u:Framework.Coordinates.Theory.CoordSpaceNames">space
  5970. name</see> to find in this coordinate space tree. </para>
  5971. </param>
  5972. <param name="pathnameFormat">
  5973. <para> A
  5974. <see cref="!:T:Cognex.VisionPro.CogSpaceTreePathnameConstants" /> value
  5975. that indicates how the returned name should be
  5976. formatted. </para>
  5977. </param>
  5978. <returns>
  5979. <para> The formatted parent space name. </para>
  5980. </returns>
  5981. <remarks>
  5982. <para> Returns the name of the given space's
  5983. parent. Because the root space has no parent, its parent space
  5984. name is the empty name string: "". </para>
  5985. </remarks>
  5986. <exception cref="!:T:System.ArgumentOutOfRangeException">
  5987. <para> The <paramref name="pathnameFormat" /> value is not a member
  5988. of <see cref="!:T:Cognex.VisionPro.CogSpaceTreePathnameConstants" />.
  5989. </para>
  5990. </exception>
  5991. <exception cref="!:T:Cognex.VisionPro.Exceptions.CogSpaceTreeInvalidNameSyntaxException">
  5992. <para>
  5993. <paramref name="spaceName" />
  5994. is not a <see cref="!:u:Framework.Coordinates.Theory.CoordSpaceNames">legal
  5995. space name</see>. </para>
  5996. </exception>
  5997. <exception cref="!:T:Cognex.VisionPro.Exceptions.CogSpaceTreeNameNotUniqueException">
  5998. <para>
  5999. <paramref name="spaceName" /> is a nonqualified space name
  6000. and more than one instance of it exists in this tree. </para>
  6001. </exception>
  6002. <exception cref="!:T:Cognex.VisionPro.Exceptions.CogSpaceTreeNameNotInTreeException">
  6003. <para>
  6004. <paramref name="spaceName" /> does not exist in this tree.
  6005. </para>
  6006. </exception>
  6007. </member>
  6008. <member name="M:Cognex.VisionPro3D.Cog3DCoordinateSpaceTree.LookUpName(System.String,Cognex.VisionPro.CogSpaceTreePathnameConstants)">
  6009. <summary> Looks up the given spaceName in this tree and
  6010. returns an appropriately formatted copy of the name. </summary>
  6011. <param name="spaceName">
  6012. <para> A valid nonqualified or
  6013. fully-qualified
  6014. <see cref="!:u:Framework.Coordinates.Theory.CoordSpaceNames">space
  6015. name</see> to find in this coordinate space tree. </para>
  6016. </param>
  6017. <param name="pathnameFormat">
  6018. <para> A
  6019. <see cref="!:T:Cognex.VisionPro.CogSpaceTreePathnameConstants" /> value
  6020. that indicates how the returned name should be
  6021. formatted. </para>
  6022. </param>
  6023. <returns>
  6024. <para> The formatted space name. </para>
  6025. </returns>
  6026. <remarks>
  6027. <para> Looks up the given coordinate space name in this
  6028. tree and returns an appropriately formatted copy of the
  6029. name. You can use this method to verify that a given space name
  6030. is valid and exists in the tree. This method is similar to
  6031. <see cref="!:M:Cognex.VisionPro3D.Cog3DCoordinateSpaceTree.FindNames(System.String)" />,
  6032. except that it requires that exactly one instance of the name
  6033. exist in the tree. </para>
  6034. </remarks>
  6035. <exception cref="!:T:System.ArgumentOutOfRangeException">
  6036. <para> The <paramref name="pathnameFormat" /> value is not a member
  6037. of <see cref="!:T:Cognex.VisionPro.CogSpaceTreePathnameConstants" />.
  6038. </para>
  6039. </exception>
  6040. <exception cref="!:T:Cognex.VisionPro.Exceptions.CogSpaceTreeInvalidNameSyntaxException">
  6041. <para>
  6042. <paramref name="spaceName" />
  6043. is not a <see cref="!:u:Framework.Coordinates.Theory.CoordSpaceNames">legal
  6044. space name</see>. </para>
  6045. </exception>
  6046. <exception cref="!:T:Cognex.VisionPro.Exceptions.CogSpaceTreeNameNotUniqueException">
  6047. <para>
  6048. <paramref name="spaceName" /> is a nonqualified space name
  6049. and more than one instance of it exists in this tree. </para>
  6050. </exception>
  6051. <exception cref="!:T:Cognex.VisionPro.Exceptions.CogSpaceTreeNameNotInTreeException">
  6052. <para>
  6053. <paramref name="spaceName" /> does not exist in this tree.
  6054. </para>
  6055. </exception>
  6056. </member>
  6057. <member name="M:Cognex.VisionPro3D.Cog3DCoordinateSpaceTree.ResolvePartialName(System.String,System.String)">
  6058. <summary> Use the given startingSpaceName to resolve any
  6059. ambiguity in nameToResolve, and return a name suitable for
  6060. lookup in this tree. Note that a partial name, like ".", is
  6061. ambiguous without a specified starting space. </summary>
  6062. <param name="startingSpaceName">
  6063. <para> The starting space name
  6064. used to resolve <paramref name="nameToResolve" />, if
  6065. <paramref name="nameToResolve" /> is a
  6066. partially-qualified coordinate space name. </para>
  6067. </param>
  6068. <param name="nameToResolve">
  6069. <para> The coordinate space name to
  6070. resolve. If <paramref name="nameToResolve" /> is a partially-qualified
  6071. name, this method resolves it using the
  6072. <paramref name="startingSpaceName" /> value. Otherwise, the
  6073. <paramref name="startingSpaceName" /> value is ignored and the
  6074. original <paramref name="nameToResolve" /> is returned. </para>
  6075. </param>
  6076. <returns>
  6077. <para>
  6078. <paramref name="nameToResolve" /> as a
  6079. nonqualified or fully-qualified pathname. </para>
  6080. </returns>
  6081. <remarks>
  6082. <para> Uses the given <paramref name="startingSpaceName" />
  6083. to resolve any ambiguity in <paramref name="nameToResolve" />,
  6084. and returns a name suitable for lookup in this tree. Note that a
  6085. <see cgnxAnchor="partiallyqualified_pq_space_names" cref="!:u:Framework.Coordinates.Theory.CoordSpaceNames">
  6086. partial name</see>, such as ".", is ambiguous without a specified
  6087. starting space name. </para>
  6088. <para> This method is the only
  6089. method of the coordinate space tree that can accept partially-qualified
  6090. space names. It will never return a partially-qualified space
  6091. name, but it may return a space name that is not unique, or one
  6092. that does not exist in this space tree. </para>
  6093. </remarks>
  6094. <exception cref="!:T:Cognex.VisionPro.Exceptions.CogSpaceTreeInvalidNameSyntaxException">
  6095. <para>
  6096. <paramref name="startingSpaceName" />
  6097. is not a <see cref="!:u:Framework.Coordinates.Theory.CoordSpaceNames">legal
  6098. space name</see>. </para>
  6099. </exception>
  6100. <exception cref="!:T:Cognex.VisionPro.Exceptions.CogSpaceTreeNameNotUniqueException">
  6101. <para>
  6102. <paramref name="startingSpaceName" /> is a nonqualified space name
  6103. and more than one instance of it exists in this tree. </para>
  6104. </exception>
  6105. <exception cref="!:T:Cognex.VisionPro.Exceptions.CogSpaceTreeNameNotInTreeException">
  6106. <para>
  6107. <paramref name="startingSpaceName" /> does not exist in this tree.
  6108. </para>
  6109. </exception>
  6110. </member>
  6111. <member name="P:Cognex.VisionPro3D.Cog3DCoordinateSpaceTree.RootName">
  6112. <summary> Returns/sets the name of the root coordinate space in
  6113. this tree. </summary>
  6114. <remarks>
  6115. <para> Returns or sets the root coordinate space name
  6116. for this tree. The new space name must meet the syntactic
  6117. requirements of a
  6118. <see cref="!:u:Framework.Coordinates.Theory.CoordSpaceNames">nonqualified
  6119. coordinate space name</see>, with the exception that you may
  6120. begin the name with any non-slash punctuation
  6121. character. </para>
  6122. <NOTE>Do not change the root name
  6123. of a tree attached to an image. Any tree that is or will be
  6124. attached to an image must have a
  6125. <see cref="!:P:Cognex.VisionPro3D.Cog3DCoordinateSpaceTree.RootName" />
  6126. value of "@" for VisionPro to function
  6127. properly.</NOTE>
  6128. <DEFAULT>@ (root space)</DEFAULT>
  6129. </remarks>
  6130. <exception cref="!:T:Cognex.VisionPro.Exceptions.CogSpaceTreeInvalidNameSyntaxException">
  6131. <para> The new name is not a
  6132. <see cref="!:u:Framework.Coordinates.Theory.CoordSpaceNames">legal
  6133. space name</see> for the root space. </para>
  6134. </exception>
  6135. <event cref="!:E:Cognex.VisionPro3D.Cog3DCoordinateSpaceTree.NameChanged">
  6136. Fires when the root name changes. </event>
  6137. </member>
  6138. <member name="M:Cognex.VisionPro3D.Cog3DCoordinateSpaceTree.Dispose">
  6139. <summary> Releases all resources used by this class instance. </summary>
  6140. <remarks>
  6141. <para> This method deterministically unhooks events
  6142. from any embedded trees that might live within this one and then
  6143. releases all resources used by this tree. It can be useful in
  6144. situations where you are finished with a coordinate space tree,
  6145. but are still using one of the trees embedded within it. </para>
  6146. <para> Do not attempt to access the tree after calling this
  6147. method. </para>
  6148. </remarks>
  6149. </member>
  6150. <member name="M:Cognex.VisionPro3D.Cog3DCoordinateSpaceTree.#ctor(Cognex.VisionPro3D.Cog3DCoordinateSpaceTree)">
  6151. <summary> Constructs a new instance of this class as a deep copy
  6152. of the given instance. </summary>
  6153. <param name="other"> The instance to copy from. </param>
  6154. </member>
  6155. <member name="M:Cognex.VisionPro3D.Cog3DCoordinateSpaceTree.#ctor">
  6156. <summary> Constructs a new instance of this class. </summary>
  6157. </member>
  6158. <member name="M:Cognex.VisionPro3D.Cog3DCoordinateSpaceTree.GetObjectData(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
  6159. <summary>
  6160. Populates the provided SerializationInfo with the data needed to
  6161. serialize the object.
  6162. </summary>
  6163. <param name="info">The SerializationInfo to populate with data.</param>
  6164. <param name="context">The destination for this serialization.</param>
  6165. </member>
  6166. <member name="M:Cognex.VisionPro3D.Cog3DCoordinateSpaceTree.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
  6167. <summary>
  6168. Constructs a new instance of this object from saved data.
  6169. </summary>
  6170. <param name="info">
  6171. The SerializationInfo that holds the saved object data.
  6172. </param>
  6173. <param name="context">
  6174. The standard StreamingContext argument.
  6175. </param>
  6176. </member>
  6177. <member name="E:Cognex.VisionPro3D.Cog3DCoordinateSpaceTree.TreeAdded">
  6178. <summary> Occurs after a new tree is added to this tree. </summary>
  6179. </member>
  6180. <member name="E:Cognex.VisionPro3D.Cog3DCoordinateSpaceTree.TransformChanged">
  6181. <summary> Occurs after a transform is changed in this tree. Note
  6182. that the meaning of any spaces descending from the changed
  6183. transform will also be altered. This event can be fired
  6184. in a variety of ways. For example: (1) by a call to the
  6185. <see cref="!:M:Cognex.VisionPro3D.Cog3DCoordinateSpaceTree.ChangeTransform(System.String,Cognex.VisionPro3D.ICog3DTransform)" />
  6186. method, or (2) by a call to the
  6187. <see cref="!:M:Cognex.VisionPro3D.Cog3DCoordinateSpaceTree.AddSpace(System.String,System.String,Cognex.VisionPro3D.ICog3DTransform,Cognex.VisionPro.CogAddSpaceConstants)" />
  6188. method that replaces an existing transform. </summary>
  6189. </member>
  6190. <member name="E:Cognex.VisionPro3D.Cog3DCoordinateSpaceTree.SubtreeMoved">
  6191. <summary> Occurs after a subtree is moved within this tree. </summary>
  6192. </member>
  6193. <member name="E:Cognex.VisionPro3D.Cog3DCoordinateSpaceTree.SubtreeDeleted">
  6194. <summary> Occurs after a subtree is deleted from this tree. </summary>
  6195. </member>
  6196. <member name="E:Cognex.VisionPro3D.Cog3DCoordinateSpaceTree.SpaceAdded">
  6197. <summary> Occurs after a new space is added to this tree. </summary>
  6198. </member>
  6199. <member name="E:Cognex.VisionPro3D.Cog3DCoordinateSpaceTree.NameChanged">
  6200. <summary> Occurs after a space name is changed in this tree. </summary>
  6201. </member>
  6202. <member name="T:Cognex.VisionPro3D.Cog3DCoordinateSpaceTree">
  6203. <summary> Tree of 3D coordinate spaces and the mappings between
  6204. them. </summary>
  6205. <remarks>
  6206. <para> A 3D coordinate space tree is associated with each
  6207. VisionPro range image. </para>
  6208. <para> In VisionPro, you can define
  6209. and name your own coordinate spaces. Each user space is
  6210. defined, relative to an existing space, by a three-dimensional
  6211. transform. The coordinate space tree contains a node for each
  6212. coordinate space associated with an image, and maintains
  6213. information about the transform that produced it. VisionPro also
  6214. maintains a
  6215. <see cgnxAnchor="root_space" cref="!:u:Framework.Coordinates.Theory.CoordSpaces">
  6216. root space</see> based on the pixels in the acquired image. </para>
  6217. <para> The methods and properties in this interface let you obtain
  6218. the 3D transformations that map points between any pair of
  6219. coordinate spaces in the space tree. They also allow you to
  6220. examine, add to, or rearrange the space tree.</para>
  6221. <para>Many of
  6222. the methods use a client-specified coordinate space name to find a
  6223. coordinate space within the tree. You can supply any valid
  6224. <see cgnxAnchor="nonqualified_nq_space_names" cref="!:u:Framework.Coordinates.Theory.CoordSpaceNames">
  6225. nonqualified (NQ)</see> or
  6226. <see cgnxAnchor="fullyqualified_fq_space_names" cref="!:u:Framework.Coordinates.Theory.CoordSpaceNames">
  6227. fully-qualified (FQ)</see> pathname. If you supply a NQ name, the
  6228. method searches the coordinate space tree for instances of that
  6229. name. The NQ name must occur exactly once within the
  6230. tree.</para>
  6231. <para>In addition, several methods return one or more
  6232. coordinate space names. You can control the format (nonqualified,
  6233. partially-qualified, or fully-qualified) of the returned names by
  6234. supplying a <see cref="!:T:Cognex.VisionPro.CogSpaceTreePathnameConstants" />
  6235. value. If a partially-qualified (PQ) name is returned, it begins
  6236. with either "." or "..", and specifies a space relative to the
  6237. first space name argument of the method. </para>
  6238. </remarks>
  6239. </member>
  6240. <member name="M:Cognex.VisionPro3D.Cog3DTransformComposed.Canonize(System.Boolean)">
  6241. <summary>
  6242. Get the canonical form of this composed transform. This is the mathematically equivalent form that
  6243. has the fewest number of transforms. If <paramref name="typeSimplify" /> is True,
  6244. the returned type may be reduced to a type simpler than this.
  6245. </summary>
  6246. <param name="typeSimplify">
  6247. Specify False to force this function to return a transformation of type
  6248. Cog3DTransformComposed. If you specify True, then the returned transformation may be of a simpler type.
  6249. </param>
  6250. <returns>
  6251. The returned canonical transformation, it might be Cog3DTransformComposed, or Cog3DTransformRotation, or Cog3DTransformRigid, or Cog3DTransformLinear
  6252. </returns>
  6253. <remarks>
  6254. The transform reduction is based on checking each pair of adjacent transforms in the container, and see whether to merge them into one
  6255. transform:
  6256. <list type="bullet"><item> [Cog3DTransformRotation, Cog3DTransformRotation] becomes [Cog3DTransformRotation] </item><item> [Cog3DTransformRigid, Cog3DTransformRigid] becomes [Cog3DTransformRigid] </item><item> [Cog3DTransformLinear, Cog3DTransformLinear] becomes [Cog3DTransformLinear] </item><item> [Cog3DTransformRigid, Cog3DTransformRotation] becomes [Cog3DTransformRigid] </item><item> [Cog3DTransformLinear, Cog3DTransformRotation] becomes [Cog3DTransformLinear] </item><item> [Cog3DTransformRotation, Cog3DTransformRigid] becomes [Cog3DTransformRigid] </item><item> [Cog3DTransformRotation, Cog3DTransformLinear] becomes [Cog3DTransformLinear] </item><item> [Cog3DTransformRigid, Cog3DTransformLinear] becomes [Cog3DTransformLinear] </item><item> [Cog3DTransformLinear, Cog3DTransformRigid] becomes [Cog3DTransformLinear] </item></list></remarks>
  6257. </member>
  6258. <member name="M:Cognex.VisionPro3D.Cog3DTransformComposed.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
  6259. <inheritdoc cref="M:Cognex.VisionPro3D.ICog3DBase.SerializationConstructor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)" />
  6260. </member>
  6261. <member name="M:Cognex.VisionPro3D.Cog3DTransformComposed.op_Multiply(Cognex.VisionPro3D.Cog3DTransformComposed,Cognex.VisionPro3D.Cog3DTransformComposed)">
  6262. <summary>
  6263. Operator for composing one composed transform and another composed transform.
  6264. Note that the composing order is
  6265. <paramref name="composed" /> * <paramref name="rhs" />.
  6266. <para>
  6267. The returned transform is always the canonical representation
  6268. of the composed transform. Therefore, the returned transform might be
  6269. of a simpler type.
  6270. </para></summary>
  6271. <param name="composed">
  6272. One 3D composed transform. May not be null.
  6273. </param>
  6274. <param name="rhs">
  6275. Another composed transform to compose with. May not be null.
  6276. </param>
  6277. <returns>
  6278. The composed transform, and it might be of a simpler type.
  6279. </returns>
  6280. <exception cref="T:System.ArgumentNullException">
  6281. If any input argument is null.
  6282. </exception>
  6283. </member>
  6284. <member name="M:Cognex.VisionPro3D.Cog3DTransformComposed.Compose(Cognex.VisionPro3D.ICog3DTransform)">
  6285. <summary>
  6286. Compose this composed transform and another transform.
  6287. Note that composing is from left to right: this * <paramref name="rhs" /><para>
  6288. The returned transform is always the canonical representation
  6289. of the composed transform. Therefore, the returned transform might be
  6290. of a simpler type.
  6291. </para></summary>
  6292. <param name="rhs">
  6293. The transform to compose with. May not be null.
  6294. </param>
  6295. <returns>
  6296. The composed transform, and it might be of a simpler type.
  6297. </returns>
  6298. <exception cref="T:System.ArgumentNullException">
  6299. If the input argument is null.
  6300. </exception>
  6301. </member>
  6302. <member name="M:Cognex.VisionPro3D.Cog3DTransformComposed.ToString">
  6303. <inheritdoc cref="M:Cognex.VisionPro3D.ICog3DBase.ToString" />
  6304. </member>
  6305. <member name="M:Cognex.VisionPro3D.Cog3DTransformComposed.Inverse">
  6306. <summary>
  6307. Compute the inverse transform of this transform.
  6308. </summary>
  6309. <returns>
  6310. The inverse transform, and it is always the canonical representation
  6311. of the inverse of this transform. Therefore, the returned inverse transform might be
  6312. of a simpler type.
  6313. </returns>
  6314. </member>
  6315. <member name="M:Cognex.VisionPro3D.Cog3DTransformComposed.ComposeBase(Cognex.VisionPro3D.ICog3DTransform)">
  6316. <inheritdoc />
  6317. </member>
  6318. <member name="M:Cognex.VisionPro3D.Cog3DTransformComposed.CopyBase">
  6319. <inheritdoc />
  6320. </member>
  6321. <member name="M:Cognex.VisionPro3D.Cog3DTransformComposed.InverseBase">
  6322. <inheritdoc />
  6323. </member>
  6324. <member name="M:Cognex.VisionPro3D.Cog3DTransformComposed.MapPoints(Cognex.VisionPro3D.Cog3DVect3Collection)">
  6325. <inheritdoc />
  6326. </member>
  6327. <member name="M:Cognex.VisionPro3D.Cog3DTransformComposed.MapPoint(Cognex.VisionPro3D.Cog3DVect3)">
  6328. <inheritdoc />
  6329. </member>
  6330. <member name="P:Cognex.VisionPro3D.Cog3DTransformComposed.Count">
  6331. <summary>
  6332. Gets the number of transforms contained in this composed transform's sequence.
  6333. </summary>
  6334. <value>
  6335. The number of transforms contained in this composed transform's sequence.
  6336. </value>
  6337. </member>
  6338. <member name="P:Cognex.VisionPro3D.Cog3DTransformComposed.Linear">
  6339. <inheritdoc />
  6340. </member>
  6341. <member name="M:Cognex.VisionPro3D.Cog3DTransformComposed.Finalize">
  6342. <inheritdoc cref="M:Cognex.VisionPro3D.ICog3DBase.FinalizerForThisClass" />
  6343. </member>
  6344. <member name="M:Cognex.VisionPro3D.Cog3DTransformComposed.Dispose">
  6345. <inheritdoc cref="M:Cognex.VisionPro3D.ICog3DBase.DestructorForThisClass" />
  6346. </member>
  6347. <member name="M:Cognex.VisionPro3D.Cog3DTransformComposed.#ctor(Cognex.VisionPro3D.Cog3DTransformComposed)">
  6348. <inheritdoc cref="M:Cognex.VisionPro3D.ICog3DBase.DeepCopyConstructorForThisClass(System.Object)" />
  6349. </member>
  6350. <member name="M:Cognex.VisionPro3D.Cog3DTransformComposed.#ctor">
  6351. <summary>
  6352. Construct this default (identity transform) Cog3DTransformComposed.
  6353. </summary>
  6354. </member>
  6355. <member name="T:Cognex.VisionPro3D.Cog3DTransformComposed">
  6356. <summary>
  6357. This is the class for 3D composed transform which can contain transforms of different types.
  6358. The composed transform maps points through all its contained transformations (from 'Right' to 'Left'),
  6359. and thus acts as their composition.
  6360. <para> Note that this class is immutable - it may not be changed once
  6361. it has been constructed. </para></summary>
  6362. </member>
  6363. <member name="M:Cognex.VisionPro3D.Cog3DTransformLinear.GetObjectData(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
  6364. <inheritdoc cref="M:Cognex.VisionPro3D.ICog3DBase.GetObjectData(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)" />
  6365. </member>
  6366. <member name="M:Cognex.VisionPro3D.Cog3DTransformLinear.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
  6367. <inheritdoc cref="M:Cognex.VisionPro3D.ICog3DBase.SerializationConstructor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)" />
  6368. </member>
  6369. <member name="M:Cognex.VisionPro3D.Cog3DTransformLinear.RealEqual(Cognex.VisionPro3D.Cog3DTransformLinear,Cognex.VisionPro3D.Cog3DTransformLinear,System.Double)">
  6370. <inheritdoc cref="M:Cognex.VisionPro3D.ICog3DBase.RealEqual(System.Object,System.Object,System.Double)" />
  6371. </member>
  6372. <member name="M:Cognex.VisionPro3D.Cog3DTransformLinear.op_Multiply(Cognex.VisionPro3D.Cog3DTransformRigid,Cognex.VisionPro3D.Cog3DTransformLinear)">
  6373. <summary>
  6374. Operator for composing one rigid transform and one linear transform.
  6375. Note that the composing order is
  6376. <paramref name="rigid" /> * <paramref name="linear" />.
  6377. </summary>
  6378. <param name="rigid">
  6379. One 3D rigid transform. May not be null.
  6380. </param>
  6381. <param name="linear">
  6382. One 3D linear transform to compose with. May not be null.
  6383. </param>
  6384. <returns>
  6385. The composed linear transform.
  6386. </returns>
  6387. <exception cref="T:System.ArgumentNullException">
  6388. If any input argument is null.
  6389. </exception>
  6390. </member>
  6391. <member name="M:Cognex.VisionPro3D.Cog3DTransformLinear.op_Multiply(Cognex.VisionPro3D.Cog3DTransformLinear,Cognex.VisionPro3D.Cog3DTransformRigid)">
  6392. <summary>
  6393. Operator for composing one linear transform and one rigid transform.
  6394. Note that the composing order is
  6395. <paramref name="linear" /> * <paramref name="rigid" />.
  6396. </summary>
  6397. <param name="linear">
  6398. One 3D linear transform. May not be null.
  6399. </param>
  6400. <param name="rigid">
  6401. One 3D rigid transform to compose with. May not be null.
  6402. </param>
  6403. <returns>
  6404. The composed linear transform.
  6405. </returns>
  6406. <exception cref="T:System.ArgumentNullException">
  6407. If any input argument is null.
  6408. </exception>
  6409. </member>
  6410. <member name="M:Cognex.VisionPro3D.Cog3DTransformLinear.op_Multiply(Cognex.VisionPro3D.Cog3DTransformLinear,Cognex.VisionPro3D.Cog3DTransformLinear)">
  6411. <summary>
  6412. Operator for composing one linear transform and another linear transform.
  6413. Note that the composing order is
  6414. <paramref name="linear" /> * <paramref name="rhs" />.
  6415. </summary>
  6416. <param name="linear">
  6417. One 3D linear transform. May not be null.
  6418. </param>
  6419. <param name="rhs">
  6420. Another 3D linear transform to compose with. May not be null.
  6421. </param>
  6422. <returns>
  6423. The composed linear transform.
  6424. </returns>
  6425. <exception cref="T:System.ArgumentNullException">
  6426. If any input argument is null.
  6427. </exception>
  6428. </member>
  6429. <member name="M:Cognex.VisionPro3D.Cog3DTransformLinear.Compose(Cognex.VisionPro3D.Cog3DTransformLinear)">
  6430. <summary>
  6431. Compose this linear transform and another linear transform.
  6432. Note that composing is from left to right: this * <paramref name="rhs" /></summary>
  6433. <param name="rhs">
  6434. The linear transform to compose with. May not be null.
  6435. </param>
  6436. <returns>
  6437. The composed linear transform.
  6438. </returns>
  6439. <exception cref="T:System.ArgumentNullException">
  6440. If the input argument is null.
  6441. </exception>
  6442. </member>
  6443. <member name="M:Cognex.VisionPro3D.Cog3DTransformLinear.ToString">
  6444. <inheritdoc cref="M:Cognex.VisionPro3D.ICog3DBase.ToString" />
  6445. </member>
  6446. <member name="M:Cognex.VisionPro3D.Cog3DTransformLinear.Inverse">
  6447. <summary>
  6448. Compute the inverse transform of this transform.
  6449. </summary>
  6450. <returns>
  6451. The inverse transform.
  6452. </returns>
  6453. </member>
  6454. <member name="M:Cognex.VisionPro3D.Cog3DTransformLinear.op_Multiply(Cognex.VisionPro3D.Cog3DTransformLinear,Cognex.VisionPro3D.Cog3DVect3)">
  6455. <summary>
  6456. Operator for mapping a 3D point using the specified 3D linear transform.
  6457. The definition is: <paramref name="linear" /> * <paramref name="point3D" />.
  6458. </summary>
  6459. <param name="linear">
  6460. The 3D linear transform used for mapping. May not be null.
  6461. </param>
  6462. <param name="point3D">
  6463. The 3D point to map.
  6464. </param>
  6465. <returns>
  6466. The mapped point.
  6467. </returns>
  6468. <exception cref="T:System.ArgumentNullException">
  6469. If <paramref name="linear" /> is null.
  6470. </exception>
  6471. </member>
  6472. <member name="M:Cognex.VisionPro3D.Cog3DTransformLinear.InverseBase">
  6473. <inheritdoc />
  6474. </member>
  6475. <member name="M:Cognex.VisionPro3D.Cog3DTransformLinear.InvMapVectors(Cognex.VisionPro3D.Cog3DVect3Collection)">
  6476. <summary>
  6477. Map a collection of 3D vectors using the inverse transform of this transform, i.e. use only the matrix part of
  6478. the inverse transform in mapping.
  6479. </summary>
  6480. <param name="vectors3D">
  6481. The collection of 3D vectors to map using the inverse transform of this transform. May not be null.
  6482. </param>
  6483. <returns>
  6484. A collection holding the inversely mapped vectors.
  6485. </returns>
  6486. <exception cref="T:System.ArgumentNullException">
  6487. If the input argument is null.
  6488. </exception>
  6489. </member>
  6490. <member name="M:Cognex.VisionPro3D.Cog3DTransformLinear.InvMapVector(Cognex.VisionPro3D.Cog3DVect3)">
  6491. <summary>
  6492. Map a 3D vector using the inverse transform of this transform, i.e. map the given vector
  6493. using only the matrix part of the inverse transform.
  6494. </summary>
  6495. <param name="vector3D">
  6496. The 3D vector to map using the inverse transform of this transform.
  6497. </param>
  6498. <returns>
  6499. The inversely mapped vector.
  6500. </returns>
  6501. </member>
  6502. <member name="M:Cognex.VisionPro3D.Cog3DTransformLinear.MapVectors(Cognex.VisionPro3D.Cog3DVect3Collection)">
  6503. <summary>
  6504. Map a collection of 3D vectors using this transform, i.e., only use the matrix part in mapping.
  6505. </summary>
  6506. <param name="vectors3D">
  6507. The collection of 3D vectors to map using this transform. May not be null.
  6508. </param>
  6509. <returns>
  6510. A collection holding the mapped vectors.
  6511. </returns>
  6512. <exception cref="T:System.ArgumentNullException">
  6513. If the input argument is null.
  6514. </exception>
  6515. </member>
  6516. <member name="M:Cognex.VisionPro3D.Cog3DTransformLinear.MapVector(Cognex.VisionPro3D.Cog3DVect3)">
  6517. <summary>
  6518. Map a 3D Vector using this transform.
  6519. This corresponds to map the vector only using the matrix part of this transform.
  6520. </summary>
  6521. <param name="vector3D">
  6522. The 3D vector to map using this transform.
  6523. </param>
  6524. <returns>
  6525. The mapped vector.
  6526. </returns>
  6527. </member>
  6528. <member name="M:Cognex.VisionPro3D.Cog3DTransformLinear.InvMapPoints(Cognex.VisionPro3D.Cog3DVect3Collection)">
  6529. <summary>
  6530. Map a collection of 3D points using the inverse transform of this transform.
  6531. </summary>
  6532. <param name="points3D">
  6533. The collection of 3D points to map using the inverse transform of this transform. May not be null.
  6534. </param>
  6535. <returns>
  6536. A collection holding the inversely mapped points.
  6537. </returns>
  6538. <exception cref="T:System.ArgumentNullException">
  6539. If the input argument is null.
  6540. </exception>
  6541. </member>
  6542. <member name="M:Cognex.VisionPro3D.Cog3DTransformLinear.InvMapPoint(Cognex.VisionPro3D.Cog3DVect3)">
  6543. <summary>
  6544. Map a 3D point using the inverse transform of this transform.
  6545. </summary>
  6546. <param name="point3D">
  6547. The 3D point to map using the inverse transform of this transform.
  6548. </param>
  6549. <returns>
  6550. The inversely mapped point.
  6551. </returns>
  6552. </member>
  6553. <member name="P:Cognex.VisionPro3D.Cog3DTransformLinear.Linear">
  6554. <inheritdoc />
  6555. </member>
  6556. <member name="M:Cognex.VisionPro3D.Cog3DTransformLinear.ComposeBase(Cognex.VisionPro3D.ICog3DTransform)">
  6557. <inheritdoc />
  6558. </member>
  6559. <member name="M:Cognex.VisionPro3D.Cog3DTransformLinear.CopyBase">
  6560. <inheritdoc />
  6561. </member>
  6562. <member name="M:Cognex.VisionPro3D.Cog3DTransformLinear.MapPoints(Cognex.VisionPro3D.Cog3DVect3Collection)">
  6563. <inheritdoc />
  6564. </member>
  6565. <member name="M:Cognex.VisionPro3D.Cog3DTransformLinear.MapPoint(Cognex.VisionPro3D.Cog3DVect3)">
  6566. <inheritdoc />
  6567. </member>
  6568. <member name="P:Cognex.VisionPro3D.Cog3DTransformLinear.IsIdentity">
  6569. <summary>
  6570. Gets whether this transform is identity.
  6571. </summary>
  6572. <value>
  6573. True if this 3D linear transform is identity; False otherwise.
  6574. </value>
  6575. </member>
  6576. <member name="P:Cognex.VisionPro3D.Cog3DTransformLinear.Translation">
  6577. <summary>
  6578. Gets the translation of this linear transform.
  6579. </summary>
  6580. <value>
  6581. The translation part of this linear transform.
  6582. </value>
  6583. </member>
  6584. <member name="M:Cognex.VisionPro3D.Cog3DTransformLinear.GetMatrix">
  6585. <summary>
  6586. Get a copy of the matrix part of this linear transform.
  6587. </summary>
  6588. <returns>
  6589. A copy of the matrix part of this linear transform.
  6590. </returns>
  6591. </member>
  6592. <member name="M:Cognex.VisionPro3D.Cog3DTransformLinear.Finalize">
  6593. <inheritdoc cref="M:Cognex.VisionPro3D.ICog3DBase.FinalizerForThisClass" />
  6594. </member>
  6595. <member name="M:Cognex.VisionPro3D.Cog3DTransformLinear.Dispose">
  6596. <inheritdoc cref="M:Cognex.VisionPro3D.ICog3DBase.DestructorForThisClass" />
  6597. </member>
  6598. <member name="M:Cognex.VisionPro3D.Cog3DTransformLinear.#ctor(Cognex.VisionPro3D.Cog3DMatrix3x3,Cognex.VisionPro3D.Cog3DVect3)">
  6599. <summary>
  6600. Construct this Cog3DTransformLinear using 3x3 matrix and translation.
  6601. </summary>
  6602. <param name="matrix">
  6603. The 3x3 matrix. May not be null.
  6604. </param>
  6605. <param name="translation">
  6606. The translation part of the linear transform.
  6607. </param>
  6608. <exception cref="T:System.ArgumentNullException">
  6609. If <paramref name="matrix" /> is null.
  6610. </exception>
  6611. </member>
  6612. <member name="M:Cognex.VisionPro3D.Cog3DTransformLinear.#ctor(Cognex.VisionPro3D.Cog3DTransformLinear)">
  6613. <inheritdoc cref="M:Cognex.VisionPro3D.ICog3DBase.DeepCopyConstructorForThisClass(System.Object)" />
  6614. </member>
  6615. <member name="M:Cognex.VisionPro3D.Cog3DTransformLinear.#ctor">
  6616. <summary>
  6617. Construct this default (identity transform) Cog3DTransformLinear.
  6618. </summary>
  6619. </member>
  6620. <member name="T:Cognex.VisionPro3D.Cog3DTransformLinear">
  6621. <summary>
  6622. This is the class for 3D linear (affine) transform. A 3D linear transform has
  6623. rotation, translation, scale, and shear. It contains a 3x3 matrix part and a 3D translation part.
  6624. <para> Note that this class is immutable - it may not be changed once
  6625. it has been constructed. </para></summary>
  6626. </member>
  6627. <member name="M:Cognex.VisionPro3D.Cog3DTransformRigid.GetObjectData(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
  6628. <inheritdoc cref="M:Cognex.VisionPro3D.ICog3DBase.GetObjectData(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)" />
  6629. </member>
  6630. <member name="M:Cognex.VisionPro3D.Cog3DTransformRigid.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
  6631. <inheritdoc cref="M:Cognex.VisionPro3D.ICog3DBase.SerializationConstructor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)" />
  6632. </member>
  6633. <member name="P:Cognex.VisionPro3D.Cog3DTransformRigid.Linear">
  6634. <inheritdoc />
  6635. </member>
  6636. <member name="M:Cognex.VisionPro3D.Cog3DTransformRigid.ComposeBase(Cognex.VisionPro3D.ICog3DTransform)">
  6637. <inheritdoc />
  6638. </member>
  6639. <member name="M:Cognex.VisionPro3D.Cog3DTransformRigid.CopyBase">
  6640. <inheritdoc />
  6641. </member>
  6642. <member name="M:Cognex.VisionPro3D.Cog3DTransformRigid.RealEqual(Cognex.VisionPro3D.Cog3DTransformRigid,Cognex.VisionPro3D.Cog3DTransformRigid,System.Double)">
  6643. <inheritdoc cref="M:Cognex.VisionPro3D.ICog3DBase.RealEqual(System.Object,System.Object,System.Double)" />
  6644. </member>
  6645. <member name="M:Cognex.VisionPro3D.Cog3DTransformRigid.LoadFromCvlArchive(System.String)">
  6646. <summary>
  6647. Load a list of transforms from a CVL archive.
  6648. The purpose of this function is to provide access to transforms stored from legacy 3DLocate tool.
  6649. </summary>
  6650. <param name="archiveName">
  6651. The name of the CVL archive
  6652. </param>
  6653. <returns>
  6654. A list containing the loaded Transforms.
  6655. </returns>
  6656. <remarks>
  6657. This method is for Cognex internal usage only.
  6658. </remarks>
  6659. </member>
  6660. <member name="M:Cognex.VisionPro3D.Cog3DTransformRigid.op_Multiply(Cognex.VisionPro3D.Cog3DTransformRigid,Cognex.VisionPro3D.Cog3DTransformRigid)">
  6661. <summary>
  6662. Operator for composing one rigid transform and another rigid transform.
  6663. Note that the composing order is
  6664. <paramref name="rigid" /> * <paramref name="rhs" />.
  6665. </summary>
  6666. <param name="rigid">
  6667. One 3D rigid transform. May not be null.
  6668. </param>
  6669. <param name="rhs">
  6670. Another rigid transform to compose with. May not be null.
  6671. </param>
  6672. <returns>
  6673. The composed rigid transform.
  6674. </returns>
  6675. <exception cref="T:System.ArgumentNullException">
  6676. If any input argument is null.
  6677. </exception>
  6678. </member>
  6679. <member name="M:Cognex.VisionPro3D.Cog3DTransformRigid.Compose(Cognex.VisionPro3D.Cog3DTransformRigid)">
  6680. <summary>
  6681. Compose this rigid transform and another rigid transform.
  6682. Note that composing is from left to right: this * <paramref name="rhs" /></summary>
  6683. <param name="rhs">
  6684. The rigid transform to compose with. May not be null.
  6685. </param>
  6686. <returns>
  6687. The composed rigid transform.
  6688. </returns>
  6689. <exception cref="T:System.ArgumentNullException">
  6690. If the input argument is null.
  6691. </exception>
  6692. </member>
  6693. <member name="M:Cognex.VisionPro3D.Cog3DTransformRigid.ToString">
  6694. <inheritdoc cref="M:Cognex.VisionPro3D.ICog3DBase.ToString" />
  6695. </member>
  6696. <member name="M:Cognex.VisionPro3D.Cog3DTransformRigid.Inverse">
  6697. <summary>
  6698. Compute the inverse transform of this transform.
  6699. </summary>
  6700. <returns>
  6701. The inverse transform.
  6702. </returns>
  6703. </member>
  6704. <member name="M:Cognex.VisionPro3D.Cog3DTransformRigid.op_Multiply(Cognex.VisionPro3D.Cog3DTransformRigid,Cognex.VisionPro3D.Cog3DVect3)">
  6705. <summary>
  6706. Operator for mapping a 3D point using the specified 3D rigid transform.
  6707. The definition is: <paramref name="rigid" /> * <paramref name="point3D" />.
  6708. </summary>
  6709. <param name="rigid">
  6710. The 3D rigid transform used for mapping. May not be null.
  6711. </param>
  6712. <param name="point3D">
  6713. The 3D point to map.
  6714. </param>
  6715. <returns>
  6716. The mapped point.
  6717. </returns>
  6718. <exception cref="T:System.ArgumentNullException">
  6719. If <paramref name="rigid" /> is null.
  6720. </exception>
  6721. </member>
  6722. <member name="M:Cognex.VisionPro3D.Cog3DTransformRigid.InverseBase">
  6723. <inheritdoc />
  6724. </member>
  6725. <member name="M:Cognex.VisionPro3D.Cog3DTransformRigid.InvMapVectors(Cognex.VisionPro3D.Cog3DVect3Collection)">
  6726. <summary>
  6727. Map a collection of 3D vectors using the inverse transform of this transform, i.e. rotate the given vectors
  6728. using the inverse transform.
  6729. </summary>
  6730. <param name="vectors3D">
  6731. The collection of 3D vectors to map using the inverse transform of this transform. May not be null.
  6732. </param>
  6733. <returns>
  6734. A collection holding the inversely mapped vectors.
  6735. </returns>
  6736. <exception cref="T:System.ArgumentNullException">
  6737. If the input argument is null.
  6738. </exception>
  6739. </member>
  6740. <member name="M:Cognex.VisionPro3D.Cog3DTransformRigid.InvMapVector(Cognex.VisionPro3D.Cog3DVect3)">
  6741. <summary>
  6742. Map a 3D vector using the inverse transform of this transform, i.e. rotate the given vector
  6743. using the inverse transform.
  6744. </summary>
  6745. <param name="vector3D">
  6746. The 3D vector to map using the inverse transform of this transform.
  6747. </param>
  6748. <returns>
  6749. The inversely mapped vector.
  6750. </returns>
  6751. </member>
  6752. <member name="M:Cognex.VisionPro3D.Cog3DTransformRigid.MapVectors(Cognex.VisionPro3D.Cog3DVect3Collection)">
  6753. <summary>
  6754. Map a collection of 3D vectors using this transform, i.e., rotate the given vectors.
  6755. </summary>
  6756. <param name="vectors3D">
  6757. The collection of 3D vectors to map using this transform. May not be null.
  6758. </param>
  6759. <returns>
  6760. A collection holding the mapped vectors.
  6761. </returns>
  6762. <exception cref="T:System.ArgumentNullException">
  6763. If the input argument is null.
  6764. </exception>
  6765. </member>
  6766. <member name="M:Cognex.VisionPro3D.Cog3DTransformRigid.MapVector(Cognex.VisionPro3D.Cog3DVect3)">
  6767. <summary>
  6768. Map a 3D Vector using this transform.
  6769. This corresponds to rotating the vector using the rotation part of this transform.
  6770. </summary>
  6771. <param name="vector3D">
  6772. The 3D vector to map using this transform.
  6773. </param>
  6774. <returns>
  6775. The mapped vector.
  6776. </returns>
  6777. </member>
  6778. <member name="M:Cognex.VisionPro3D.Cog3DTransformRigid.InvMapPoints(Cognex.VisionPro3D.Cog3DVect3Collection)">
  6779. <summary>
  6780. Map a collection of 3D points using the inverse transform of this transform.
  6781. </summary>
  6782. <param name="points3D">
  6783. The collection of 3D points to map using the inverse transform of this transform. May not be null.
  6784. </param>
  6785. <returns>
  6786. A collection holding the inversely mapped points.
  6787. </returns>
  6788. <exception cref="T:System.ArgumentNullException">
  6789. If the input argument is null.
  6790. </exception>
  6791. </member>
  6792. <member name="M:Cognex.VisionPro3D.Cog3DTransformRigid.InvMapPoint(Cognex.VisionPro3D.Cog3DVect3)">
  6793. <summary>
  6794. Map a 3D point using the inverse transform of this transform.
  6795. </summary>
  6796. <param name="point3D">
  6797. The 3D point to map using the inverse transform of this transform.
  6798. </param>
  6799. <returns>
  6800. The inversely mapped point.
  6801. </returns>
  6802. </member>
  6803. <member name="M:Cognex.VisionPro3D.Cog3DTransformRigid.MapPoints(Cognex.VisionPro3D.Cog3DVect3Collection)">
  6804. <inheritdoc />
  6805. </member>
  6806. <member name="M:Cognex.VisionPro3D.Cog3DTransformRigid.MapPoint(Cognex.VisionPro3D.Cog3DVect3)">
  6807. <inheritdoc />
  6808. </member>
  6809. <member name="P:Cognex.VisionPro3D.Cog3DTransformRigid.IsIdentity">
  6810. <summary>
  6811. Gets whether this transform is identity.
  6812. </summary>
  6813. <value>
  6814. True if this 3D rigid transform is identity; False otherwise.
  6815. </value>
  6816. </member>
  6817. <member name="P:Cognex.VisionPro3D.Cog3DTransformRigid.Translation">
  6818. <summary>
  6819. Gets the translation of this rigid transform.
  6820. </summary>
  6821. <value>
  6822. The translation part of this rigid transform.
  6823. </value>
  6824. </member>
  6825. <member name="P:Cognex.VisionPro3D.Cog3DTransformRigid.Rotation">
  6826. <summary>
  6827. Get the rotation part of this rigid transform.
  6828. </summary>
  6829. <returns>
  6830. The rotation part of this rigid transform. May not be null.
  6831. </returns>
  6832. </member>
  6833. <member name="M:Cognex.VisionPro3D.Cog3DTransformRigid.Finalize">
  6834. <inheritdoc cref="M:Cognex.VisionPro3D.ICog3DBase.FinalizerForThisClass" />
  6835. </member>
  6836. <member name="M:Cognex.VisionPro3D.Cog3DTransformRigid.Dispose">
  6837. <inheritdoc cref="M:Cognex.VisionPro3D.ICog3DBase.DestructorForThisClass" />
  6838. </member>
  6839. <member name="M:Cognex.VisionPro3D.Cog3DTransformRigid.#ctor(Cognex.VisionPro3D.Cog3DTransformRotation,Cognex.VisionPro3D.Cog3DVect3)">
  6840. <summary>
  6841. Construct this Cog3DTransformRigid using rotation and translation.
  6842. </summary>
  6843. <param name="rotation">
  6844. The rotation part of the rigid transform. May not be null.
  6845. </param>
  6846. <param name="translation">
  6847. The translation part of the rigid transform.
  6848. </param>
  6849. <exception cref="T:System.ArgumentNullException">
  6850. If <paramref name="rotation" /> is null.
  6851. </exception>
  6852. </member>
  6853. <member name="M:Cognex.VisionPro3D.Cog3DTransformRigid.#ctor(Cognex.VisionPro3D.Cog3DTransformRigid)">
  6854. <inheritdoc cref="M:Cognex.VisionPro3D.ICog3DBase.DeepCopyConstructorForThisClass(System.Object)" />
  6855. </member>
  6856. <member name="M:Cognex.VisionPro3D.Cog3DTransformRigid.#ctor">
  6857. <summary>
  6858. Construct this default (identity transform) Cog3DTransformRigid.
  6859. </summary>
  6860. </member>
  6861. <member name="T:Cognex.VisionPro3D.Cog3DTransformRigid">
  6862. <summary>
  6863. This is the class for 3D rigid transform. A 3D rigid transform has
  6864. only pure rotation and translation, and no scale. A rigid transform preserves
  6865. relative distances: if point P and point Q are transformed to P' and Q',
  6866. then the distance from P to Q is the same as that from P' to Q'.
  6867. <para> Note that this class is immutable - it may not be changed once
  6868. it has been constructed. </para></summary>
  6869. </member>
  6870. <member name="M:Cognex.VisionPro3D.Cog3DTransformRotation.GetObjectData(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
  6871. <inheritdoc cref="M:Cognex.VisionPro3D.ICog3DBase.GetObjectData(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)" />
  6872. </member>
  6873. <member name="M:Cognex.VisionPro3D.Cog3DTransformRotation.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
  6874. <inheritdoc cref="M:Cognex.VisionPro3D.ICog3DBase.SerializationConstructor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)" />
  6875. </member>
  6876. <member name="P:Cognex.VisionPro3D.Cog3DTransformRotation.Linear">
  6877. <inheritdoc />
  6878. </member>
  6879. <member name="M:Cognex.VisionPro3D.Cog3DTransformRotation.ComposeBase(Cognex.VisionPro3D.ICog3DTransform)">
  6880. <inheritdoc />
  6881. </member>
  6882. <member name="M:Cognex.VisionPro3D.Cog3DTransformRotation.CopyBase">
  6883. <inheritdoc />
  6884. </member>
  6885. <member name="M:Cognex.VisionPro3D.Cog3DTransformRotation.RealEqual(Cognex.VisionPro3D.Cog3DTransformRotation,Cognex.VisionPro3D.Cog3DTransformRotation,System.Double)">
  6886. <inheritdoc cref="M:Cognex.VisionPro3D.ICog3DBase.RealEqual(System.Object,System.Object,System.Double)" />
  6887. </member>
  6888. <member name="M:Cognex.VisionPro3D.Cog3DTransformRotation.op_Multiply(Cognex.VisionPro3D.Cog3DTransformRotation,Cognex.VisionPro3D.Cog3DTransformRotation)">
  6889. <summary>
  6890. Operator for composing one rotation transform and another rotation
  6891. transform:
  6892. <para><paramref name="rotation" /> * <paramref name="rhs" />.
  6893. </para></summary>
  6894. <param name="rotation">
  6895. One rotation transform. May not be null.
  6896. </param>
  6897. <param name="rhs">
  6898. Another rotation transform to compose with. May not be null.
  6899. </param>
  6900. <returns>
  6901. The composed rotation transform.
  6902. </returns>
  6903. <exception cref="T:System.ArgumentNullException">
  6904. If any input argument is null.
  6905. </exception>
  6906. </member>
  6907. <member name="M:Cognex.VisionPro3D.Cog3DTransformRotation.Compose(Cognex.VisionPro3D.Cog3DTransformRotation)">
  6908. <summary>
  6909. Compose this rotation transform and another rotation transform.
  6910. Note that composing is from left to right: this * <paramref name="rhs" /></summary>
  6911. <param name="rhs">
  6912. The rotation transform to compose with. May not be null.
  6913. </param>
  6914. <returns>
  6915. The composed rotation transform.
  6916. </returns>
  6917. <exception cref="T:System.ArgumentNullException">
  6918. If the input argument is null.
  6919. </exception>
  6920. </member>
  6921. <member name="M:Cognex.VisionPro3D.Cog3DTransformRotation.ToString">
  6922. <inheritdoc cref="M:Cognex.VisionPro3D.ICog3DBase.ToString" />
  6923. </member>
  6924. <member name="M:Cognex.VisionPro3D.Cog3DTransformRotation.Inverse">
  6925. <summary>
  6926. Compute the inverse transform of this transform.
  6927. </summary>
  6928. <returns>
  6929. The inverse transform.
  6930. </returns>
  6931. </member>
  6932. <member name="M:Cognex.VisionPro3D.Cog3DTransformRotation.op_Multiply(Cognex.VisionPro3D.Cog3DTransformRotation,Cognex.VisionPro3D.Cog3DVect3)">
  6933. <summary>
  6934. Operator for mapping a 3D point using the specified 3D rotation transform:
  6935. <paramref name="rotation" /> * <paramref name="point3D" />.
  6936. </summary>
  6937. <param name="rotation">
  6938. One 3D rotation transform used for mapping. May not be null.
  6939. </param>
  6940. <param name="point3D">
  6941. The 3D point to map using the specified 3D rotation transform.
  6942. </param>
  6943. <returns>
  6944. The mapped point.
  6945. </returns>
  6946. <exception cref="T:System.ArgumentNullException">
  6947. If <paramref name="rotation" /> is null.
  6948. </exception>
  6949. </member>
  6950. <member name="M:Cognex.VisionPro3D.Cog3DTransformRotation.InverseBase">
  6951. <inheritdoc />
  6952. </member>
  6953. <member name="M:Cognex.VisionPro3D.Cog3DTransformRotation.InvMapPoints(Cognex.VisionPro3D.Cog3DVect3Collection)">
  6954. <summary>
  6955. Map a collection of 3D points using the inverse transform of this transform.
  6956. </summary>
  6957. <param name="points3D">
  6958. The collection of 3D points to map using the inverse transform of this transform. May not be null.
  6959. </param>
  6960. <returns>
  6961. A collection holding the inversely mapped points.
  6962. </returns>
  6963. <exception cref="T:System.ArgumentNullException">
  6964. If the input argument is null.
  6965. </exception>
  6966. </member>
  6967. <member name="M:Cognex.VisionPro3D.Cog3DTransformRotation.InvMapPoint(Cognex.VisionPro3D.Cog3DVect3)">
  6968. <summary>
  6969. Map a 3D point using the inverse transform of this transform.
  6970. </summary>
  6971. <param name="point3D">
  6972. The 3D point to map using the inverse transform of this transform.
  6973. </param>
  6974. <returns>
  6975. The inversely mapped point.
  6976. </returns>
  6977. </member>
  6978. <member name="M:Cognex.VisionPro3D.Cog3DTransformRotation.MapPoints(Cognex.VisionPro3D.Cog3DVect3Collection)">
  6979. <inheritdoc />
  6980. </member>
  6981. <member name="M:Cognex.VisionPro3D.Cog3DTransformRotation.MapPoint(Cognex.VisionPro3D.Cog3DVect3)">
  6982. <inheritdoc />
  6983. </member>
  6984. <member name="P:Cognex.VisionPro3D.Cog3DTransformRotation.IsIdentity">
  6985. <summary>
  6986. Gets whether this transform is identity.
  6987. </summary>
  6988. <value>
  6989. True if this 3D rotation transform is identity; False otherwise.
  6990. </value>
  6991. </member>
  6992. <member name="M:Cognex.VisionPro3D.Cog3DTransformRotation.GetMatrix">
  6993. <summary>
  6994. Get the matrix representation of this rotation transform.
  6995. </summary>
  6996. <returns>
  6997. The matrix representation of this rotation transform.
  6998. </returns>
  6999. </member>
  7000. <member name="M:Cognex.VisionPro3D.Cog3DTransformRotation.GetAxisAngle">
  7001. <summary>
  7002. Get the axis/angle representation of this rotation transform.
  7003. </summary>
  7004. <returns>
  7005. The axis/angle representation of this rotation transform.
  7006. </returns>
  7007. </member>
  7008. <member name="M:Cognex.VisionPro3D.Cog3DTransformRotation.GetQuaternion">
  7009. <summary>
  7010. Get the quaternion representation of this rotation transform.
  7011. </summary>
  7012. <returns>
  7013. The quaternion representation of this rotation transform.
  7014. </returns>
  7015. </member>
  7016. <member name="M:Cognex.VisionPro3D.Cog3DTransformRotation.GetEulerZYZMovingAxes">
  7017. <summary>
  7018. Get the EulerZYZ of moving axes for this rotation transform.
  7019. </summary>
  7020. <returns>
  7021. The EulerZYZ of moving axes representation for this rotation transform.
  7022. </returns>
  7023. </member>
  7024. <member name="M:Cognex.VisionPro3D.Cog3DTransformRotation.GetEulerZYXMovingAxes">
  7025. <summary>
  7026. Get the EulerZYX of moving axes for this rotation transform.
  7027. </summary>
  7028. <returns>
  7029. The EulerZYX of moving axes representation for this rotation transform.
  7030. </returns>
  7031. </member>
  7032. <member name="M:Cognex.VisionPro3D.Cog3DTransformRotation.GetEulerXYZMovingAxes">
  7033. <summary>
  7034. Get the EulerXYZ of moving axes representation of this rotation transform.
  7035. </summary>
  7036. <returns>
  7037. The EulerXYZ of moving axes representation of this rotation transform.
  7038. </returns>
  7039. </member>
  7040. <member name="M:Cognex.VisionPro3D.Cog3DTransformRotation.GetEulerZYX">
  7041. <summary>
  7042. Get the EulerZYX of fixed axes representation of this rotation transform.
  7043. </summary>
  7044. <value>
  7045. The EulerZYX of fixed axes representation of this rotation transform.
  7046. </value>
  7047. </member>
  7048. <member name="M:Cognex.VisionPro3D.Cog3DTransformRotation.GetEulerXYZ">
  7049. <summary>
  7050. Get the EulerXYZ of fixed axes representation of this rotation transform.
  7051. </summary>
  7052. <returns>
  7053. The EulerXYZ of fixed axes representation of this rotation transform.
  7054. </returns>
  7055. </member>
  7056. <member name="M:Cognex.VisionPro3D.Cog3DTransformRotation.Finalize">
  7057. <inheritdoc cref="M:Cognex.VisionPro3D.ICog3DBase.FinalizerForThisClass" />
  7058. </member>
  7059. <member name="M:Cognex.VisionPro3D.Cog3DTransformRotation.Dispose">
  7060. <inheritdoc cref="M:Cognex.VisionPro3D.ICog3DBase.DestructorForThisClass" />
  7061. </member>
  7062. <member name="M:Cognex.VisionPro3D.Cog3DTransformRotation.#ctor(Cognex.VisionPro3D.Cog3DMatrix3x3)">
  7063. <summary>
  7064. Construct this Cog3DTransformRotation using a matrix representation. Theoretically,
  7065. <paramref name="matrix" /> must
  7066. satisfy <paramref name="matrix" />.Determinant is 1 and
  7067. <paramref name="matrix" /> * <paramref name="matrix" />.Transpose() is Identity.
  7068. If <paramref name="matrix" /> is not exactly a rotation matrix then it attempts to
  7069. compute a rotation matrix closest to <paramref name="matrix" />, and use the computed
  7070. rotation matrix. Such a computation should succeed in practical
  7071. situations.
  7072. </summary>
  7073. <param name="matrix">
  7074. The 3x3 matrix representation of rotation transform.
  7075. </param>
  7076. <exception cref="T:System.ArgumentNullException">
  7077. If the input argument is null.
  7078. </exception>
  7079. <exception cref="T:System.ArgumentException">
  7080. If computation of the rotation matrix (if necessary) does not succeed.
  7081. </exception>
  7082. </member>
  7083. <member name="M:Cognex.VisionPro3D.Cog3DTransformRotation.#ctor(Cognex.VisionPro3D.Cog3DAxisAngle)">
  7084. <summary>
  7085. Construct this Cog3DTransformRotation using a rotation axis and rotation angle.
  7086. <para> Note that if the given axis is not a unit vector,
  7087. a corresponding unit vector is computed and used.
  7088. </para></summary>
  7089. <param name="axisAngle">
  7090. The axis/angle representation of rotation transform.
  7091. </param>
  7092. <exception cref="T:System.ArgumentException">
  7093. If <paramref name="axisAngle" />.Axis is (0,0,0).
  7094. </exception>
  7095. </member>
  7096. <member name="M:Cognex.VisionPro3D.Cog3DTransformRotation.#ctor(Cognex.VisionPro3D.Cog3DQuaternion)">
  7097. <summary>
  7098. Construct this Cog3DTransformRotation using a quaternion representation.
  7099. <para> Note that if the given quaternion
  7100. is not a unit quaternion, a corresponding unit quaternion is computed and used.
  7101. </para></summary>
  7102. <param name="quaternion">
  7103. The quaternion representation of rotation transform.
  7104. </param>
  7105. <exception cref="T:Cognex.VisionPro3D.Cog3DZeroQuaternionException">
  7106. If <paramref name="quaternion" />.Norm is 0.
  7107. </exception>
  7108. </member>
  7109. <member name="M:Cognex.VisionPro3D.Cog3DTransformRotation.#ctor(Cognex.VisionPro3D.Cog3DEulerZYZMovingAxes)">
  7110. <summary>
  7111. Construct this Cog3DTransformRotation using a Cog3DEulerZYZMovingAxes.
  7112. </summary>
  7113. <param name="eulerZYZ">
  7114. The EulerZYZ representation of moving axes.
  7115. </param>
  7116. </member>
  7117. <member name="M:Cognex.VisionPro3D.Cog3DTransformRotation.#ctor(Cognex.VisionPro3D.Cog3DEulerZYXMovingAxes)">
  7118. <summary>
  7119. Construct this Cog3DTransformRotation using a Cog3DEulerZYXMovingAxes.
  7120. </summary>
  7121. <param name="eulerZYX">
  7122. The EulerZYX representation of moving axes.
  7123. </param>
  7124. </member>
  7125. <member name="M:Cognex.VisionPro3D.Cog3DTransformRotation.#ctor(Cognex.VisionPro3D.Cog3DEulerXYZMovingAxes)">
  7126. <summary>
  7127. Construct this Cog3DTransformRotation using a Cog3DEulerXYZMovingAxes.
  7128. </summary>
  7129. <param name="eulerXYZ">
  7130. The EulerXYZ representation of moving axes.
  7131. </param>
  7132. </member>
  7133. <member name="M:Cognex.VisionPro3D.Cog3DTransformRotation.#ctor(Cognex.VisionPro3D.Cog3DEulerZYX)">
  7134. <summary>
  7135. Construct this Cog3DTransformRotation using a Cog3DEulerZYX.
  7136. </summary>
  7137. <param name="eulerZYX">
  7138. The EulerZYX representation of fixed axes.
  7139. </param>
  7140. </member>
  7141. <member name="M:Cognex.VisionPro3D.Cog3DTransformRotation.#ctor(Cognex.VisionPro3D.Cog3DEulerXYZ)">
  7142. <summary>
  7143. Construct this Cog3DTransformRotation using a Cog3DEulerXYZ.
  7144. </summary>
  7145. <param name="eulerXYZ">
  7146. The EulerXYZ representation of fixed axes.
  7147. </param>
  7148. </member>
  7149. <member name="M:Cognex.VisionPro3D.Cog3DTransformRotation.#ctor(Cognex.VisionPro3D.Cog3DTransformRotation)">
  7150. <inheritdoc cref="M:Cognex.VisionPro3D.ICog3DBase.DeepCopyConstructorForThisClass(System.Object)" />
  7151. </member>
  7152. <member name="M:Cognex.VisionPro3D.Cog3DTransformRotation.#ctor">
  7153. <summary>
  7154. Construct this default (identity transform) Cog3DTransformRotation.
  7155. </summary>
  7156. </member>
  7157. <member name="T:Cognex.VisionPro3D.Cog3DTransformRotation">
  7158. <summary>
  7159. This is the class for 3D rotation transform. A 3D rotation can be
  7160. represented in different ways, such as using 3 Euler angles (Cog3DEulerXYZ).
  7161. A 3D rotation transform can be constructed by any of the supported
  7162. representations, and also has getters to return the instances of different rotation
  7163. representation classes.
  7164. <para> Note that this class is immutable - it may not be changed once
  7165. it has been constructed. </para></summary>
  7166. </member>
  7167. <member name="P:Cognex.VisionPro3D.ICog3DTransform.Linear">
  7168. <summary>
  7169. Gets whether this transform is linear.
  7170. </summary>
  7171. <value>
  7172. True if this 3D composed transform is linear; False otherwise.
  7173. </value>
  7174. </member>
  7175. <member name="M:Cognex.VisionPro3D.ICog3DTransform.ComposeBase(Cognex.VisionPro3D.ICog3DTransform)">
  7176. <summary>
  7177. Creates a new transform which is the composition of the given transform (on the right side) and this one (on the left side).
  7178. <para>
  7179. Note that the return transform is always the canonical representation of the composed transform.
  7180. Therefore, it might be of type Cog3DTransformComposed or a simpler type.
  7181. </para></summary>
  7182. <returns>
  7183. An ICog3DTransform that represents the result of the composition.
  7184. </returns>
  7185. <remarks>
  7186. The returned transform type depends on the type of this transform and the type of <param name="rhs" />, for example :
  7187. <list type="bullet"><item> Cog3DTransformRotation, Cog3DTransformRotation returns Cog3DTransformRotation </item><item> Cog3DTransformRigid, Cog3DTransformRigid returns Cog3DTransformRigid </item><item> Cog3DTransformLinear, Cog3DTransformLinear returns Cog3DTransformLinear </item><item> Cog3DTransformRigid, Cog3DTransformRotation returns Cog3DTransformRigid </item><item> Cog3DTransformLinear, Cog3DTransformRotation returns Cog3DTransformLinear </item><item> Cog3DTransformRotation, Cog3DTransformRigid returns Cog3DTransformRigid </item><item> Cog3DTransformRotation, Cog3DTransformLinear returns Cog3DTransformLinear </item><item> Cog3DTransformRigid, Cog3DTransformLinear returns Cog3DTransformLinear </item><item> Cog3DTransformLinear, Cog3DTransformRigid returns Cog3DTransformLinear </item></list></remarks>
  7188. </member>
  7189. <member name="M:Cognex.VisionPro3D.ICog3DTransform.CopyBase">
  7190. <summary>
  7191. Create a deep copy of this transform.
  7192. </summary>
  7193. <returns>
  7194. The copied transform.
  7195. </returns>
  7196. </member>
  7197. <member name="M:Cognex.VisionPro3D.ICog3DTransform.InverseBase">
  7198. <summary>
  7199. Compute the inverse of this transform.
  7200. </summary>
  7201. <returns>
  7202. The inverse transform.
  7203. </returns>
  7204. </member>
  7205. <member name="M:Cognex.VisionPro3D.ICog3DTransform.MapPoints(Cognex.VisionPro3D.Cog3DVect3Collection)">
  7206. <summary>
  7207. Map a collection of 3D points.
  7208. </summary>
  7209. <param name="points3D">
  7210. The 3D points to map using this transform.
  7211. </param>
  7212. <returns>
  7213. A collection holding the mapped points.
  7214. </returns>
  7215. <exception cref="T:System.ArgumentNullException">
  7216. If the input argument is null.
  7217. </exception>
  7218. </member>
  7219. <member name="M:Cognex.VisionPro3D.ICog3DTransform.MapPoint(Cognex.VisionPro3D.Cog3DVect3)">
  7220. <summary>
  7221. Map a 3D point.
  7222. </summary>
  7223. <param name="point3D">
  7224. The 3D point to map using this transform.
  7225. </param>
  7226. <returns>
  7227. The mapped point.
  7228. </returns>
  7229. </member>
  7230. <member name="T:Cognex.VisionPro3D.ICog3DTransform">
  7231. <summary>
  7232. This is the interface class for 3D transforms.
  7233. </summary>
  7234. </member>
  7235. <member name="M:Cognex.VisionPro3D.Cog3DAxisAngle.RealEqual(Cognex.VisionPro3D.Cog3DAxisAngle,Cognex.VisionPro3D.Cog3DAxisAngle,System.Double)">
  7236. <inheritdoc cref="M:Cognex.VisionPro3D.ICog3DBase.RealEqual(System.Object,System.Object,System.Double)" />
  7237. </member>
  7238. <member name="M:Cognex.VisionPro3D.Cog3DAxisAngle.ToString">
  7239. <inheritdoc cref="M:Cognex.VisionPro3D.ICog3DBase.ToString" />
  7240. </member>
  7241. <member name="M:Cognex.VisionPro3D.Cog3DAxisAngle.op_Inequality(Cognex.VisionPro3D.Cog3DAxisAngle,Cognex.VisionPro3D.Cog3DAxisAngle)">
  7242. <summary>
  7243. Compare two Cog3DAxisAngle.
  7244. </summary>
  7245. <param name="alpha">
  7246. The first Cog3DAxisAngle.
  7247. </param>
  7248. <param name="beta">
  7249. The second Cog3DAxisAngle.
  7250. </param>
  7251. <returns>
  7252. False if exactly equal, true otherwise.
  7253. </returns>
  7254. </member>
  7255. <member name="M:Cognex.VisionPro3D.Cog3DAxisAngle.op_Equality(Cognex.VisionPro3D.Cog3DAxisAngle,Cognex.VisionPro3D.Cog3DAxisAngle)">
  7256. <summary>
  7257. Compare two Cog3DAxisAngle.
  7258. </summary>
  7259. <param name="alpha">
  7260. The first Cog3DAxisAngle.
  7261. </param>
  7262. <param name="beta">
  7263. The second Cog3DAxisAngle.
  7264. </param>
  7265. <returns>
  7266. True if exactly equal, false otherwise.
  7267. </returns>
  7268. </member>
  7269. <member name="P:Cognex.VisionPro3D.Cog3DAxisAngle.Angle">
  7270. <summary>
  7271. The rotation angle in radians.
  7272. </summary>
  7273. <value>
  7274. The rotation angle in radians around the rotation axis.
  7275. </value>
  7276. </member>
  7277. <member name="P:Cognex.VisionPro3D.Cog3DAxisAngle.Axis">
  7278. <summary>
  7279. The rotation axis.
  7280. </summary>
  7281. <value>
  7282. The axis of rotation.
  7283. </value>
  7284. </member>
  7285. <member name="M:Cognex.VisionPro3D.Cog3DAxisAngle.#ctor(Cognex.VisionPro3D.Cog3DVect3,System.Double)">
  7286. <summary>
  7287. Construct this Cog3DAxisAngle with the supplied axis and angle value.
  7288. </summary>
  7289. <param name="axis">
  7290. The rotation axis.
  7291. </param>
  7292. <param name="angle">
  7293. The rotation angle in radians.
  7294. </param>
  7295. </member>
  7296. <member name="T:Cognex.VisionPro3D.Cog3DAxisAngle">
  7297. <summary>
  7298. This value class describes 3D rotation representation
  7299. based on a rotation axis and an angle around the axis. Go to the following
  7300. link (Section "Euler axis and angle") for more information:
  7301. http://en.wikipedia.org/wiki/Rotation_representation_%28mathematics%29
  7302. </summary>
  7303. <remarks>
  7304. <list type="bullet">
  7305. <item> This class is immutable - it may not be changed once
  7306. it has been constructed. </item>
  7307. <item> The default constructor creates an object with axis of (0,0,0),
  7308. angle of 0.0, which
  7309. is not valid for usage by Cog3DTransformRotation. </item>
  7310. <item> This class is just a container class for initializing/getting the
  7311. rotation axis and angle, and it does not handle rotation operations.
  7312. Please use Cog3DTransformRotation for general 3D rotation operations. </item>
  7313. </list>
  7314. </remarks>
  7315. </member>
  7316. <member name="M:Cognex.VisionPro3D.Cog3DMatrix3x3.GetObjectData(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
  7317. <inheritdoc cref="M:Cognex.VisionPro3D.ICog3DBase.GetObjectData(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)" />
  7318. </member>
  7319. <member name="M:Cognex.VisionPro3D.Cog3DMatrix3x3.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
  7320. <inheritdoc cref="M:Cognex.VisionPro3D.ICog3DBase.SerializationConstructor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)" />
  7321. </member>
  7322. <member name="M:Cognex.VisionPro3D.Cog3DMatrix3x3.RealEqual(Cognex.VisionPro3D.Cog3DMatrix3x3,Cognex.VisionPro3D.Cog3DMatrix3x3,System.Double)">
  7323. <inheritdoc cref="M:Cognex.VisionPro3D.ICog3DBase.RealEqual(System.Object,System.Object,System.Double)" />
  7324. </member>
  7325. <member name="M:Cognex.VisionPro3D.Cog3DMatrix3x3.op_UnaryNegation(Cognex.VisionPro3D.Cog3DMatrix3x3)">
  7326. <summary>
  7327. Unary minus Operator, defined as
  7328. -<paramref name="matrix" /></summary>
  7329. <param name="matrix">
  7330. The input matrix.
  7331. </param>
  7332. <returns>
  7333. The resulting 3x3 matrix.
  7334. </returns>
  7335. </member>
  7336. <member name="M:Cognex.VisionPro3D.Cog3DMatrix3x3.op_Subtraction(Cognex.VisionPro3D.Cog3DMatrix3x3,Cognex.VisionPro3D.Cog3DMatrix3x3)">
  7337. <summary>
  7338. Subtraction operator for one matrix and another matrix, defined as
  7339. <paramref name="matrix" /> - <paramref name="rhs" /></summary>
  7340. <param name="matrix">
  7341. The first matrix. May not be null.
  7342. </param>
  7343. <param name="rhs">
  7344. The second matrix. May not be null.
  7345. </param>
  7346. <returns>
  7347. The resulting 3x3 matrix.
  7348. </returns>
  7349. <exception cref="T:System.ArgumentNullException">
  7350. If any input argument is null.
  7351. </exception>
  7352. </member>
  7353. <member name="M:Cognex.VisionPro3D.Cog3DMatrix3x3.op_Addition(Cognex.VisionPro3D.Cog3DMatrix3x3,Cognex.VisionPro3D.Cog3DMatrix3x3)">
  7354. <summary>
  7355. Addition operator for one matrix and another matrix, defined as
  7356. <paramref name="matrix" /> + <paramref name="rhs" /></summary>
  7357. <param name="matrix">
  7358. The first matrix. May not be null.
  7359. </param>
  7360. <param name="rhs">
  7361. The second matrix. May not be null.
  7362. </param>
  7363. <returns>
  7364. The resulting 3x3 matrix.
  7365. </returns>
  7366. <exception cref="T:System.ArgumentNullException">
  7367. If any input argument is null.
  7368. </exception>
  7369. </member>
  7370. <member name="M:Cognex.VisionPro3D.Cog3DMatrix3x3.op_Division(Cognex.VisionPro3D.Cog3DMatrix3x3,Cognex.VisionPro3D.Cog3DMatrix3x3)">
  7371. <summary>
  7372. Division operator for one matrix and another matrix. This operator is defined as
  7373. <paramref name="matrix" /> / <paramref name="rhs" /> = <paramref name="matrix" /> * <paramref name="rhs" />.Inverse()
  7374. </summary>
  7375. <param name="matrix">
  7376. The first matrix. May not be null.
  7377. </param>
  7378. <param name="rhs">
  7379. The second matrix. May not be null.
  7380. </param>
  7381. <returns>
  7382. The resulting 3x3 matrix.
  7383. </returns>
  7384. <exception cref="T:System.ArgumentNullException">
  7385. If any input argument is null.
  7386. </exception>
  7387. <exception cref="T:Cognex.VisionPro3D.Cog3DException">
  7388. If <paramref name="rhs" /> is singular.
  7389. </exception>
  7390. </member>
  7391. <member name="M:Cognex.VisionPro3D.Cog3DMatrix3x3.op_Multiply(Cognex.VisionPro3D.Cog3DMatrix3x3,Cognex.VisionPro3D.Cog3DMatrix3x3)">
  7392. <summary>
  7393. Operator for composing one matrix and another matrix. Note that the definition of this operation is
  7394. <paramref name="matrix" /> * <paramref name="rhs" />.
  7395. </summary>
  7396. <param name="matrix">
  7397. The first matrix. May not be null.
  7398. </param>
  7399. <param name="rhs">
  7400. The second matrix. May not be null.
  7401. </param>
  7402. <returns>
  7403. The composed 3x3 matrix.
  7404. </returns>
  7405. <exception cref="T:System.ArgumentNullException">
  7406. If any input argument is null.
  7407. </exception>
  7408. </member>
  7409. <member name="M:Cognex.VisionPro3D.Cog3DMatrix3x3.op_Division(System.Double,Cognex.VisionPro3D.Cog3DMatrix3x3)">
  7410. <summary>
  7411. Division operator for a scalar and a matrix. Note that
  7412. <paramref name="scale" /> / <paramref name="matrix" /> = <paramref name="scale" /> * <paramref name="matrix" />.Inverse().
  7413. </summary>
  7414. <param name="matrix">
  7415. The 3D matrix. May not be null.
  7416. </param>
  7417. <param name="scale">
  7418. The scale factor.
  7419. </param>
  7420. <returns>
  7421. The scaled matrix.
  7422. </returns>
  7423. <exception cref="T:System.ArgumentNullException">
  7424. If <paramref name="matrix" /> is null.
  7425. </exception>
  7426. </member>
  7427. <member name="M:Cognex.VisionPro3D.Cog3DMatrix3x3.op_Division(Cognex.VisionPro3D.Cog3DMatrix3x3,System.Double)">
  7428. <summary>
  7429. Division operator for a matrix and a scalar.
  7430. <para> Note that <paramref name="matrix" /> / <paramref name="scale" /> = <paramref name="matrix" /> * 1/<paramref name="scale" />. </para></summary>
  7431. <param name="matrix">
  7432. The 3D matrix. May not be null.
  7433. </param>
  7434. <param name="scale">
  7435. The divisor.
  7436. </param>
  7437. <returns>
  7438. The resulting matrix.
  7439. </returns>
  7440. <exception cref="T:System.ArgumentNullException">
  7441. If <paramref name="matrix" /> is null.
  7442. </exception>
  7443. </member>
  7444. <member name="M:Cognex.VisionPro3D.Cog3DMatrix3x3.op_Multiply(System.Double,Cognex.VisionPro3D.Cog3DMatrix3x3)">
  7445. <summary>
  7446. Multiplication operator for a scalar and a matrix.
  7447. <para> Note that the definition of this operator is:
  7448. <paramref name="scale" /> * <paramref name="matrix" /> = <paramref name="matrix" /> * <paramref name="scale" />.
  7449. </para></summary>
  7450. <param name="matrix">
  7451. The 3D matrix. May not be null.
  7452. </param>
  7453. <param name="scale">
  7454. The scaling factor.
  7455. </param>
  7456. <returns>
  7457. The scaled matrix.
  7458. </returns>
  7459. <exception cref="T:System.ArgumentNullException">
  7460. If <paramref name="matrix" /> is null.
  7461. </exception>
  7462. </member>
  7463. <member name="M:Cognex.VisionPro3D.Cog3DMatrix3x3.op_Multiply(Cognex.VisionPro3D.Cog3DMatrix3x3,System.Double)">
  7464. <summary>
  7465. Multiplication operator for a matrix and a scalar. Note that the definition of this operation is
  7466. <paramref name="matrix" /> * <paramref name="scale" />.
  7467. </summary>
  7468. <param name="matrix">
  7469. The 3D matrix for scaling. May not be null.
  7470. </param>
  7471. <param name="scale">
  7472. The scaling factor.
  7473. </param>
  7474. <returns>
  7475. The scaled matrix.
  7476. </returns>
  7477. <exception cref="T:System.ArgumentNullException">
  7478. If <paramref name="matrix" /> is null.
  7479. </exception>
  7480. </member>
  7481. <member name="M:Cognex.VisionPro3D.Cog3DMatrix3x3.op_Division(Cognex.VisionPro3D.Cog3DVect3,Cognex.VisionPro3D.Cog3DMatrix3x3)">
  7482. <summary>
  7483. Division operator for a 3D point and a 3D matrix. The definition of this operator is
  7484. <paramref name="point3D" /> / <paramref name="matrix" /> = <paramref name="point3D" /> * <paramref name="matrix" />.Inverse().
  7485. </summary>
  7486. <param name="matrix">
  7487. The 3D matrix . May not be null.
  7488. </param>
  7489. <param name="point3D">
  7490. The 3D point.
  7491. </param>
  7492. <returns>
  7493. The resulting point.
  7494. </returns>
  7495. <exception cref="T:System.ArgumentNullException">
  7496. If <paramref name="matrix" /> is null.
  7497. </exception>
  7498. </member>
  7499. <member name="M:Cognex.VisionPro3D.Cog3DMatrix3x3.op_Multiply(Cognex.VisionPro3D.Cog3DVect3,Cognex.VisionPro3D.Cog3DMatrix3x3)">
  7500. <summary>
  7501. Multiplication operator for a 3D point and a 3D matrix. The definition of this operator is
  7502. <paramref name="point3D" /> * <paramref name="matrix" /> = <paramref name="matrix" />.Transpose() * <paramref name="point3D" />.
  7503. </summary>
  7504. <param name="matrix">
  7505. The 3D matrix . May not be null.
  7506. </param>
  7507. <param name="point3D">
  7508. The 3D point.
  7509. </param>
  7510. <returns>
  7511. The resulting point.
  7512. </returns>
  7513. <exception cref="T:System.ArgumentNullException">
  7514. If <paramref name="matrix" /> is null.
  7515. </exception>
  7516. </member>
  7517. <member name="M:Cognex.VisionPro3D.Cog3DMatrix3x3.op_Multiply(Cognex.VisionPro3D.Cog3DMatrix3x3,Cognex.VisionPro3D.Cog3DVect3)">
  7518. <summary>
  7519. Multiplication operator for a 3D matrix and a 3D point. Note that the definition of this operation is
  7520. <paramref name="matrix" /> * <paramref name="point3D" />.
  7521. </summary>
  7522. <param name="matrix">
  7523. The 3D matrix. May not be null.
  7524. </param>
  7525. <param name="point3D">
  7526. The 3D point.
  7527. </param>
  7528. <returns>
  7529. The resulting point.
  7530. </returns>
  7531. <exception cref="T:System.ArgumentNullException">
  7532. If <paramref name="matrix" /> is null.
  7533. </exception>
  7534. </member>
  7535. <member name="M:Cognex.VisionPro3D.Cog3DMatrix3x3.ToString">
  7536. <inheritdoc cref="M:Cognex.VisionPro3D.ICog3DBase.ToString" />
  7537. </member>
  7538. <member name="M:Cognex.VisionPro3D.Cog3DMatrix3x3.Transpose">
  7539. <summary>
  7540. Compute the transpose matrix of this matrix.
  7541. </summary>
  7542. <returns>
  7543. The transpose matrix.
  7544. </returns>
  7545. </member>
  7546. <member name="M:Cognex.VisionPro3D.Cog3DMatrix3x3.Inverse">
  7547. <summary>
  7548. Compute the inverse matrix of this matrix.
  7549. </summary>
  7550. <returns>
  7551. The inverse matrix.
  7552. </returns>
  7553. <exception cref="T:Cognex.VisionPro3D.Cog3DException">
  7554. If the matrix is singular.
  7555. </exception>
  7556. </member>
  7557. <member name="M:Cognex.VisionPro3D.Cog3DMatrix3x3.SetElement(System.Int32,System.Int32,System.Double)">
  7558. <summary>
  7559. Sets one element of the matrix.
  7560. </summary>
  7561. <param name="rowIndex">
  7562. The zero-based row index of the matrix.
  7563. </param>
  7564. <param name="colIndex">
  7565. The zero-based column index of the matrix.
  7566. </param>
  7567. <param name="value">
  7568. The value of the element at the given row and column.
  7569. </param>
  7570. <remarks>
  7571. This setter recalculates Determinant.
  7572. </remarks>
  7573. <exception cref="T:System.ArgumentException">
  7574. If <paramref name="rowIndex" /> or <paramref name="colIndex" /> is not inside range [0,2].
  7575. </exception>
  7576. </member>
  7577. <member name="M:Cognex.VisionPro3D.Cog3DMatrix3x3.GetElement(System.Int32,System.Int32)">
  7578. <summary>
  7579. Gets one element of the matrix.
  7580. </summary>
  7581. <param name="rowIndex">
  7582. The zero-based row index of the matrix.
  7583. </param>
  7584. <param name="colIndex">
  7585. The zero-based column index of the matrix.
  7586. </param>
  7587. <returns>
  7588. The value of the element at the given row and column.
  7589. </returns>
  7590. <exception cref="T:System.ArgumentException">
  7591. If <paramref name="rowIndex" /> or <paramref name="colIndex" /> is not inside range [0,2].
  7592. </exception>
  7593. </member>
  7594. <member name="P:Cognex.VisionPro3D.Cog3DMatrix3x3.IsIdentity">
  7595. <summary>
  7596. Gets whether this matrix is identity.
  7597. </summary>
  7598. <value>
  7599. True if this matrix is identity; false otherwise.
  7600. </value>
  7601. </member>
  7602. <member name="P:Cognex.VisionPro3D.Cog3DMatrix3x3.IsSingular">
  7603. <summary>
  7604. Gets whether this matrix is singular.
  7605. </summary>
  7606. <value>
  7607. True if the matrix is singular; false otherwise.
  7608. </value>
  7609. </member>
  7610. <member name="P:Cognex.VisionPro3D.Cog3DMatrix3x3.Element(System.Int32,System.Int32)">
  7611. <summary>
  7612. This property is deprecated, please use GetElment and SetElement instead.
  7613. </summary>
  7614. <param name="rowIndex">
  7615. The zero-based row index of the matrix.
  7616. </param>
  7617. <param name="colIndex">
  7618. The zero-based column index of the matrix.
  7619. </param>
  7620. <value>
  7621. The value of the element at the given row and column.
  7622. </value>
  7623. <remarks>
  7624. The setter recalculates Determinant.
  7625. </remarks>
  7626. <exception cref="T:System.ArgumentException">
  7627. If <paramref name="rowIndex" /> or <paramref name="colIndex" /> is not inside range [0,2].
  7628. </exception>
  7629. </member>
  7630. <member name="P:Cognex.VisionPro3D.Cog3DMatrix3x3.ScaleZ">
  7631. <summary>
  7632. Gets the z scale value of this matrix.
  7633. The z scale is defined to be the length of the vector
  7634. resulting from mapping the z unit vector through this matrix.
  7635. </summary>
  7636. <value>
  7637. The z scale of this matrix.
  7638. </value>
  7639. <exception cref="T:Cognex.VisionPro3D.Cog3DException">
  7640. If the matrix is singular.
  7641. </exception>
  7642. </member>
  7643. <member name="P:Cognex.VisionPro3D.Cog3DMatrix3x3.ScaleY">
  7644. <summary>
  7645. Gets the y scale value of this matrix.
  7646. The y scale is defined to be the length of the vector
  7647. resulting from mapping the y unit vector through this matrix.
  7648. </summary>
  7649. <value>
  7650. The y scale of this matrix.
  7651. </value>
  7652. <exception cref="T:Cognex.VisionPro3D.Cog3DException">
  7653. If the matrix is singular.
  7654. </exception>
  7655. </member>
  7656. <member name="P:Cognex.VisionPro3D.Cog3DMatrix3x3.ScaleX">
  7657. <summary>
  7658. Gets the x scale value of this matrix.
  7659. The x scale is defined to be the length of the vector
  7660. resulting from mapping the x unit vector through this matrix.
  7661. </summary>
  7662. <value>
  7663. The x scale of this matrix.
  7664. </value>
  7665. <exception cref="T:Cognex.VisionPro3D.Cog3DException">
  7666. If the matrix is singular.
  7667. </exception>
  7668. </member>
  7669. <member name="P:Cognex.VisionPro3D.Cog3DMatrix3x3.Determinant">
  7670. <summary>
  7671. Gets the determinant of this matrix.
  7672. </summary>
  7673. <value>
  7674. The determinant of this matrix.
  7675. </value>
  7676. </member>
  7677. <member name="M:Cognex.VisionPro3D.Cog3DMatrix3x3.Finalize">
  7678. <inheritdoc cref="M:Cognex.VisionPro3D.ICog3DBase.FinalizerForThisClass" />
  7679. </member>
  7680. <member name="M:Cognex.VisionPro3D.Cog3DMatrix3x3.Dispose">
  7681. <inheritdoc cref="M:Cognex.VisionPro3D.ICog3DBase.DestructorForThisClass" />
  7682. </member>
  7683. <member name="M:Cognex.VisionPro3D.Cog3DMatrix3x3.#ctor(System.Double,System.Double,System.Double,System.Double,System.Double,System.Double,System.Double,System.Double,System.Double)">
  7684. <summary>
  7685. Construct this Cog3DMatrix3x3 using the given element values.
  7686. </summary>
  7687. <param name="e00">
  7688. Specified value for Element(0,0).
  7689. </param>
  7690. <param name="e01">
  7691. Specified value for Element(0,1).
  7692. </param>
  7693. <param name="e02">
  7694. Specified value for Element(0,2).
  7695. </param>
  7696. <param name="e10">
  7697. Specified value for Element(1,0).
  7698. </param>
  7699. <param name="e11">
  7700. Specified value for Element(1,1).
  7701. </param>
  7702. <param name="e12">
  7703. Specified value for Element(1,2).
  7704. </param>
  7705. <param name="e20">
  7706. Specified value for Element(2,0).
  7707. </param>
  7708. <param name="e21">
  7709. Specified value for Element(2,1).
  7710. </param>
  7711. <param name="e22">
  7712. Specified value for Element(2,2).
  7713. </param>
  7714. </member>
  7715. <member name="M:Cognex.VisionPro3D.Cog3DMatrix3x3.#ctor(Cognex.VisionPro3D.Cog3DMatrix3x3)">
  7716. <inheritdoc cref="M:Cognex.VisionPro3D.ICog3DBase.DeepCopyConstructorForThisClass(System.Object)" />
  7717. </member>
  7718. <member name="M:Cognex.VisionPro3D.Cog3DMatrix3x3.#ctor">
  7719. <summary>
  7720. Construct a default (representing an identity transform) Cog3DMatrix3x3.
  7721. </summary>
  7722. </member>
  7723. <member name="T:Cognex.VisionPro3D.Cog3DMatrix3x3">
  7724. <summary>
  7725. This class describes a 3X3 matrix representation and associated operations.
  7726. Note that although 3x3 matrices are useful in calculation involving 3D rotations,
  7727. users should use Cog3DTransformRotation for general 3D rotation operations.
  7728. </summary>
  7729. </member>
  7730. <member name="M:Cognex.VisionPro3D.Cog3DQuaternion.RealEqual(Cognex.VisionPro3D.Cog3DQuaternion,Cognex.VisionPro3D.Cog3DQuaternion,System.Double)">
  7731. <inheritdoc cref="M:Cognex.VisionPro3D.ICog3DBase.RealEqual(System.Object,System.Object,System.Double)" />
  7732. </member>
  7733. <member name="M:Cognex.VisionPro3D.Cog3DQuaternion.op_Inequality(Cognex.VisionPro3D.Cog3DQuaternion,Cognex.VisionPro3D.Cog3DQuaternion)">
  7734. <summary>
  7735. Compare two Cog3DQuaternion.
  7736. </summary>
  7737. <param name="alpha">
  7738. The first quaternion.
  7739. </param>
  7740. <param name="beta">
  7741. The second quaternion.
  7742. </param>
  7743. <returns>
  7744. False if exactly equal, true otherwise.
  7745. </returns>
  7746. </member>
  7747. <member name="M:Cognex.VisionPro3D.Cog3DQuaternion.op_Equality(Cognex.VisionPro3D.Cog3DQuaternion,Cognex.VisionPro3D.Cog3DQuaternion)">
  7748. <summary>
  7749. Compare two Cog3DQuaternion.
  7750. </summary>
  7751. <param name="alpha">
  7752. The first quaternion.
  7753. </param>
  7754. <param name="beta">
  7755. The second quaternion.
  7756. </param>
  7757. <returns>
  7758. True if exactly equal, false otherwise.
  7759. </returns>
  7760. </member>
  7761. <member name="M:Cognex.VisionPro3D.Cog3DQuaternion.op_Multiply(Cognex.VisionPro3D.Cog3DQuaternion,System.Double)">
  7762. <summary>
  7763. Multiply a Cog3DQuaternion by a scalar.
  7764. </summary>
  7765. <param name="quaternion">
  7766. The quaternion.
  7767. </param>
  7768. <param name="mult">
  7769. The scalar multiplier.
  7770. </param>
  7771. <returns>
  7772. The multiplied (scaled) quaternion.
  7773. </returns>
  7774. </member>
  7775. <member name="M:Cognex.VisionPro3D.Cog3DQuaternion.op_Subtraction(Cognex.VisionPro3D.Cog3DQuaternion,Cognex.VisionPro3D.Cog3DQuaternion)">
  7776. <summary>
  7777. Subtract two quaternions: <paramref name="alpha" /> - <paramref name="beta" />.
  7778. </summary>
  7779. <param name="alpha">
  7780. The first quaternion.
  7781. </param>
  7782. <param name="beta">
  7783. The second quaternion.
  7784. </param>
  7785. <returns>
  7786. The quaternion after subtraction.
  7787. </returns>
  7788. </member>
  7789. <member name="M:Cognex.VisionPro3D.Cog3DQuaternion.op_Addition(Cognex.VisionPro3D.Cog3DQuaternion,Cognex.VisionPro3D.Cog3DQuaternion)">
  7790. <summary>
  7791. Add two quaternions.
  7792. </summary>
  7793. <param name="alpha">
  7794. The first quaternion.
  7795. </param>
  7796. <param name="beta">
  7797. The second quaternion.
  7798. </param>
  7799. <returns>
  7800. The sum quaternion.
  7801. </returns>
  7802. </member>
  7803. <member name="M:Cognex.VisionPro3D.Cog3DQuaternion.ToString">
  7804. <inheritdoc cref="M:Cognex.VisionPro3D.ICog3DBase.ToString" />
  7805. </member>
  7806. <member name="M:Cognex.VisionPro3D.Cog3DQuaternion.ComputeInnerProduct(Cognex.VisionPro3D.Cog3DQuaternion)">
  7807. <summary>
  7808. Compute the inner product of this Cog3DQuaternion with the supplied <paramref name="other" />.
  7809. </summary>
  7810. <param name="other">
  7811. The other quaternion.
  7812. </param>
  7813. <returns>
  7814. The computed inner product.
  7815. </returns>
  7816. </member>
  7817. <member name="M:Cognex.VisionPro3D.Cog3DQuaternion.ComputeGrassmannProduct(Cognex.VisionPro3D.Cog3DQuaternion)">
  7818. <summary>
  7819. Compute the Grassmann product of this Cog3DQuaternion with the supplied <paramref name="other" />.
  7820. </summary>
  7821. <param name="other">
  7822. The other quaternion.
  7823. </param>
  7824. <returns>
  7825. The computed Grassmann product quaternion.
  7826. </returns>
  7827. </member>
  7828. <member name="M:Cognex.VisionPro3D.Cog3DQuaternion.ComputeUnitQuaternion">
  7829. <summary>
  7830. Gets the normalized quaternion (a unit quaternion) whose Norm
  7831. value is 1.
  7832. </summary>
  7833. <returns>
  7834. Gets the normalized quaternion (a unit quaternion).
  7835. </returns>
  7836. <exception cref="T:Cognex.VisionPro3D.Cog3DZeroQuaternionException">
  7837. If W == X == Y == Z == 0
  7838. </exception>
  7839. <remarks>
  7840. A unit quaternion is obtained by dividing the quaternion by its Norm value.
  7841. </remarks>
  7842. </member>
  7843. <member name="M:Cognex.VisionPro3D.Cog3DQuaternion.ComputeConjugate">
  7844. <summary>
  7845. Gets the conjugate quaternion of this quaternion, which is defined
  7846. as follows: W - X i - Y j - Z k
  7847. </summary>
  7848. <returns>
  7849. The conjugate quaternion of this quaternion.
  7850. </returns>
  7851. </member>
  7852. <member name="P:Cognex.VisionPro3D.Cog3DQuaternion.NormSquared">
  7853. <summary>
  7854. Gets the norm squared value of this quaternion object.
  7855. </summary>
  7856. <value>
  7857. The norm squared value of this quaternion object.
  7858. </value>
  7859. <remarks>
  7860. The norm squared value is the Grassmann product of this quaternion
  7861. and its conjugate, i.e., NormSquared is (W*W) + (X*X) + (Y*Y) + (Z*Z)
  7862. </remarks>
  7863. </member>
  7864. <member name="P:Cognex.VisionPro3D.Cog3DQuaternion.Norm">
  7865. <summary>
  7866. Gets the norm (magnitude) value of this quaternion object.
  7867. </summary>
  7868. <value>
  7869. The norm (magnitude) value of this quaternion object.
  7870. </value>
  7871. <remarks>
  7872. The norm value of a quaternion is sqrt(NormSquared).
  7873. </remarks>
  7874. </member>
  7875. <member name="P:Cognex.VisionPro3D.Cog3DQuaternion.Z">
  7876. <summary>
  7877. Gets the fourth component of this quaternion object.
  7878. </summary>
  7879. <value>
  7880. The fourth component of this quaternion object.
  7881. </value>
  7882. </member>
  7883. <member name="P:Cognex.VisionPro3D.Cog3DQuaternion.Y">
  7884. <summary>
  7885. Gets the third component of this quaternion object.
  7886. </summary>
  7887. <value>
  7888. The third component of this quaternion object.
  7889. </value>
  7890. </member>
  7891. <member name="P:Cognex.VisionPro3D.Cog3DQuaternion.X">
  7892. <summary>
  7893. Gets the second component of this quaternion object.
  7894. </summary>
  7895. <value>
  7896. The second component of this quaternion object.
  7897. </value>
  7898. </member>
  7899. <member name="P:Cognex.VisionPro3D.Cog3DQuaternion.XYZ">
  7900. <summary>
  7901. Gets the vector (imaginary) part of this quaternion object.
  7902. </summary>
  7903. <value>
  7904. The vector (imaginary) part of this quaternion object.
  7905. </value>
  7906. </member>
  7907. <member name="P:Cognex.VisionPro3D.Cog3DQuaternion.W">
  7908. <summary>
  7909. Gets the scalar part (the first component) of this quaternion.
  7910. </summary>
  7911. <value>
  7912. The scalar part (the first component) of this quaternion.
  7913. </value>
  7914. </member>
  7915. <member name="M:Cognex.VisionPro3D.Cog3DQuaternion.#ctor(System.Double,System.Double,System.Double,System.Double)">
  7916. <summary>
  7917. Construct this Cog3DQuaternion with the supplied W,X,Y,Z values.
  7918. </summary>
  7919. <param name="initialW">
  7920. The initial W value.
  7921. </param>
  7922. <param name="initialX">
  7923. The initial X value.
  7924. </param>
  7925. <param name="initialY">
  7926. The initial Y value.
  7927. </param>
  7928. <param name="initialZ">
  7929. The initial Z value.
  7930. </param>
  7931. </member>
  7932. <member name="T:Cognex.VisionPro3D.Cog3DQuaternion">
  7933. <summary>
  7934. This value class describes a quaternion representation and associated operations.
  7935. </summary>
  7936. <remarks>
  7937. <list type="bullet">
  7938. <item> This class is immutable - it may not be changed once
  7939. it has been constructed. </item>
  7940. <item> The default constructor creates a zero quaternion, which
  7941. is not valid for usage by Cog3DTransformRotation. </item>
  7942. <item> Although quaternions are useful in calculations involving 3D rotations, users
  7943. should use Cog3DTransformRotation for general 3D rotation operations. </item>
  7944. </list>
  7945. </remarks>
  7946. </member>
  7947. <member name="M:Cognex.VisionPro3D.Cog3DEulerZYZMovingAxes.RealEqual(Cognex.VisionPro3D.Cog3DEulerZYZMovingAxes,Cognex.VisionPro3D.Cog3DEulerZYZMovingAxes,System.Double)">
  7948. <inheritdoc cref="M:Cognex.VisionPro3D.ICog3DBase.RealEqual(System.Object,System.Object,System.Double)" />
  7949. </member>
  7950. <member name="M:Cognex.VisionPro3D.Cog3DEulerZYZMovingAxes.op_Inequality(Cognex.VisionPro3D.Cog3DEulerZYZMovingAxes,Cognex.VisionPro3D.Cog3DEulerZYZMovingAxes)">
  7951. <summary>
  7952. Compare two Cog3DEulerZYZMovingAxes.
  7953. </summary>
  7954. <param name="alpha">
  7955. The first Cog3DEulerZYZMovingAxes.
  7956. </param>
  7957. <param name="beta">
  7958. The second Cog3DEulerZYZMovingAxes.
  7959. </param>
  7960. <returns>
  7961. False if exactly equal, true otherwise.
  7962. </returns>
  7963. </member>
  7964. <member name="M:Cognex.VisionPro3D.Cog3DEulerZYZMovingAxes.op_Equality(Cognex.VisionPro3D.Cog3DEulerZYZMovingAxes,Cognex.VisionPro3D.Cog3DEulerZYZMovingAxes)">
  7965. <summary>
  7966. Compare two Cog3DEulerZYZMovingAxes.
  7967. </summary>
  7968. <param name="alpha">
  7969. The first Cog3DEulerZYZMovingAxes.
  7970. </param>
  7971. <param name="beta">
  7972. The second Cog3DEulerZYZMovingAxes.
  7973. </param>
  7974. <returns>
  7975. True if exactly equal, false otherwise.
  7976. </returns>
  7977. </member>
  7978. <member name="M:Cognex.VisionPro3D.Cog3DEulerZYZMovingAxes.ToString">
  7979. <inheritdoc cref="M:Cognex.VisionPro3D.ICog3DBase.ToString" />
  7980. </member>
  7981. <member name="P:Cognex.VisionPro3D.Cog3DEulerZYZMovingAxes.ZMovedAxis">
  7982. <summary>
  7983. Gets the ZMovedAxis component of the Cog3DEulerZYZMovingAxes
  7984. (rotation about the moved Z-axis in radians).
  7985. </summary>
  7986. <value>
  7987. The ZMovedAxis component of the Cog3DEulerZYZMovingAxes.
  7988. </value>
  7989. </member>
  7990. <member name="P:Cognex.VisionPro3D.Cog3DEulerZYZMovingAxes.Y">
  7991. <summary>
  7992. Gets the Y component of the Cog3DEulerZYZMovingAxes
  7993. (rotation about the moved Y-axis in radians).
  7994. </summary>
  7995. <value>
  7996. The Y component of the Cog3DEulerZYZMovingAxes.
  7997. </value>
  7998. </member>
  7999. <member name="P:Cognex.VisionPro3D.Cog3DEulerZYZMovingAxes.Z">
  8000. <summary>
  8001. Gets the Z component of the Cog3DEulerZYZMovingAxes
  8002. (rotation about the original Z-axis in radians).
  8003. </summary>
  8004. <value>
  8005. The Z component of the Cog3DEulerZYZMovingAxes.
  8006. </value>
  8007. </member>
  8008. <member name="M:Cognex.VisionPro3D.Cog3DEulerZYZMovingAxes.#ctor(System.Double,System.Double,System.Double)">
  8009. <summary>
  8010. Construct this Cog3DEulerZYZMovingAxes with the supplied components.
  8011. </summary>
  8012. <param name="angleZ">
  8013. The 'Z' component of the Cog3DEulerZYZMovingAxes (rotation about the original Z-axis in radians).
  8014. </param>
  8015. <param name="angleY">
  8016. The 'Y' component of the Cog3DEulerZYZMovingAxes (rotation about the moved Y-axis in radians).
  8017. </param>
  8018. <param name="angleZMovedAxis">
  8019. The 'ZMovedAxis' component of the Cog3DEulerZYZMovingAxes (rotation about the moved Z-axis in radians).
  8020. </param>
  8021. </member>
  8022. <member name="T:Cognex.VisionPro3D.Cog3DEulerZYZMovingAxes">
  8023. <summary>
  8024. <para> This value class holds an EulerZYZ of moving axes representation for a 3D rotation
  8025. transform . It holds three angles which express rotations about axes
  8026. of a mobile 3D coordinate system. It is used to express the orientation of one rotated
  8027. coordinate system (target XYZ-system) with respect to a fixed coordinate system (reference xyz-system).
  8028. </para>
  8029. <para> Starting with the target XYZ system coincident the reference xyz-system, the rotation of the target XYZ-system is expressed as:
  8030. <list type="bullet"><item> Rotate the target XYZ-system about the Z-axis.</item><item> Rotate the target XYZ-system about the now rotated Y-axis </item><item> Rotate the target XYZ-system about the new Z-axis. </item></list></para>
  8031. <para>
  8032. The default values for properties Z, Y, ZMovedAxis are 0.0.
  8033. </para>
  8034. </summary>
  8035. <remarks>
  8036. <list type="bullet">
  8037. <item> This class is immutable - it may not be changed once
  8038. it has been constructed. </item>
  8039. <item> This class is just a container class for initializing/getting the
  8040. Euler angles, and it does not handle rotation operations.
  8041. Please use Cog3DTransformRotation for general 3D rotation operations. </item>
  8042. </list>
  8043. </remarks>
  8044. </member>
  8045. <member name="M:Cognex.VisionPro3D.Cog3DEulerZYXMovingAxes.RealEqual(Cognex.VisionPro3D.Cog3DEulerZYXMovingAxes,Cognex.VisionPro3D.Cog3DEulerZYXMovingAxes,System.Double)">
  8046. <inheritdoc cref="M:Cognex.VisionPro3D.ICog3DBase.RealEqual(System.Object,System.Object,System.Double)" />
  8047. </member>
  8048. <member name="M:Cognex.VisionPro3D.Cog3DEulerZYXMovingAxes.op_Inequality(Cognex.VisionPro3D.Cog3DEulerZYXMovingAxes,Cognex.VisionPro3D.Cog3DEulerZYXMovingAxes)">
  8049. <summary>
  8050. Compare two Cog3DEulerZYXMovingAxes.
  8051. </summary>
  8052. <param name="alpha">
  8053. The first Cog3DEulerZYXMovingAxes.
  8054. </param>
  8055. <param name="beta">
  8056. The second Cog3DEulerZYXMovingAxes.
  8057. </param>
  8058. <returns>
  8059. False if exactly equal, true otherwise.
  8060. </returns>
  8061. </member>
  8062. <member name="M:Cognex.VisionPro3D.Cog3DEulerZYXMovingAxes.op_Equality(Cognex.VisionPro3D.Cog3DEulerZYXMovingAxes,Cognex.VisionPro3D.Cog3DEulerZYXMovingAxes)">
  8063. <summary>
  8064. Compare two Cog3DEulerZYXMovingAxes.
  8065. </summary>
  8066. <param name="alpha">
  8067. The first Cog3DEulerZYXMovingAxes.
  8068. </param>
  8069. <param name="beta">
  8070. The second Cog3DEulerZYXMovingAxes.
  8071. </param>
  8072. <returns>
  8073. True if exactly equal, false otherwise.
  8074. </returns>
  8075. </member>
  8076. <member name="M:Cognex.VisionPro3D.Cog3DEulerZYXMovingAxes.ToString">
  8077. <inheritdoc cref="M:Cognex.VisionPro3D.ICog3DBase.ToString" />
  8078. </member>
  8079. <member name="P:Cognex.VisionPro3D.Cog3DEulerZYXMovingAxes.Z">
  8080. <summary>
  8081. Gets the Z component of the Cog3DEulerZYXMovingAxes
  8082. (rotation about the moving Z-axis in radians).
  8083. </summary>
  8084. <value>
  8085. The Z component of the Cog3DEulerZYXMovingAxes
  8086. </value>
  8087. </member>
  8088. <member name="P:Cognex.VisionPro3D.Cog3DEulerZYXMovingAxes.Y">
  8089. <summary>
  8090. Gets the Y component of the Cog3DEulerZYXMovingAxes
  8091. (rotation about the moving Y-axis in radians).
  8092. </summary>
  8093. <value>
  8094. The Y component of the Cog3DEulerZYXMovingAxes
  8095. </value>
  8096. </member>
  8097. <member name="P:Cognex.VisionPro3D.Cog3DEulerZYXMovingAxes.X">
  8098. <summary>
  8099. Gets the X component of the Cog3DEulerZYXMovingAxes
  8100. (rotation about the moving X-axis in radians).
  8101. </summary>
  8102. <value>
  8103. The X component of the Cog3DEulerZYXMovingAxes
  8104. </value>
  8105. </member>
  8106. <member name="M:Cognex.VisionPro3D.Cog3DEulerZYXMovingAxes.#ctor(System.Double,System.Double,System.Double)">
  8107. <summary>
  8108. Construct this Cog3DEulerZYXMovingAxes with the supplied components.
  8109. </summary>
  8110. <param name="angleX">
  8111. The 'X' component of the Cog3DEulerZYXMovingAxes (rotation about the moving X axis in radians).
  8112. </param>
  8113. <param name="angleY">
  8114. The 'Y' component of the Cog3DEulerZYXMovingAxes (rotation about the moving Y-axis in radians).
  8115. </param>
  8116. <param name="angleZ">
  8117. The 'Z' component of the Cog3DEulerZYXMovingAxes (rotation about the moving Z-axis in radians).
  8118. </param>
  8119. </member>
  8120. <member name="T:Cognex.VisionPro3D.Cog3DEulerZYXMovingAxes">
  8121. <summary>
  8122. <para> This value class holds an EulerZYX of moving axes representation for a 3D rotation
  8123. transform . It holds three angles which express rotations about axes
  8124. of a mobile 3D coordinate system. It is used to express the orientation of one rotated
  8125. coordinate system (target XYZ-system) with respect to a fixed coordinate system (reference xyz-system).
  8126. </para>
  8127. <para> Starting with the target XYZ system coincident the reference xyz-system, the rotation of
  8128. the target XYZ-system is expressed as:
  8129. <list type="bullet"><item> Rotate the target XYZ-system about the Z-axis.</item><item> Rotate the target XYZ-system about the now rotated Y-axis </item><item> Rotate the target XYZ-system about the new X-axis. </item></list></para>
  8130. <para>
  8131. The default values for properties X, Y, Z are 0.0.
  8132. </para>
  8133. </summary>
  8134. <remarks>
  8135. <list type="bullet">
  8136. <item> This class is immutable - it may not be changed once
  8137. it has been constructed. </item>
  8138. <item> This class is just a container class for initializing/getting the
  8139. Euler angles, and it does not handle rotation operations.
  8140. Please use Cog3DTransformRotation for general 3D rotation operations. </item>
  8141. </list>
  8142. </remarks>
  8143. </member>
  8144. <member name="M:Cognex.VisionPro3D.Cog3DEulerXYZMovingAxes.RealEqual(Cognex.VisionPro3D.Cog3DEulerXYZMovingAxes,Cognex.VisionPro3D.Cog3DEulerXYZMovingAxes,System.Double)">
  8145. <inheritdoc cref="M:Cognex.VisionPro3D.ICog3DBase.RealEqual(System.Object,System.Object,System.Double)" />
  8146. </member>
  8147. <member name="M:Cognex.VisionPro3D.Cog3DEulerXYZMovingAxes.op_Inequality(Cognex.VisionPro3D.Cog3DEulerXYZMovingAxes,Cognex.VisionPro3D.Cog3DEulerXYZMovingAxes)">
  8148. <summary>
  8149. Compare two Cog3DEulerXYZMovingAxes.
  8150. </summary>
  8151. <param name="alpha">
  8152. The first Cog3DEulerXYZMovingAxes.
  8153. </param>
  8154. <param name="beta">
  8155. The second Cog3DEulerXYZMovingAxes.
  8156. </param>
  8157. <returns>
  8158. False if exactly equal, true otherwise.
  8159. </returns>
  8160. </member>
  8161. <member name="M:Cognex.VisionPro3D.Cog3DEulerXYZMovingAxes.op_Equality(Cognex.VisionPro3D.Cog3DEulerXYZMovingAxes,Cognex.VisionPro3D.Cog3DEulerXYZMovingAxes)">
  8162. <summary>
  8163. Compare two Cog3DEulerXYZMovingAxes.
  8164. </summary>
  8165. <param name="alpha">
  8166. The first Cog3DEulerXYZMovingAxes.
  8167. </param>
  8168. <param name="beta">
  8169. The second Cog3DEulerXYZMovingAxes.
  8170. </param>
  8171. <returns>
  8172. True if exactly equal, false otherwise.
  8173. </returns>
  8174. </member>
  8175. <member name="M:Cognex.VisionPro3D.Cog3DEulerXYZMovingAxes.ToString">
  8176. <inheritdoc cref="M:Cognex.VisionPro3D.ICog3DBase.ToString" />
  8177. </member>
  8178. <member name="P:Cognex.VisionPro3D.Cog3DEulerXYZMovingAxes.Z">
  8179. <summary>
  8180. Gets the Z component of the Cog3DEulerXYZMovingAxes
  8181. (rotation about the moving Z-axis in radians).
  8182. </summary>
  8183. <value>
  8184. The Z component of the Cog3DEulerXYZMovingAxes.
  8185. </value>
  8186. </member>
  8187. <member name="P:Cognex.VisionPro3D.Cog3DEulerXYZMovingAxes.Y">
  8188. <summary>
  8189. Gets the Y component of the Cog3DEulerXYZMovingAxes
  8190. (rotation about the moving Y-axis in radians).
  8191. </summary>
  8192. <value>
  8193. The Y component of the Cog3DEulerXYZMovingAxes.
  8194. </value>
  8195. </member>
  8196. <member name="P:Cognex.VisionPro3D.Cog3DEulerXYZMovingAxes.X">
  8197. <summary>
  8198. Gets the X component of the Cog3DEulerXYZMovingAxes
  8199. (rotation about the moving X-axis in radians).
  8200. </summary>
  8201. <value>
  8202. The X component of the Cog3DEulerXYZMovingAxes.
  8203. </value>
  8204. </member>
  8205. <member name="M:Cognex.VisionPro3D.Cog3DEulerXYZMovingAxes.#ctor(System.Double,System.Double,System.Double)">
  8206. <summary>
  8207. Construct this Cog3DEulerXYZMovingAxes with the supplied components.
  8208. </summary>
  8209. <param name="angleX">
  8210. The 'X' component of the Cog3DEulerXYZMovingAxes (rotation about the moving X-axis in radians).
  8211. </param>
  8212. <param name="angleY">
  8213. The 'Y' component of the Cog3DEulerXYZMovingAxes (rotation about the moving Y-axis in radians).
  8214. </param>
  8215. <param name="angleZ">
  8216. The 'Z' component of the Cog3DEulerXYZMovingAxes (rotation about the moving Z-axis in radians).
  8217. </param>
  8218. </member>
  8219. <member name="T:Cognex.VisionPro3D.Cog3DEulerXYZMovingAxes">
  8220. <summary>
  8221. <para> This value class holds an EulerXYZ of moving axes representation for a 3D rotation
  8222. transform . It holds three angles which express rotations about axes
  8223. of a mobile 3D coordinate system. It is used to express the orientation of one rotated
  8224. coordinate system (target XYZ-system) with respect to a fixed coordinate system (reference xyz-system).
  8225. </para>
  8226. <para> Starting with the target XYZ system coincident the reference xyz-system, the rotation of the target XYZ-system is expressed as:
  8227. <list type="bullet"><item> Rotate the target XYZ-system about the X-axis.</item><item> Rotate the target XYZ-system about the now rotated Y-axis </item><item> Rotate the target XYZ-system about the new Z-axis. </item></list></para>
  8228. <para>
  8229. The default values for properties X, Y, Z are 0.0.
  8230. </para>
  8231. </summary>
  8232. <remarks>
  8233. <list type="bullet">
  8234. <item> This class is immutable - it may not be changed once
  8235. it has been constructed. </item>
  8236. <item> This class is just a container class for initializing/getting the
  8237. Euler angles, and it does not handle rotation operations.
  8238. Please use Cog3DTransformRotation for general 3D rotation operations. </item>
  8239. </list>
  8240. </remarks>
  8241. </member>
  8242. <member name="M:Cognex.VisionPro3D.Cog3DEulerZYX.RealEqual(Cognex.VisionPro3D.Cog3DEulerZYX,Cognex.VisionPro3D.Cog3DEulerZYX,System.Double)">
  8243. <inheritdoc cref="M:Cognex.VisionPro3D.ICog3DBase.RealEqual(System.Object,System.Object,System.Double)" />
  8244. </member>
  8245. <member name="M:Cognex.VisionPro3D.Cog3DEulerZYX.op_Inequality(Cognex.VisionPro3D.Cog3DEulerZYX,Cognex.VisionPro3D.Cog3DEulerZYX)">
  8246. <summary>
  8247. Compare two Cog3DEulerZYX.
  8248. </summary>
  8249. <param name="alpha">
  8250. The first Cog3DEulerZYX.
  8251. </param>
  8252. <param name="beta">
  8253. The second Cog3DEulerZYX.
  8254. </param>
  8255. <returns>
  8256. False if exactly equal, true otherwise.
  8257. </returns>
  8258. </member>
  8259. <member name="M:Cognex.VisionPro3D.Cog3DEulerZYX.op_Equality(Cognex.VisionPro3D.Cog3DEulerZYX,Cognex.VisionPro3D.Cog3DEulerZYX)">
  8260. <summary>
  8261. Compare two Cog3DEulerZYX.
  8262. </summary>
  8263. <param name="alpha">
  8264. The first Cog3DEulerZYX.
  8265. </param>
  8266. <param name="beta">
  8267. The second Cog3DEulerZYX.
  8268. </param>
  8269. <returns>
  8270. True if exactly equal, false otherwise.
  8271. </returns>
  8272. </member>
  8273. <member name="M:Cognex.VisionPro3D.Cog3DEulerZYX.ToString">
  8274. <inheritdoc cref="M:Cognex.VisionPro3D.ICog3DBase.ToString" />
  8275. </member>
  8276. <member name="P:Cognex.VisionPro3D.Cog3DEulerZYX.Z">
  8277. <summary>
  8278. Gets the Z component of the Cog3DEulerZYX
  8279. (rotation about the fixed z-axis in radians).
  8280. </summary>
  8281. <value>
  8282. The Z component of the Cog3DEulerZYX.
  8283. </value>
  8284. </member>
  8285. <member name="P:Cognex.VisionPro3D.Cog3DEulerZYX.Y">
  8286. <summary>
  8287. Gets the Y component of the Cog3DEulerZYX
  8288. (rotation about the fixed y-axis in radians).
  8289. </summary>
  8290. <value>
  8291. The Y component of the Cog3DEulerZYX.
  8292. </value>
  8293. </member>
  8294. <member name="P:Cognex.VisionPro3D.Cog3DEulerZYX.X">
  8295. <summary>
  8296. Gets the X component of the Cog3DEulerZYX
  8297. (rotation about the fixed x-axis in radians).
  8298. </summary>
  8299. <value>
  8300. The X component of the Cog3DEulerZYX.
  8301. </value>
  8302. </member>
  8303. <member name="M:Cognex.VisionPro3D.Cog3DEulerZYX.#ctor(System.Double,System.Double,System.Double)">
  8304. <summary>
  8305. Construct this Cog3DEulerZYX (EulerZYX of fixed axes) with the supplied components.
  8306. </summary>
  8307. <param name="angleX">
  8308. The 'X' component of the Cog3DEulerZYX (rotation about the fixed x-axis in radians).
  8309. </param>
  8310. <param name="angleY">
  8311. The 'Y' component of the Cog3DEulerZYX (rotation about the fixed y-axis in radians).
  8312. </param>
  8313. <param name="angleZ">
  8314. The 'Z' component of the Cog3DEulerZYX (rotation about the fixed z-axis in radians).
  8315. </param>
  8316. </member>
  8317. <member name="T:Cognex.VisionPro3D.Cog3DEulerZYX">
  8318. <summary>
  8319. <para> This value class holds an EulerZYX of fixed axes representation
  8320. for a 3D rotation
  8321. transform. It holds three angles which express rotations about the fixed axes
  8322. of a 3D coordinate system. It is used to express the orientation of one
  8323. coordinate system (target frame) with respect to another (fixed reference frame).
  8324. </para>
  8325. <para> A rotation R of 3D coordinate axes is expressed as:
  8326. </para>
  8327. <para> R = Rx * Ry * Rz </para>
  8328. <para> Where </para>
  8329. <list type="bullet">
  8330. <item> Rz = rotation of xy-axes about fixed z-axis, </item>
  8331. <item> Ry = rotation of zx-axes about fixed y-axis, </item>
  8332. <item> Rx = rotation of yz-axes about fixed x-axis. </item>
  8333. </list>
  8334. <para>
  8335. The order of applying rotations is: Rz first, Ry second and Rx third.
  8336. </para>
  8337. <para>
  8338. The default values for properties X, Y, Z are 0.0.
  8339. </para>
  8340. </summary>
  8341. <remarks>
  8342. <list type="bullet">
  8343. <item> This class is immutable - it may not be changed once
  8344. it has been constructed. </item>
  8345. <item> This class is just a container class for initializing/getting the
  8346. Euler angles, and it does not handle rotation operations.
  8347. Please use Cog3DTransformRotation for general 3D rotation operations. </item>
  8348. </list>
  8349. </remarks>
  8350. </member>
  8351. <member name="M:Cognex.VisionPro3D.Cog3DEulerXYZ.RealEqual(Cognex.VisionPro3D.Cog3DEulerXYZ,Cognex.VisionPro3D.Cog3DEulerXYZ,System.Double)">
  8352. <inheritdoc cref="M:Cognex.VisionPro3D.ICog3DBase.RealEqual(System.Object,System.Object,System.Double)" />
  8353. </member>
  8354. <member name="M:Cognex.VisionPro3D.Cog3DEulerXYZ.op_Inequality(Cognex.VisionPro3D.Cog3DEulerXYZ,Cognex.VisionPro3D.Cog3DEulerXYZ)">
  8355. <summary>
  8356. Compare two Cog3DEulerXYZ.
  8357. </summary>
  8358. <param name="alpha">
  8359. The first Cog3EulerXYZ.
  8360. </param>
  8361. <param name="beta">
  8362. The second Cog3EulerXYZ.
  8363. </param>
  8364. <returns>
  8365. False if exactly equal, true otherwise.
  8366. </returns>
  8367. </member>
  8368. <member name="M:Cognex.VisionPro3D.Cog3DEulerXYZ.op_Equality(Cognex.VisionPro3D.Cog3DEulerXYZ,Cognex.VisionPro3D.Cog3DEulerXYZ)">
  8369. <summary>
  8370. Compare two Cog3DEulerXYZ.
  8371. </summary>
  8372. <param name="alpha">
  8373. The first Cog3EulerXYZ.
  8374. </param>
  8375. <param name="beta">
  8376. The second Cog3EulerXYZ.
  8377. </param>
  8378. <returns>
  8379. True if exactly equal, false otherwise.
  8380. </returns>
  8381. </member>
  8382. <member name="M:Cognex.VisionPro3D.Cog3DEulerXYZ.ToString">
  8383. <inheritdoc cref="M:Cognex.VisionPro3D.ICog3DBase.ToString" />
  8384. </member>
  8385. <member name="P:Cognex.VisionPro3D.Cog3DEulerXYZ.Z">
  8386. <summary>
  8387. Gets the Z component of the Cog3DEulerXYZ
  8388. (rotation about the fixed z-axis in radians).
  8389. </summary>
  8390. <value>
  8391. The Z component of the Cog3DEulerXYZ
  8392. </value>
  8393. </member>
  8394. <member name="P:Cognex.VisionPro3D.Cog3DEulerXYZ.Y">
  8395. <summary>
  8396. Gets the Y component of the Cog3DEulerXYZ
  8397. (rotation about the fixed y-axis in radians).
  8398. </summary>
  8399. <value>
  8400. The Y component of the Cog3DEulerXYZ
  8401. </value>
  8402. </member>
  8403. <member name="P:Cognex.VisionPro3D.Cog3DEulerXYZ.X">
  8404. <summary>
  8405. Gets the X component of the Cog3DEulerXYZ
  8406. (rotation about the fixed x-axis in radians).
  8407. </summary>
  8408. <value>
  8409. The X component of the Cog3DEulerXYZ
  8410. </value>
  8411. </member>
  8412. <member name="M:Cognex.VisionPro3D.Cog3DEulerXYZ.#ctor(System.Double,System.Double,System.Double)">
  8413. <summary>
  8414. Construct this Cog3DEulerXYZ (EulerXYZ of fixed axes) with the supplied components.
  8415. </summary>
  8416. <param name="angleX">
  8417. The 'X' component of the Cog3DEulerXYZ (rotation about the fixed x-axis in radians).
  8418. </param>
  8419. <param name="angleY">
  8420. The 'Y' component of the Cog3DEulerXYZ (rotation about the fixed y-axis in radians).
  8421. </param>
  8422. <param name="angleZ">
  8423. The 'Z' component of the Cog3DEulerXYZ (rotation about the fixed z-axis in radians).
  8424. </param>
  8425. </member>
  8426. <member name="T:Cognex.VisionPro3D.Cog3DEulerXYZ">
  8427. <summary>
  8428. <para> This value class holds an EulerXYZ of fixed axes representation
  8429. for a 3D rotation transform. It holds three angles which express rotations
  8430. about the fixed axes
  8431. of a 3D coordinate system. It is used to express the orientation of one
  8432. coordinate system (target frame) with respect to another (fixed reference frame).
  8433. </para>
  8434. <para> A rotation R of 3D coordinate axes is expressed as:
  8435. </para>
  8436. <para> R = Rz * Ry * Rx </para>
  8437. <para> Where </para>
  8438. <list type="bullet">
  8439. <item> Rz = rotation of xy-axes about fixed z-axis, </item>
  8440. <item> Ry = rotation of zx-axes about fixed y-axis, </item>
  8441. <item> Rx = rotation of yz-axes about fixed x-axis. </item>
  8442. </list>
  8443. <para>
  8444. The order of applying rotations is: Rx first, Ry second and Rz third.
  8445. </para>
  8446. <para>
  8447. The default values for properties X, Y, Z are 0.0.
  8448. </para>
  8449. </summary>
  8450. <remarks>
  8451. <list type="bullet">
  8452. <item> This class is immutable - it may not be changed once
  8453. it has been constructed. </item>
  8454. <item> This class is just a container class for initializing/getting the
  8455. Euler angles, and it does not handle rotation operations.
  8456. Please use Cog3DTransformRotation for general 3D rotation operations. </item>
  8457. </list>
  8458. </remarks>
  8459. </member>
  8460. <member name="M:Cognex.VisionPro3D.Cog3DVect3Collection.RemoveAt(System.Int32)">
  8461. <summary>
  8462. Remove the value at the specified index.
  8463. </summary>
  8464. <param name="index">
  8465. The zero based index at which the item is to be removed.
  8466. </param>
  8467. <exception cref="T:System.ArgumentOutOfRangeException">
  8468. If the supplied index is not valid.
  8469. </exception>
  8470. </member>
  8471. <member name="M:Cognex.VisionPro3D.Cog3DVect3Collection.Insert(System.Int32,Cognex.VisionPro3D.Cog3DVect3)">
  8472. <summary>
  8473. Insert the supplied item at the specified index.
  8474. </summary>
  8475. <param name="index">
  8476. The zero based index at which the item is to be inserted.
  8477. </param>
  8478. <param name="value">
  8479. The Cog3DVect3 value to be inserted at the specified index.
  8480. </param>
  8481. <exception cref="T:System.ArgumentOutOfRangeException">
  8482. If the supplied index is not valid.
  8483. </exception>
  8484. </member>
  8485. <member name="M:Cognex.VisionPro3D.Cog3DVect3Collection.IndexOf(Cognex.VisionPro3D.Cog3DVect3)">
  8486. <summary>
  8487. Find the first collection element that matches the supplied value,
  8488. returning the index.
  8489. </summary>
  8490. <param name="value">
  8491. The supplied value to match.
  8492. </param>
  8493. <returns>
  8494. The zero based index of the first matching element. If no match
  8495. is found this will be -1.
  8496. </returns>
  8497. </member>
  8498. <member name="P:Cognex.VisionPro3D.Cog3DVect3Collection.Item(System.Int32)">
  8499. <summary>
  8500. Gets or sets the item at the specified index.
  8501. </summary>
  8502. <param name="index">
  8503. The zero based index of the item of interest.
  8504. </param>
  8505. <param name="value">
  8506. The Cog3DVect3 value to be applied to the specified item.
  8507. </param>
  8508. <value>
  8509. The item at the specified index.
  8510. </value>
  8511. <exception cref="T:System.ArgumentOutOfRangeException">
  8512. If the supplied index is not valid.
  8513. </exception>
  8514. </member>
  8515. <member name="M:Cognex.VisionPro3D.Cog3DVect3Collection.Remove(Cognex.VisionPro3D.Cog3DVect3)">
  8516. <summary>
  8517. Remove the matching value. If no match is found, do nothing.
  8518. </summary>
  8519. <param name="value">
  8520. The Cog3DVect3 value to be removed from the collection.
  8521. </param>
  8522. <returns>
  8523. True if the item was successfully removed; false otherwise.
  8524. </returns>
  8525. </member>
  8526. <member name="M:Cognex.VisionPro3D.Cog3DVect3Collection.Contains(Cognex.VisionPro3D.Cog3DVect3)">
  8527. <summary>
  8528. Determine if this collection contains an element whose value
  8529. matches that of the specified value.
  8530. </summary>
  8531. <param name="value">
  8532. The Cog3DVect3 to match.
  8533. </param>
  8534. <returns>
  8535. True if the collection contains a matching element; false otherwise.
  8536. </returns>
  8537. </member>
  8538. <member name="M:Cognex.VisionPro3D.Cog3DVect3Collection.Clear">
  8539. <summary>
  8540. Delete any elements contained in this collection.
  8541. </summary>
  8542. </member>
  8543. <member name="M:Cognex.VisionPro3D.Cog3DVect3Collection.Add(Cognex.VisionPro3D.Cog3DVect3)">
  8544. <summary>
  8545. Appends the supplied item to the end of the collection.
  8546. </summary>
  8547. <param name="value">
  8548. The Cog3DVect3 to be added to this collection.
  8549. </param>
  8550. </member>
  8551. <member name="P:Cognex.VisionPro3D.Cog3DVect3Collection.IsReadOnly">
  8552. <summary>
  8553. Gets a value that indicates if this collection is read only.
  8554. </summary>
  8555. <value>
  8556. True if this collection is read only; otherwise false.
  8557. </value>
  8558. </member>
  8559. <member name="P:Cognex.VisionPro3D.Cog3DVect3Collection.Count">
  8560. <summary>
  8561. Gets the number of items in this collection.
  8562. </summary>
  8563. <value>
  8564. The number of items in this collection.
  8565. </value>
  8566. </member>
  8567. <member name="M:Cognex.VisionPro3D.Cog3DVect3Collection.CopyTo(Cognex.VisionPro3D.Cog3DVect3[],System.Int32)">
  8568. <summary>
  8569. Copies the contained set of Cog3DVect3's into the supplied, previously allocated
  8570. array of Cog3DVect3's starting at the specified index.
  8571. </summary>
  8572. <param name="arr">
  8573. The destination array of type Cog3DVect3. May not be null.
  8574. </param>
  8575. <param name="index">
  8576. A zero based index into the destination array at which copying
  8577. begins.
  8578. </param>
  8579. <exception cref="T:System.ArgumentNullException">
  8580. If <paramref name="arr" /> is null.
  8581. </exception>
  8582. <exception cref="T:System.ArgumentOutOfRangeException">
  8583. If the index argument is not valid.
  8584. </exception>
  8585. <exception cref="T:System.ArgumentException">
  8586. If the supplied array is not of rank 1.
  8587. </exception>
  8588. <exception cref="T:System.ArgumentException">
  8589. If the supplied array does not have zero based indexing.
  8590. </exception>
  8591. <exception cref="T:System.ArgumentException">
  8592. If the contained Cog3DVect3 will not fit into the destination
  8593. array starting at the specified index.
  8594. </exception>
  8595. </member>
  8596. <member name="M:Cognex.VisionPro3D.Cog3DVect3Collection.GetEnumerator">
  8597. <summary>
  8598. Gets an enumerator for this collection.
  8599. </summary>
  8600. <returns>
  8601. A reference to an IEnumerable suitable for this collection type.
  8602. </returns>
  8603. </member>
  8604. <member name="M:Cognex.VisionPro3D.Cog3DVect3Collection.Reserve(System.Int32)">
  8605. <summary>
  8606. If Capacity is less than the supplied value, set it.
  8607. </summary>
  8608. <param name="minimumCapacity">
  8609. The largest number of elements that this collection can
  8610. store without reallocation.
  8611. </param>
  8612. </member>
  8613. <member name="P:Cognex.VisionPro3D.Cog3DVect3Collection.Capacity">
  8614. <summary>
  8615. Gets the largest number of elements that this collection
  8616. can store without reallocation.
  8617. </summary>
  8618. <value>
  8619. The largest number of elements that this collection can
  8620. store without reallocation.
  8621. </value>
  8622. </member>
  8623. <member name="M:Cognex.VisionPro3D.Cog3DVect3Collection.GetObjectData(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
  8624. <inheritdoc cref="M:Cognex.VisionPro3D.ICog3DBase.GetObjectData(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)" />
  8625. </member>
  8626. <member name="M:Cognex.VisionPro3D.Cog3DVect3Collection.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
  8627. <inheritdoc cref="M:Cognex.VisionPro3D.ICog3DBase.SerializationConstructor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)" />
  8628. </member>
  8629. <member name="M:Cognex.VisionPro3D.Cog3DVect3Collection.Finalize">
  8630. <inheritdoc cref="M:Cognex.VisionPro3D.ICog3DBase.FinalizerForThisClass" />
  8631. </member>
  8632. <member name="M:Cognex.VisionPro3D.Cog3DVect3Collection.Dispose">
  8633. <inheritdoc cref="M:Cognex.VisionPro3D.ICog3DBase.DestructorForThisClass" />
  8634. </member>
  8635. <member name="M:Cognex.VisionPro3D.Cog3DVect3Collection.#ctor(Cognex.VisionPro3D.Cog3DVect3Collection)">
  8636. <summary>
  8637. Construct a deep copy of the supplied Cog3DVect3Collection.
  8638. </summary>
  8639. <param name="other">
  8640. The Cog3DVect3Collection object to be copied. May not be null.
  8641. </param>
  8642. <exception cref="T:System.ArgumentNullException">
  8643. If the input argument is null.
  8644. </exception>
  8645. </member>
  8646. <member name="M:Cognex.VisionPro3D.Cog3DVect3Collection.#ctor(System.Int32)">
  8647. <summary>
  8648. Construct this default (empty) Cog3DVect3Collection
  8649. with the specified capacity.
  8650. </summary>
  8651. </member>
  8652. <member name="M:Cognex.VisionPro3D.Cog3DVect3Collection.#ctor">
  8653. <summary>
  8654. Construct this default (empty) Cog3DVect3Collection.
  8655. </summary>
  8656. </member>
  8657. <member name="T:Cognex.VisionPro3D.Cog3DVect3Collection">
  8658. <summary>
  8659. This class holds a collection of Cog3DVect3.
  8660. </summary>
  8661. </member>
  8662. <member name="M:Cognex.VisionPro3D.Cog3DScalarCollection.RealEqual(Cognex.VisionPro3D.Cog3DScalarCollection,Cognex.VisionPro3D.Cog3DScalarCollection,System.Double)">
  8663. <inheritdoc cref="M:Cognex.VisionPro3D.ICog3DBase.RealEqual(System.Object,System.Object,System.Double)" />
  8664. </member>
  8665. <member name="M:Cognex.VisionPro3D.Cog3DScalarCollection.RemoveAt(System.Int32)">
  8666. <summary>
  8667. Remove the value at the specified index.
  8668. </summary>
  8669. <param name="index">
  8670. The zero based index at which the item is to be removed.
  8671. </param>
  8672. <exception cref="T:System.ArgumentOutOfRangeException">
  8673. If the supplied index is not valid.
  8674. </exception>
  8675. </member>
  8676. <member name="M:Cognex.VisionPro3D.Cog3DScalarCollection.Insert(System.Int32,System.Double)">
  8677. <summary>
  8678. Insert the supplied item at the specified index.
  8679. </summary>
  8680. <param name="index">
  8681. The zero based index at which the item is to be inserted.
  8682. </param>
  8683. <param name="value">
  8684. The double value to be inserted at the specified index.
  8685. </param>
  8686. <exception cref="T:System.ArgumentOutOfRangeException">
  8687. If the supplied index is not valid.
  8688. </exception>
  8689. </member>
  8690. <member name="M:Cognex.VisionPro3D.Cog3DScalarCollection.IndexOf(System.Double)">
  8691. <summary>
  8692. Find the first collection element that matches the supplied value,
  8693. returning the index.
  8694. </summary>
  8695. <param name="value">
  8696. The supplied value to match.
  8697. </param>
  8698. <returns>
  8699. The zero based index of the first matching element. If no match
  8700. is found this will be -1.
  8701. </returns>
  8702. </member>
  8703. <member name="P:Cognex.VisionPro3D.Cog3DScalarCollection.IsFixedSize">
  8704. <summary>
  8705. Gets a value that indicates if this collection is fixed size.
  8706. </summary>
  8707. <value>
  8708. True if this collection is fixed size; otherwise false.
  8709. </value>
  8710. </member>
  8711. <member name="P:Cognex.VisionPro3D.Cog3DScalarCollection.Item(System.Int32)">
  8712. <summary>
  8713. Gets or sets the item at the specified index.
  8714. </summary>
  8715. <param name="index">
  8716. The zero based index of the item of interest.
  8717. </param>
  8718. <param name="value">
  8719. The double value to be applied to the specified item.
  8720. </param>
  8721. <value>
  8722. The item at the specified index.
  8723. </value>
  8724. <exception cref="T:System.ArgumentOutOfRangeException">
  8725. If the supplied index is not valid.
  8726. </exception>
  8727. </member>
  8728. <member name="M:Cognex.VisionPro3D.Cog3DScalarCollection.Remove(System.Double)">
  8729. <summary>
  8730. Remove the matching value. If no match is found, do nothing.
  8731. </summary>
  8732. <param name="value">
  8733. The double value to be removed from the collection.
  8734. </param>
  8735. <returns>
  8736. True if the item was successfully removed; false otherwise.
  8737. </returns>
  8738. </member>
  8739. <member name="M:Cognex.VisionPro3D.Cog3DScalarCollection.Contains(System.Double)">
  8740. <summary>
  8741. Determine if this collection contains an element whose value
  8742. matches the supplied argument.
  8743. </summary>
  8744. <param name="value">
  8745. The double to match.
  8746. </param>
  8747. <returns>
  8748. True if the collection contains a matching element; false otherwise.
  8749. </returns>
  8750. </member>
  8751. <member name="M:Cognex.VisionPro3D.Cog3DScalarCollection.Clear">
  8752. <summary>
  8753. Delete any elements contained in this collection.
  8754. </summary>
  8755. </member>
  8756. <member name="M:Cognex.VisionPro3D.Cog3DScalarCollection.Add(System.Double)">
  8757. <summary>
  8758. Appends the supplied item to the end of the collection.
  8759. </summary>
  8760. <param name="value">
  8761. The Cog3DVect3 to be added to this collection.
  8762. </param>
  8763. </member>
  8764. <member name="P:Cognex.VisionPro3D.Cog3DScalarCollection.IsReadOnly">
  8765. <summary>
  8766. Gets a value that indicates if this collection is read only.
  8767. </summary>
  8768. <value>
  8769. True if this collection is read only; otherwise false.
  8770. </value>
  8771. </member>
  8772. <member name="P:Cognex.VisionPro3D.Cog3DScalarCollection.SyncRoot">
  8773. <summary>
  8774. Gets an object that can be used to synchronize access to the collection.
  8775. </summary>
  8776. <value>
  8777. The synchronization object.
  8778. </value>
  8779. </member>
  8780. <member name="P:Cognex.VisionPro3D.Cog3DScalarCollection.IsSynchronized">
  8781. <summary>
  8782. Gets a value indicating whether access to the collection is synchronized
  8783. (thread safe).
  8784. </summary>
  8785. <value>
  8786. True if access to the collection is synchronized (thread safe);
  8787. otherwise false.
  8788. </value>
  8789. </member>
  8790. <member name="P:Cognex.VisionPro3D.Cog3DScalarCollection.Count">
  8791. <summary>
  8792. Gets the number of items in this collection.
  8793. </summary>
  8794. <value>
  8795. The number of items in this collection.
  8796. </value>
  8797. </member>
  8798. <member name="M:Cognex.VisionPro3D.Cog3DScalarCollection.CopyTo(System.Double[],System.Int32)">
  8799. <summary>
  8800. Copies the contained double into the supplied, previously allocated
  8801. array of double starting at the specified index.
  8802. </summary>
  8803. <param name="arr">
  8804. The destination array of type double. May not be null.
  8805. </param>
  8806. <param name="index">
  8807. A zero based index into the destination array at which copying
  8808. begins.
  8809. </param>
  8810. <exception cref="T:System.ArgumentNullException">
  8811. If <paramref name="arr" /> is null.
  8812. </exception>
  8813. <exception cref="T:System.ArgumentOutOfRangeException">
  8814. If the index argument is not valid.
  8815. </exception>
  8816. <exception cref="T:System.ArgumentException">
  8817. If the supplied array is not of rank 1.
  8818. </exception>
  8819. <exception cref="T:System.ArgumentException">
  8820. If the supplied array does not have zero based indexing.
  8821. </exception>
  8822. <exception cref="T:System.ArgumentException">
  8823. If the contained double will not fit into the destination
  8824. array starting at the specified index.
  8825. </exception>
  8826. </member>
  8827. <member name="M:Cognex.VisionPro3D.Cog3DScalarCollection.GetEnumerator">
  8828. <summary>
  8829. Gets an enumerator for this collection.
  8830. </summary>
  8831. <returns>
  8832. A reference to an IEnumerable suitable for this collection type.
  8833. </returns>
  8834. </member>
  8835. <member name="M:Cognex.VisionPro3D.Cog3DScalarCollection.Reserve(System.Int32)">
  8836. <summary>
  8837. If Capacity is less than the supplied value, set it.
  8838. </summary>
  8839. <param name="minimumCapacity">
  8840. The largest number of elements that this collection can
  8841. store without reallocation.
  8842. </param>
  8843. </member>
  8844. <member name="P:Cognex.VisionPro3D.Cog3DScalarCollection.Capacity">
  8845. <summary>
  8846. Gets the largest number of elements that this collection
  8847. can store without reallocation.
  8848. </summary>
  8849. <value>
  8850. The largest number of elements that this collection can
  8851. store without reallocation.
  8852. </value>
  8853. </member>
  8854. <member name="M:Cognex.VisionPro3D.Cog3DScalarCollection.GetObjectData(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
  8855. <inheritdoc cref="M:Cognex.VisionPro3D.ICog3DBase.GetObjectData(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)" />
  8856. </member>
  8857. <member name="M:Cognex.VisionPro3D.Cog3DScalarCollection.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
  8858. <inheritdoc cref="M:Cognex.VisionPro3D.ICog3DBase.SerializationConstructor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)" />
  8859. </member>
  8860. <member name="M:Cognex.VisionPro3D.Cog3DScalarCollection.Finalize">
  8861. <inheritdoc cref="M:Cognex.VisionPro3D.ICog3DBase.FinalizerForThisClass" />
  8862. </member>
  8863. <member name="M:Cognex.VisionPro3D.Cog3DScalarCollection.Dispose">
  8864. <inheritdoc cref="M:Cognex.VisionPro3D.ICog3DBase.DestructorForThisClass" />
  8865. </member>
  8866. <member name="M:Cognex.VisionPro3D.Cog3DScalarCollection.#ctor(Cognex.VisionPro3D.Cog3DScalarCollection)">
  8867. <inheritdoc cref="M:Cognex.VisionPro3D.ICog3DBase.DeepCopyConstructorForThisClass(System.Object)" />
  8868. </member>
  8869. <member name="M:Cognex.VisionPro3D.Cog3DScalarCollection.#ctor(System.Int32)">
  8870. <summary>
  8871. Construct this default (empty) Cog3DScalarCollection
  8872. with the specified capacity.
  8873. </summary>
  8874. <param name="minimumCapacity">
  8875. The specified capacity of this collection.
  8876. </param>
  8877. </member>
  8878. <member name="M:Cognex.VisionPro3D.Cog3DScalarCollection.#ctor">
  8879. <summary>
  8880. Construct this default (empty) Cog3DScalarCollection.
  8881. </summary>
  8882. </member>
  8883. <member name="T:Cognex.VisionPro3D.Cog3DScalarCollection">
  8884. <summary>
  8885. This class holds a collection of double.
  8886. </summary>
  8887. </member>
  8888. <member name="M:Cognex.VisionPro3D.Cog3DVect2Collection.RemoveAt(System.Int32)">
  8889. <summary>
  8890. Remove the value at the specified index.
  8891. </summary>
  8892. <param name="index">
  8893. The zero based index at which the item is to be removed.
  8894. </param>
  8895. <exception cref="T:System.ArgumentOutOfRangeException">
  8896. If the supplied index is not valid.
  8897. </exception>
  8898. </member>
  8899. <member name="M:Cognex.VisionPro3D.Cog3DVect2Collection.Insert(System.Int32,Cognex.VisionPro3D.Cog3DVect2)">
  8900. <summary>
  8901. Insert the supplied item at the specified index.
  8902. </summary>
  8903. <param name="index">
  8904. The zero based index at which the item is to be inserted.
  8905. </param>
  8906. <param name="value">
  8907. The Cog3DVect2 value to be inserted at the specified index.
  8908. </param>
  8909. <exception cref="T:System.ArgumentOutOfRangeException">
  8910. If the supplied index is not valid.
  8911. </exception>
  8912. </member>
  8913. <member name="M:Cognex.VisionPro3D.Cog3DVect2Collection.IndexOf(Cognex.VisionPro3D.Cog3DVect2)">
  8914. <summary>
  8915. Find the first collection element that matches the supplied value,
  8916. returning the index.
  8917. </summary>
  8918. <param name="value">
  8919. The supplied value to match.
  8920. </param>
  8921. <returns>
  8922. The zero based index of the first matching element. If no match
  8923. is found this will be -1.
  8924. </returns>
  8925. </member>
  8926. <member name="P:Cognex.VisionPro3D.Cog3DVect2Collection.Item(System.Int32)">
  8927. <summary>
  8928. Gets or sets the item at the specified index.
  8929. </summary>
  8930. <param name="index">
  8931. The zero based index of the item of interest.
  8932. </param>
  8933. <param name="value">
  8934. The Cog3DVect2 value to be applied to the specified item.
  8935. </param>
  8936. <value>
  8937. The item at the specified index.
  8938. </value>
  8939. <exception cref="T:System.ArgumentOutOfRangeException">
  8940. If the supplied index is not valid.
  8941. </exception>
  8942. </member>
  8943. <member name="M:Cognex.VisionPro3D.Cog3DVect2Collection.Remove(Cognex.VisionPro3D.Cog3DVect2)">
  8944. <summary>
  8945. Remove the matching value. If no match is found, do nothing.
  8946. </summary>
  8947. <param name="value">
  8948. The Cog3DVect2 value to be removed from the collection.
  8949. </param>
  8950. <returns>
  8951. True if the item was successfully removed; false otherwise.
  8952. </returns>
  8953. </member>
  8954. <member name="M:Cognex.VisionPro3D.Cog3DVect2Collection.Contains(Cognex.VisionPro3D.Cog3DVect2)">
  8955. <summary>
  8956. Determine if this collection contains an element whose value
  8957. matches that of the specified value.
  8958. </summary>
  8959. <param name="value">
  8960. The Cog3DVect2 to match.
  8961. </param>
  8962. <returns>
  8963. True if the collection contains a matching element; false otherwise.
  8964. </returns>
  8965. </member>
  8966. <member name="M:Cognex.VisionPro3D.Cog3DVect2Collection.Clear">
  8967. <summary>
  8968. Delete any elements contained in this collection.
  8969. </summary>
  8970. </member>
  8971. <member name="M:Cognex.VisionPro3D.Cog3DVect2Collection.Add(Cognex.VisionPro3D.Cog3DVect2)">
  8972. <summary>
  8973. Appends the supplied item to the end of the collection.
  8974. </summary>
  8975. <param name="value">
  8976. The Cog3DVect2 to be added to this collection.
  8977. </param>
  8978. </member>
  8979. <member name="P:Cognex.VisionPro3D.Cog3DVect2Collection.IsReadOnly">
  8980. <summary>
  8981. Gets a value that indicates if this collection is read only.
  8982. </summary>
  8983. <value>
  8984. True if this collection is read only; otherwise false.
  8985. </value>
  8986. </member>
  8987. <member name="P:Cognex.VisionPro3D.Cog3DVect2Collection.Count">
  8988. <summary>
  8989. Gets the number of items in this collection.
  8990. </summary>
  8991. <value>
  8992. The number of items in this collection.
  8993. </value>
  8994. </member>
  8995. <member name="M:Cognex.VisionPro3D.Cog3DVect2Collection.CopyTo(Cognex.VisionPro3D.Cog3DVect2[],System.Int32)">
  8996. <summary>
  8997. Copies the contained set of Cog3DVect2's into the supplied, previously allocated
  8998. array of Cog3DVect2's starting at the specified index.
  8999. </summary>
  9000. <param name="arr">
  9001. The destination array of type Cog3DVect2. May not be null.
  9002. </param>
  9003. <param name="index">
  9004. A zero based index into the destination array at which copying
  9005. begins.
  9006. </param>
  9007. <exception cref="T:System.ArgumentNullException">
  9008. If <paramref name="arr" /> is null.
  9009. </exception>
  9010. <exception cref="T:System.ArgumentOutOfRangeException">
  9011. If the index argument is not valid.
  9012. </exception>
  9013. <exception cref="T:System.ArgumentException">
  9014. If the supplied array is not of rank 1.
  9015. </exception>
  9016. <exception cref="T:System.ArgumentException">
  9017. If the supplied array does not have zero based indexing.
  9018. </exception>
  9019. <exception cref="T:System.ArgumentException">
  9020. If the contained Cog3DVect2 will not fit into the destination
  9021. array starting at the specified index.
  9022. </exception>
  9023. </member>
  9024. <member name="M:Cognex.VisionPro3D.Cog3DVect2Collection.GetEnumerator">
  9025. <summary>
  9026. Gets an enumerator for this collection.
  9027. </summary>
  9028. <returns>
  9029. A reference to an IEnumerable suitable for this collection type.
  9030. </returns>
  9031. </member>
  9032. <member name="M:Cognex.VisionPro3D.Cog3DVect2Collection.Reserve(System.Int32)">
  9033. <summary>
  9034. If Capacity is less than the supplied value, set it.
  9035. </summary>
  9036. <param name="minimumCapacity">
  9037. The largest number of elements that this collection can
  9038. store without reallocation.
  9039. </param>
  9040. </member>
  9041. <member name="P:Cognex.VisionPro3D.Cog3DVect2Collection.Capacity">
  9042. <summary>
  9043. Gets the largest number of elements that this collection
  9044. can store without reallocation.
  9045. </summary>
  9046. <value>
  9047. The largest number of elements that this collection can
  9048. store without reallocation.
  9049. </value>
  9050. </member>
  9051. <member name="M:Cognex.VisionPro3D.Cog3DVect2Collection.GetObjectData(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
  9052. <inheritdoc cref="M:Cognex.VisionPro3D.ICog3DBase.GetObjectData(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)" />
  9053. </member>
  9054. <member name="M:Cognex.VisionPro3D.Cog3DVect2Collection.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
  9055. <inheritdoc cref="M:Cognex.VisionPro3D.ICog3DBase.SerializationConstructor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)" />
  9056. </member>
  9057. <member name="M:Cognex.VisionPro3D.Cog3DVect2Collection.Finalize">
  9058. <inheritdoc cref="M:Cognex.VisionPro3D.ICog3DBase.FinalizerForThisClass" />
  9059. </member>
  9060. <member name="M:Cognex.VisionPro3D.Cog3DVect2Collection.Dispose">
  9061. <inheritdoc cref="M:Cognex.VisionPro3D.ICog3DBase.DestructorForThisClass" />
  9062. </member>
  9063. <member name="M:Cognex.VisionPro3D.Cog3DVect2Collection.#ctor(Cognex.VisionPro3D.Cog3DVect2Collection)">
  9064. <inheritdoc cref="M:Cognex.VisionPro3D.ICog3DBase.DeepCopyConstructorForThisClass(System.Object)" />
  9065. </member>
  9066. <member name="M:Cognex.VisionPro3D.Cog3DVect2Collection.#ctor(System.Int32)">
  9067. <summary>
  9068. Construct this default (empty) Cog3DVect2Collection
  9069. with the specified capacity.
  9070. </summary>
  9071. </member>
  9072. <member name="M:Cognex.VisionPro3D.Cog3DVect2Collection.#ctor">
  9073. <summary>
  9074. Construct this default (empty) Cog3DVect2Collection.
  9075. </summary>
  9076. </member>
  9077. <member name="T:Cognex.VisionPro3D.Cog3DVect2Collection">
  9078. <summary>
  9079. This class holds a collection of Cog3DVect2.
  9080. </summary>
  9081. </member>
  9082. <member name="M:Cognex.VisionPro3D.Cog3DCollectionEventsBase.OnMovedItem(System.Int32,System.Int32)">
  9083. <summary>
  9084. Raises the MovedItem event.
  9085. </summary>
  9086. <param name="fromIndex">Source index of item moved.</param>
  9087. <param name="toIndex">gcnew index of item moved.</param>
  9088. </member>
  9089. <member name="M:Cognex.VisionPro3D.Cog3DCollectionEventsBase.OnMovingItem(System.Int32,System.Int32)">
  9090. <summary>
  9091. Raises the MovingItem event.
  9092. </summary>
  9093. <param name="fromIndex">Index of item being moved.</param>
  9094. <param name="toIndex">Destination index of item being moved.</param>
  9095. </member>
  9096. <member name="M:Cognex.VisionPro3D.Cog3DCollectionEventsBase.OnReplacedItem(System.Int32,System.Object,System.Object)">
  9097. <summary>
  9098. Raises the ReplacedItem event.
  9099. </summary>
  9100. <param name="index">Index of item replaced.</param>
  9101. <param name="oldValue">Value of item replaced.</param>
  9102. <param name="newValue">Value of item that replaced oldValue.</param>
  9103. </member>
  9104. <member name="M:Cognex.VisionPro3D.Cog3DCollectionEventsBase.OnReplacingItem(System.Int32,System.Object,System.Object)">
  9105. <summary>
  9106. Raises the ReplacingItem event.
  9107. </summary>
  9108. <param name="index">Index of item being replaced.</param>
  9109. <param name="oldValue">Value of item being replaced.</param>
  9110. <param name="newValue">Value of item replacing oldValue.</param>
  9111. </member>
  9112. <member name="M:Cognex.VisionPro3D.Cog3DCollectionEventsBase.OnRemovedItem(System.Int32,System.Object)">
  9113. <summary>
  9114. Raises the RemovedItem event.
  9115. </summary>
  9116. <param name="index">Index of item removed.</param>
  9117. <param name="value">Value of item removed.</param>
  9118. </member>
  9119. <member name="M:Cognex.VisionPro3D.Cog3DCollectionEventsBase.OnRemovingItem(System.Int32,System.Object)">
  9120. <summary>
  9121. Raises the RemovingItem event.
  9122. </summary>
  9123. <param name="index">Index of item being removed.</param>
  9124. <param name="value">Value of item being removed.</param>
  9125. </member>
  9126. <member name="M:Cognex.VisionPro3D.Cog3DCollectionEventsBase.OnInsertedItem(System.Int32,System.Object)">
  9127. <summary>
  9128. Raises the InsertedItem event.
  9129. </summary>
  9130. <param name="index">Index at which item was inserted.</param>
  9131. <param name="value">Value of item inserted.</param>
  9132. </member>
  9133. <member name="M:Cognex.VisionPro3D.Cog3DCollectionEventsBase.OnInsertingItem(System.Int32,System.Object)">
  9134. <summary>
  9135. Raises the InsertingItem event.
  9136. </summary>
  9137. <param name="index">Index to insert item being inserted.</param>
  9138. <param name="value">Value of item being inserted.</param>
  9139. </member>
  9140. <member name="M:Cognex.VisionPro3D.Cog3DCollectionEventsBase.OnCleared">
  9141. <summary>
  9142. Raises the Cleared event.
  9143. </summary>
  9144. </member>
  9145. <member name="M:Cognex.VisionPro3D.Cog3DCollectionEventsBase.OnClearing">
  9146. <summary>
  9147. Raises the Clearing event.
  9148. </summary>
  9149. </member>
  9150. <member name="E:Cognex.VisionPro3D.Cog3DCollectionEventsBase.MovedItem">
  9151. <summary>
  9152. Raised after an item is moved to a new index.
  9153. </summary>
  9154. </member>
  9155. <member name="E:Cognex.VisionPro3D.Cog3DCollectionEventsBase.MovingItem">
  9156. <summary>
  9157. Raised before an item is moved to a new index.
  9158. </summary>
  9159. </member>
  9160. <member name="E:Cognex.VisionPro3D.Cog3DCollectionEventsBase.ReplacedItem">
  9161. <summary>
  9162. Raised after an item is replaced.
  9163. </summary>
  9164. </member>
  9165. <member name="E:Cognex.VisionPro3D.Cog3DCollectionEventsBase.ReplacingItem">
  9166. <summary>
  9167. Raised before an item is replaced.
  9168. </summary>
  9169. </member>
  9170. <member name="E:Cognex.VisionPro3D.Cog3DCollectionEventsBase.RemovedItem">
  9171. <summary>
  9172. Raised after an item is removed.
  9173. </summary>
  9174. </member>
  9175. <member name="E:Cognex.VisionPro3D.Cog3DCollectionEventsBase.RemovingItem">
  9176. <summary>
  9177. Raised before an item is removed.
  9178. </summary>
  9179. </member>
  9180. <member name="E:Cognex.VisionPro3D.Cog3DCollectionEventsBase.InsertedItem">
  9181. <summary>
  9182. Raised after an item is inserted.
  9183. </summary>
  9184. </member>
  9185. <member name="E:Cognex.VisionPro3D.Cog3DCollectionEventsBase.InsertingItem">
  9186. <summary>
  9187. Raised before an item is inserted.
  9188. </summary>
  9189. </member>
  9190. <member name="E:Cognex.VisionPro3D.Cog3DCollectionEventsBase.Cleared">
  9191. <summary>
  9192. Raised after the collection is cleared.
  9193. </summary>
  9194. </member>
  9195. <member name="E:Cognex.VisionPro3D.Cog3DCollectionEventsBase.Clearing">
  9196. <summary>
  9197. Raised before the collection is cleared.
  9198. </summary>
  9199. </member>
  9200. <member name="M:Cognex.VisionPro3D.Cog3DCollectionEventsBase.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
  9201. <inheritdoc cref="M:Cognex.VisionPro3D.ICog3DBase.SerializationConstructor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)" />
  9202. </member>
  9203. <member name="F:Cognex.VisionPro3D.Cog3DCollectionEventsBase.SfCount">
  9204. <summary>
  9205. State flag for the Count property.
  9206. </summary>
  9207. </member>
  9208. <member name="F:Cognex.VisionPro3D.Cog3DCollectionEventsBase.SfItem">
  9209. <summary>
  9210. State flag for the Item (indexer) property.
  9211. </summary>
  9212. </member>
  9213. <member name="T:Cognex.VisionPro3D.Cog3DCollectionEventsBase">
  9214. <summary>
  9215. This class defines the changed events common to VPro 3D collection classes.
  9216. </summary>
  9217. </member>
  9218. <member name="M:Cognex.VisionPro3D.Cog3DVect3.RealEqual(Cognex.VisionPro3D.Cog3DVect3,Cognex.VisionPro3D.Cog3DVect3,System.Double)">
  9219. <inheritdoc cref="M:Cognex.VisionPro3D.ICog3DBase.RealEqual(System.Object,System.Object,System.Double)" />
  9220. </member>
  9221. <member name="M:Cognex.VisionPro3D.Cog3DVect3.op_Inequality(Cognex.VisionPro3D.Cog3DVect3,Cognex.VisionPro3D.Cog3DVect3)">
  9222. <summary>
  9223. Compare two Cog3DVect3.
  9224. </summary>
  9225. <param name="alpha">
  9226. The first vector.
  9227. </param>
  9228. <param name="beta">
  9229. The second vector.
  9230. </param>
  9231. <returns>
  9232. False if exactly equal, true otherwise.
  9233. </returns>
  9234. </member>
  9235. <member name="M:Cognex.VisionPro3D.Cog3DVect3.op_Equality(Cognex.VisionPro3D.Cog3DVect3,Cognex.VisionPro3D.Cog3DVect3)">
  9236. <summary>
  9237. Compare two Cog3DVect3.
  9238. </summary>
  9239. <param name="alpha">
  9240. The first vector.
  9241. </param>
  9242. <param name="beta">
  9243. The second vector.
  9244. </param>
  9245. <returns>
  9246. True if exactly equal, false otherwise.
  9247. </returns>
  9248. </member>
  9249. <member name="M:Cognex.VisionPro3D.Cog3DVect3.op_Division(Cognex.VisionPro3D.Cog3DVect3,System.Double)">
  9250. <summary>
  9251. Divide a Cog3DVect3 by a scalar.
  9252. </summary>
  9253. <param name="vect">
  9254. The vector.
  9255. </param>
  9256. <param name="denom">
  9257. The scalar divisor.
  9258. </param>
  9259. <returns>
  9260. The divided (scaled) vector.
  9261. </returns>
  9262. </member>
  9263. <member name="M:Cognex.VisionPro3D.Cog3DVect3.op_Multiply(Cognex.VisionPro3D.Cog3DVect3,System.Double)">
  9264. <summary>
  9265. Multiply a Cog3DVect3 by a scalar.
  9266. </summary>
  9267. <param name="vect">
  9268. The vector.
  9269. </param>
  9270. <param name="mult">
  9271. The scalar multiplier.
  9272. </param>
  9273. <returns>
  9274. The multiplied (scaled) vector.
  9275. </returns>
  9276. </member>
  9277. <member name="M:Cognex.VisionPro3D.Cog3DVect3.op_Subtraction(Cognex.VisionPro3D.Cog3DVect3,Cognex.VisionPro3D.Cog3DVect3)">
  9278. <summary>
  9279. Subtract two Cog3DVect3.
  9280. </summary>
  9281. <param name="alpha">
  9282. The first vector.
  9283. </param>
  9284. <param name="beta">
  9285. The second vector.
  9286. </param>
  9287. <returns>
  9288. The vector difference.
  9289. </returns>
  9290. </member>
  9291. <member name="M:Cognex.VisionPro3D.Cog3DVect3.op_Addition(Cognex.VisionPro3D.Cog3DVect3,Cognex.VisionPro3D.Cog3DVect3)">
  9292. <summary>
  9293. Add two Cog3DVect3.
  9294. </summary>
  9295. <param name="alpha">
  9296. The first vector.
  9297. </param>
  9298. <param name="beta">
  9299. The second vector.
  9300. </param>
  9301. <returns>
  9302. The vector sum.
  9303. </returns>
  9304. </member>
  9305. <member name="M:Cognex.VisionPro3D.Cog3DVect3.ToString">
  9306. <inheritdoc cref="M:Cognex.VisionPro3D.ICog3DBase.ToString" />
  9307. </member>
  9308. <member name="M:Cognex.VisionPro3D.Cog3DVect3.ComputeDistance(Cognex.VisionPro3D.Cog3DVect3)">
  9309. <summary>
  9310. Compute the distance of this Cog3DVect3 from the supplied <paramref name="other" />.
  9311. </summary>
  9312. <param name="other">
  9313. The other vector.
  9314. </param>
  9315. <returns>
  9316. The computed distance.
  9317. </returns>
  9318. </member>
  9319. <member name="M:Cognex.VisionPro3D.Cog3DVect3.ComputeDotProduct(Cognex.VisionPro3D.Cog3DVect3)">
  9320. <summary>
  9321. Compute the dot product of this Cog3DVect3 with the supplied <paramref name="other" />.
  9322. </summary>
  9323. <param name="other">
  9324. The other vector.
  9325. </param>
  9326. <returns>
  9327. The computed dot product.
  9328. </returns>
  9329. </member>
  9330. <member name="M:Cognex.VisionPro3D.Cog3DVect3.ComputeCrossProduct(Cognex.VisionPro3D.Cog3DVect3)">
  9331. <summary>
  9332. Compute the cross product of this Cog3DVect3 with the supplied <paramref name="other" />.
  9333. </summary>
  9334. <param name="other">
  9335. The other vector.
  9336. </param>
  9337. <returns>
  9338. The computed cross product vector.
  9339. </returns>
  9340. </member>
  9341. <member name="P:Cognex.VisionPro3D.Cog3DVect3.Length">
  9342. <summary>
  9343. Gets the length of this vector.
  9344. </summary>
  9345. <value>
  9346. The length of this vector.
  9347. </value>
  9348. </member>
  9349. <member name="P:Cognex.VisionPro3D.Cog3DVect3.Z">
  9350. <summary>
  9351. Gets the Z coordinate value.
  9352. </summary>
  9353. <value>
  9354. The Z coordinate value.
  9355. </value>
  9356. </member>
  9357. <member name="P:Cognex.VisionPro3D.Cog3DVect3.Y">
  9358. <summary>
  9359. Gets the Y coordinate value.
  9360. </summary>
  9361. <value>
  9362. The Y coordinate value.
  9363. </value>
  9364. </member>
  9365. <member name="P:Cognex.VisionPro3D.Cog3DVect3.X">
  9366. <summary>
  9367. Gets the X coordinate value.
  9368. </summary>
  9369. <value>
  9370. The X coordinate value.
  9371. </value>
  9372. </member>
  9373. <member name="M:Cognex.VisionPro3D.Cog3DVect3.#ctor(System.Double,System.Double,System.Double)">
  9374. <summary>
  9375. Construct this Cog3DVect3 with the supplied X,Y,Z values.
  9376. </summary>
  9377. <param name="initialX">
  9378. The initial X value.
  9379. </param>
  9380. <param name="initialY">
  9381. The initial Y value.
  9382. </param>
  9383. <param name="initialZ">
  9384. The initial Z value.
  9385. </param>
  9386. </member>
  9387. <member name="T:Cognex.VisionPro3D.Cog3DVect3">
  9388. <summary>
  9389. This value class encapsulates a three dimensional point or vector.
  9390. Note that this class is immutable - it may not be changed once
  9391. it has been constructed.
  9392. <para>
  9393. The default values for properties X, Y, and Z are 0.0.
  9394. </para></summary>
  9395. </member>
  9396. <member name="M:Cognex.VisionPro3D.Cog3DVect2.RealEqual(Cognex.VisionPro3D.Cog3DVect2,Cognex.VisionPro3D.Cog3DVect2,System.Double)">
  9397. <inheritdoc cref="M:Cognex.VisionPro3D.ICog3DBase.RealEqual(System.Object,System.Object,System.Double)" />
  9398. </member>
  9399. <member name="M:Cognex.VisionPro3D.Cog3DVect2.op_Inequality(Cognex.VisionPro3D.Cog3DVect2,Cognex.VisionPro3D.Cog3DVect2)">
  9400. <summary>
  9401. Compare two Cog3DVect2.
  9402. </summary>
  9403. <param name="alpha">
  9404. The first vector.
  9405. </param>
  9406. <param name="beta">
  9407. The second vector.
  9408. </param>
  9409. <returns>
  9410. False if exactly equal, true otherwise.
  9411. </returns>
  9412. </member>
  9413. <member name="M:Cognex.VisionPro3D.Cog3DVect2.op_Equality(Cognex.VisionPro3D.Cog3DVect2,Cognex.VisionPro3D.Cog3DVect2)">
  9414. <summary>
  9415. Compare two Cog3DVect2.
  9416. </summary>
  9417. <param name="alpha">
  9418. The first vector.
  9419. </param>
  9420. <param name="beta">
  9421. The second vector.
  9422. </param>
  9423. <returns>
  9424. True if exactly equal, false otherwise.
  9425. </returns>
  9426. </member>
  9427. <member name="M:Cognex.VisionPro3D.Cog3DVect2.op_Division(Cognex.VisionPro3D.Cog3DVect2,System.Double)">
  9428. <summary>
  9429. Divide a Cog3DVect2 by a scalar.
  9430. </summary>
  9431. <param name="vect">
  9432. The vector.
  9433. </param>
  9434. <param name="denom">
  9435. The scalar divisor.
  9436. </param>
  9437. <returns>
  9438. The divided (scaled) vector.
  9439. </returns>
  9440. </member>
  9441. <member name="M:Cognex.VisionPro3D.Cog3DVect2.op_Multiply(Cognex.VisionPro3D.Cog3DVect2,System.Double)">
  9442. <summary>
  9443. Multiply a Cog3DVect2 by a scalar.
  9444. </summary>
  9445. <param name="vect">
  9446. The vector.
  9447. </param>
  9448. <param name="mult">
  9449. The scalar multiplier.
  9450. </param>
  9451. <returns>
  9452. The multiplied (scaled) vector.
  9453. </returns>
  9454. </member>
  9455. <member name="M:Cognex.VisionPro3D.Cog3DVect2.op_Subtraction(Cognex.VisionPro3D.Cog3DVect2,Cognex.VisionPro3D.Cog3DVect2)">
  9456. <summary>
  9457. Subtract two Cog3DVect2.
  9458. </summary>
  9459. <param name="alpha">
  9460. The first vector.
  9461. </param>
  9462. <param name="beta">
  9463. The second vector.
  9464. </param>
  9465. <returns>
  9466. The vector difference.
  9467. </returns>
  9468. </member>
  9469. <member name="M:Cognex.VisionPro3D.Cog3DVect2.op_Addition(Cognex.VisionPro3D.Cog3DVect2,Cognex.VisionPro3D.Cog3DVect2)">
  9470. <summary>
  9471. Add two Cog3DVect2.
  9472. </summary>
  9473. <param name="alpha">
  9474. The first vector.
  9475. </param>
  9476. <param name="beta">
  9477. The second vector.
  9478. </param>
  9479. <returns>
  9480. The vector sum.
  9481. </returns>
  9482. </member>
  9483. <member name="M:Cognex.VisionPro3D.Cog3DVect2.ToString">
  9484. <inheritdoc cref="M:Cognex.VisionPro3D.ICog3DBase.ToString" />
  9485. </member>
  9486. <member name="M:Cognex.VisionPro3D.Cog3DVect2.ComputeDistance(Cognex.VisionPro3D.Cog3DVect2)">
  9487. <summary>
  9488. Compute the distance of this Cog3DVect2 from the supplied <paramref name="other" />.
  9489. </summary>
  9490. <param name="other">
  9491. The other vector.
  9492. </param>
  9493. <returns>
  9494. The computed distance.
  9495. </returns>
  9496. </member>
  9497. <member name="M:Cognex.VisionPro3D.Cog3DVect2.ComputeDotProduct(Cognex.VisionPro3D.Cog3DVect2)">
  9498. <summary>
  9499. Compute the dot product of this Cog3DVect2 with the supplied <paramref name="other" />.
  9500. </summary>
  9501. <param name="other">
  9502. The other vector.
  9503. </param>
  9504. <returns>
  9505. The computed dot product.
  9506. </returns>
  9507. </member>
  9508. <member name="M:Cognex.VisionPro3D.Cog3DVect2.ComputeCrossProduct(Cognex.VisionPro3D.Cog3DVect2)">
  9509. <summary>
  9510. Compute the cross product of this Cog3DVect2 with the supplied <paramref name="other" />.
  9511. </summary>
  9512. <param name="other">
  9513. The other vector.
  9514. </param>
  9515. <returns>
  9516. The computed cross product vector.
  9517. </returns>
  9518. </member>
  9519. <member name="P:Cognex.VisionPro3D.Cog3DVect2.Length">
  9520. <summary>
  9521. Gets the length of this vector.
  9522. </summary>
  9523. <value>
  9524. The length of this vector.
  9525. </value>
  9526. </member>
  9527. <member name="P:Cognex.VisionPro3D.Cog3DVect2.Y">
  9528. <summary>
  9529. Gets the Y coordinate value.
  9530. </summary>
  9531. <value>
  9532. The Y coordinate value.
  9533. </value>
  9534. </member>
  9535. <member name="P:Cognex.VisionPro3D.Cog3DVect2.X">
  9536. <summary>
  9537. Gets the X coordinate value.
  9538. </summary>
  9539. <value>
  9540. The X coordinate value.
  9541. </value>
  9542. </member>
  9543. <member name="M:Cognex.VisionPro3D.Cog3DVect2.#ctor(System.Double,System.Double)">
  9544. <summary>
  9545. Construct this Cog3DVect2 with the supplied X,Y values.
  9546. </summary>
  9547. <param name="initialX">
  9548. The initial X value.
  9549. </param>
  9550. <param name="initialY">
  9551. The initial Y value.
  9552. </param>
  9553. </member>
  9554. <member name="T:Cognex.VisionPro3D.Cog3DVect2">
  9555. <summary>
  9556. This value class encapsulates a two dimensional point or vector.
  9557. Note that this class is immutable - it may not be changed once
  9558. it has been constructed. The default values for properties X and Y are 0.0.
  9559. </summary>
  9560. </member>
  9561. <member name="T:Cognex.VisionPro3D.Cog3DInternalErrorException">
  9562. <summary>
  9563. The exception that is thrown when an internal error occurs during the operation of the
  9564. Cognex 3D vision tool.
  9565. </summary>
  9566. </member>
  9567. <member name="T:Cognex.VisionPro3D.Cog3DOperationCancelledByUserException">
  9568. <summary>
  9569. The exception that is thrown when the operation of the Cognex 3D vision tool is cancelled by
  9570. the user.
  9571. </summary>
  9572. </member>
  9573. <member name="T:Cognex.VisionPro3D.Cog3DZeroQuaternionException">
  9574. <summary>
  9575. The exception that is thrown when zero quaternion is used.
  9576. </summary>
  9577. </member>
  9578. <member name="T:Cognex.VisionPro3D.Cog3DException">
  9579. <summary>
  9580. This is the base class for all VisionPro3D exceptions.
  9581. It is a concrete class.
  9582. This base class allows clients to catch all VisionPro3D exceptions if they wish.
  9583. </summary>
  9584. </member>
  9585. <member name="P:Cognex.VisionPro3D.ICog3DBase.ResidualsPhys3DCalibration">
  9586. <remarks>
  9587. Residual error in Phys3D space is the distance between a ray of any 2D feature
  9588. (generated using the estimated camera calibration data) and its corresponding 3D feature.
  9589. </remarks>
  9590. </member>
  9591. <member name="P:Cognex.VisionPro3D.ICog3DBase.ResidualsRaw2DCalibration">
  9592. <remarks>
  9593. Residual error in Raw2D space is the distance from the found location of any
  9594. 2D feature in the image to the 2D location that you would expect if you took the
  9595. 3D feature and mapped it using the estimated camera calibration data.
  9596. </remarks>
  9597. </member>
  9598. <member name="M:Cognex.VisionPro3D.ICog3DBase.TriangulatorOrModelGenerator">
  9599. <remarks>
  9600. <para>
  9601. Residual error in Raw2D space is the distance from the found location of any
  9602. 2D feature in the image to the 2D location that you would expect if you took the
  9603. fitted 3D feature and mapped it using the camera calibration data.
  9604. </para>
  9605. <para>
  9606. Residual error in Phys3D space is the distance between a ray of any 2D feature
  9607. (generated using camera calibration data) and its corresponding fitted 3D feature.
  9608. </para>
  9609. </remarks>
  9610. </member>
  9611. <member name="P:Cognex.VisionPro3D.ICog3DBase.ResidualsRaw2D">
  9612. <summary>
  9613. Gets the 2D residual statistics of this result.
  9614. </summary>
  9615. <value>
  9616. Residual statistics of this result in Raw2D space.
  9617. </value>
  9618. <remarks>
  9619. Residual error in Raw2D space is the distance from the found location of any
  9620. 2D feature in the image to the 2D location that you would expect if you took the
  9621. mapped/fitted 3D feature and mapped it using the camera calibration data.
  9622. </remarks>
  9623. </member>
  9624. <member name="P:Cognex.VisionPro3D.ICog3DBase.ResidualsPhys3DUsing3DPoints">
  9625. <summary>
  9626. Gets the 3D residual statistics of this result.
  9627. </summary>
  9628. <value>
  9629. Residual statistics of this result in Phys3D space.
  9630. </value>
  9631. <remarks>
  9632. Residual error in Phys3D space is the distance between any input 3D point
  9633. and its corresponding mapped/fitted 3D feature.
  9634. </remarks>
  9635. </member>
  9636. <member name="P:Cognex.VisionPro3D.ICog3DBase.ResidualsPhys3D">
  9637. <summary>
  9638. Gets the 3D residual statistics of this result.
  9639. </summary>
  9640. <value>
  9641. Residual statistics of this result in Phys3D space.
  9642. </value>
  9643. <remarks>
  9644. Residual error in Phys3D space is the distance between a ray of any 2D feature
  9645. (generated using camera calibration data)
  9646. and its corresponding mapped/fitted 3D feature.
  9647. </remarks>
  9648. </member>
  9649. <member name="M:Cognex.VisionPro3D.ICog3DBase.DeepCopyConstructorForThisClass(System.Object)">
  9650. <summary>
  9651. Construct this object by making a deep copy of the supplied
  9652. object.
  9653. </summary>
  9654. <param name="other">
  9655. The object to be copied. May not be null.
  9656. </param>
  9657. <exception cref="T:System.ArgumentNullException">
  9658. If <paramref name="other" /> is null.
  9659. </exception>
  9660. </member>
  9661. <member name="M:Cognex.VisionPro3D.ICog3DBase.FinalizerForThisClass">
  9662. <summary>
  9663. Finalize this object.
  9664. </summary>
  9665. </member>
  9666. <member name="M:Cognex.VisionPro3D.ICog3DBase.DestructorForThisClass">
  9667. <summary>
  9668. Dispose this object.
  9669. </summary>
  9670. </member>
  9671. <member name="M:Cognex.VisionPro3D.ICog3DBase.SerializationConstructor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
  9672. <summary>
  9673. Serialization constructor.
  9674. </summary>
  9675. <param name="info">
  9676. The standard SerializationInfo argument.
  9677. </param>
  9678. <param name="ctxt">
  9679. The standard StreamingContext argument.
  9680. </param>
  9681. </member>
  9682. <member name="M:Cognex.VisionPro3D.ICog3DBase.GetObjectData(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
  9683. <summary>
  9684. Serializer for this object.
  9685. </summary>
  9686. <param name="info">
  9687. The standard SerializationInfo argument.
  9688. </param>
  9689. <param name="ctxt">
  9690. The standard StreamingContext argument.
  9691. </param>
  9692. </member>
  9693. <member name="M:Cognex.VisionPro3D.ICog3DBase.RealEqual(System.Object,System.Object,System.Double)">
  9694. <summary>
  9695. Compares the internal state of the specified instances and returns
  9696. true if the internal state is within epsilon.
  9697. </summary>
  9698. <param name="a">
  9699. The first instance of this class to use in the comparison.
  9700. </param>
  9701. <param name="b">
  9702. The second instance of this class to use in the comparison.
  9703. </param>
  9704. <param name="epsilon">
  9705. The tolerance to use in the comparison.
  9706. </param>
  9707. <returns>
  9708. True if the internal state of the specified instances is within epsilon.
  9709. </returns>
  9710. </member>
  9711. <member name="M:Cognex.VisionPro3D.ICog3DBase.ToString">
  9712. <summary>
  9713. Override of ToString method to get a string for describing this object.
  9714. </summary>
  9715. <returns>
  9716. A string describing this object.
  9717. </returns>
  9718. </member>
  9719. </members>
  9720. </doc>