STNodeEditor/docs/api.html at V2.0 · DebugST/STNodeEditor

History

1681 lines (1681 loc) · 173 KB

Raw

100

101

102

103

104

105

106

107

108

109

110

111

112

113

114

115

116

117

118

119

120

121

122

123

124

125

126

127

128

129

130

131

132

133

134

135

136

137

138

139

140

141

142

143

144

145

146

147

148

149

150

151

152

153

154

155

156

157

158

159

160

161

162

163

164

165

166

167

168

169

170

171

172

173

174

175

176

177

178

179

180

181

182

183

184

185

186

187

188

189

190

191

192

193

194

195

196

197

198

199

200

201

202

203

204

205

206

207

208

209

210

211

212

213

214

215

216

217

218

219

220

221

222

223

224

225

226

227

228

229

230

231

232

233

234

235

236

237

238

239

240

241

242

243

244

245

246

247

248

249

250

251

252

253

254

255

256

257

258

259

260

261

262

263

264

265

266

267

268

269

270

271

272

273

274

275

276

277

278

279

280

281

282

283

284

285

286

287

288

289

290

291

292

293

294

295

296

297

298

299

300

301

302

303

304

305

306

307

308

309

310

311

312

313

314

315

316

317

318

319

320

321

322

323

324

325

326

327

328

329

330

331

332

333

334

335

336

337

338

339

340

341

342

343

344

345

346

347

348

349

350

351

352

353

354

355

356

357

358

359

360

361

362

363

364

365

366

367

368

369

370

371

372

373

374

375

376

377

378

379

380

381

382

383

384

385

386

387

388

389

390

391

392

393

394

395

396

397

398

399

400

401

402

403

404

405

406

407

408

409

410

411

412

413

414

415

416

417

418

419

420

421

422

423

424

425

426

427

428

429

430

431

432

433

434

435

436

437

438

439

440

441

442

443

444

445

446

447

448

449

450

451

452

453

454

455

456

457

458

459

460

461

462

463

464

465

466

467

468

469

470

471

472

473

474

475

476

477

478

479

480

481

482

483

484

485

486

487

488

489

490

491

492

493

494

495

496

497

498

499

500

501

502

503

504

505

506

507

508

509

510

511

512

513

514

515

516

517

518

519

520

521

522

523

524

525

526

527

528

529

530

531

532

533

534

535

536

537

538

539

540

541

542

543

544

545

546

547

548

549

550

551

552

553

554

555

556

557

558

559

560

561

562

563

564

565

566

567

568

569

570

571

572

573

574

575

576

577

578

579

580

581

582

583

584

585

586

587

588

589

590

591

592

593

594

595

596

597

598

599

600

601

602

603

604

605

606

607

608

609

610

611

612

613

614

615

616

617

618

619

620

621

622

623

624

625

626

627

628

629

630

631

632

633

634

635

636

637

638

639

640

641

642

643

644

645

646

647

648

649

650

651

652

653

654

655

656

657

658

659

660

661

662

663

664

665

666

667

668

669

670

671

672

673

674

675

676

677

678

679

680

681

682

683

684

685

686

687

688

689

690

691

692

693

694

695

696

697

698

699

700

701

702

703

704

705

706

707

708

709

710

711

712

713

714

715

716

717

718

719

720

721

722

723

724

725

726

727

728

729

730

731

732

733

734

735

736

737

738

739

740

741

742

743

744

745

746

747

748

749

750

751

752

753

754

755

756

757

758

759

760

761

762

763

764

765

766

767

768

769

770

771

772

773

774

775

776

777

778

779

780

781

782

783

784

785

786

787

788

789

790

791

792

793

794

795

796

797

798

799

800

801

802

803

804

805

806

807

808

809

810

811

812

813

814

815

816

817

818

819

820

821

822

823

824

825

826

827

828

829

830

831

832

833

834

835

836

837

838

839

840

841

842

843

844

845

846

847

848

849

850

851

852

853

854

855

856

857

858

859

860

861

862

863

864

865

866

867

868

869

870

871

872

873

874

875

876

877

878

879

880

881

882

883

884

885

886

887

888

889

890

891

892

893

894

895

896

897

898

899

900

901

902

903

904

905

906

907

908

909

910

911

912

913

914

915

916

917

918

919

920

921

922

923

924

925

926

927

928

929

930

931

932

933

934

935

936

937

938

939

940

941

942

943

944

945

946

947

948

949

950

951

952

953

954

955

956

957

958

959

960

961

962

963

964

965

966

967

968

969

970

971

972

973

974

975

976

977

978

979

980

981

982

983

984

985

986

987

988

989

990

991

992

993

994

995

996

997

998

999

1000

<!DOCTYPE html>

<html>

<head>

<title>STNodeEditor - API</title>

</head>

<body>

<li>

<a class='a_node_root anchor_btn' anchor='a_a'>STNodeEditor</a>

<ul>

<li class='li_node_sub'><a class='anchor_btn' anchor='a_b'>Properties</a></li>

<li class='li_node_sub'><a class='anchor_btn' anchor='a_c'>Protected fields</a></li>

<li class='li_node_sub'><a class='anchor_btn' anchor='a_d'>Events</a></li>

<li class='li_node_sub'><a class='anchor_btn' anchor='a_e'>Virtual method</a></li>

<li class='li_node_sub'><a class='anchor_btn' anchor='a_f'>public method</a></li>

</ul>

</li>

<li>

<a class='a_node_root anchor_btn' anchor='a_g'>STNode</a>

<ul>

<li class='li_node_sub'><a class='anchor_btn' anchor='a_h'>Properties</a></li>

<li class='li_node_sub'><a class='anchor_btn' anchor='a_i'>Protected fields</a></li>

<li class='li_node_sub'><a class='anchor_btn' anchor='a_j'>Virtual method</a></li>

<li class='li_node_sub'><a class='anchor_btn' anchor='a_k'>public method</a></li>

</ul>

</li>

<li>

<a class='a_node_root anchor_btn' anchor='a_l'>STNodeOption</a>

<ul>

<li class='li_node_sub'><a class='anchor_btn' anchor='a_m'>Properties</a></li>

<li class='li_node_sub'><a class='anchor_btn' anchor='a_n'>Events</a></li>

<li class='li_node_sub'><a class='anchor_btn' anchor='a_o'>Constructor</a></li>

<li class='li_node_sub'><a class='anchor_btn' anchor='a_p'>Virtual method</a></li>

<li class='li_node_sub'><a class='anchor_btn' anchor='a_q'>public method</a></li>

</ul>

</li>

<li>

<a class='a_node_root anchor_btn' anchor='a_r'>STNodePropertyGrid</a>

<ul>

<li class='li_node_sub'><a class='anchor_btn' anchor='a_s'>Properties</a></li>

<li class='li_node_sub'><a class='anchor_btn' anchor='a_t'>Protected fields</a></li>

<li class='li_node_sub'><a class='anchor_btn' anchor='a_u'>Virtual method</a></li>

<li class='li_node_sub'><a class='anchor_btn' anchor='a_v'>public method</a></li>

</ul>

</li>

<li>

<a class='a_node_root anchor_btn' anchor='a_w'>STNodeTreeView</a>

<ul>

<li class='li_node_sub'><a class='anchor_btn' anchor='a_x'>Properties</a></li>

<li class='li_node_sub'><a class='anchor_btn' anchor='a_y'>Virtual method</a></li>

<li class='li_node_sub'><a class='anchor_btn' anchor='a_z'>public method</a></li>

</ul>

</li>

<li>

<a class='a_node_root anchor_btn' anchor='b_a'>STNodeTreeCollection</a>

<ul>

<li class='li_node_sub'><a class='anchor_btn' anchor='b_b'>Properties</a></li>

<li class='li_node_sub'><a class='anchor_btn' anchor='b_c'>Constructor</a></li>

<li class='li_node_sub'><a class='anchor_btn' anchor='b_d'>public method</a></li>

</ul>

</li>

<li>

<a class='a_node_root anchor_btn' anchor='b_e'>STNodeEditorPannel</a>

<ul>

<li class='li_node_sub'><a class='anchor_btn' anchor='b_f'>Properties</a></li>

<li class='li_node_sub'><a class='anchor_btn' anchor='b_g'>public method</a></li>

</ul>

</li>

<li>

<a class='a_node_root anchor_btn' anchor='b_h'>STNodeAttribute</a>

<ul>

<li class='li_node_sub'><a class='anchor_btn' anchor='b_i'>Properties</a></li>

<li class='li_node_sub'><a class='anchor_btn' anchor='b_j'>Constructor</a></li>

</ul>

</li>

<li>

<a class='a_node_root anchor_btn' anchor='b_k'>STNodePropertyAttribute</a>

<ul>

<li class='li_node_sub'><a class='anchor_btn' anchor='b_l'>Properties</a></li>

<li class='li_node_sub'><a class='anchor_btn' anchor='b_m'>Constructor</a></li>

</ul>

</li>

<li>

<a class='a_node_root anchor_btn' anchor='b_n'>STNodePropertyDescriptor</a>

<ul>

<li class='li_node_sub'><a class='anchor_btn' anchor='b_o'>Properties</a></li>

<li class='li_node_sub'><a class='anchor_btn' anchor='b_p'>Virtual method</a></li>

<li class='li_node_sub'><a class='anchor_btn' anchor='b_q'>public method</a></li>

</ul>

</li>

</ul>2021-04-29

</div>

<div>

<h1 class='h_title anchor_point' anchor='a_a'>STNodeEditor</h1>

<div><h2 class='h_option anchor_point' anchor='a_b'>Properties</h2></div>

<table>

<tr><th>Name</th><th>Type</th><th>Description</th></tr>

<tr><td>CanvasOffsetX</td><td>float</td><td>获取画布原点相对于控件 X 方向上的偏移位置</td></tr>

<tr class='tr_hight'><td>CanvasOffsetY</td><td>float</td><td>获取画布原点相对于控件 Y 方向上的偏移位置</td></tr>

<tr><td>CanvasOffset</td><td>PointF</td><td>获取画布原点相对于控件偏移位置</td></tr>

<tr class='tr_hight'><td>CanvasValidBounds</td><td>Rectangle</td><td>获取画布中的有被用到的有效区域</td></tr>

<tr><td>CanvasScale</td><td>float</td><td>获取画布的缩放比例</td></tr>

<tr class='tr_hight'><td>Curvature</td><td>float</td><td>获取或设置 Option 之间连线的曲度</td></tr>

<tr><td>ShowMagnet</td><td>bool</td><td>获取或设置移动画布中 Node 时候是否启用磁铁效果</td></tr>

<tr class='tr_hight'><td>ShowBorder</td><td>bool</td><td>获取或设置移动画布中是否显示 Node 边框</td></tr>

<tr><td>ShowGrid</td><td>bool</td><td>获取或设置画布中是否绘制背景网格线条</td></tr>

<tr class='tr_hight'><td>ShowLocation</td><td>bool</td><td>获取或设置是否在画布边缘显示超出视角的 Node 位置信息</td></tr>

<tr><td>Nodes</td><td>STNodeCollection</td><td>获取画布中 Node 集合</td></tr>

<tr class='tr_hight'><td>ActiveNode</td><td>STNode</td><td>获取当前画布中被选中的活动 Node</td></tr>

<tr><td>HoverNode</td><td>STNode</td><td>获取当前画布中鼠标悬停的 Node</td></tr>

<tr class='tr_hight'><td>GridColor</td><td>Color</td><td>获取或设置绘制画布背景时网格线条颜色</td></tr>

<tr><td>BorderColor</td><td>Color</td><td>获取或设置画布中 Node 边框颜色</td></tr>

<tr class='tr_hight'><td>BorderHoverColor</td><td>Color</td><td>获取或设置画布中悬停 Node 边框颜色</td></tr>

<tr><td>BorderSelectedColor</td><td>Color</td><td>获取或设置画布中选中 Node 边框颜色</td></tr>

<tr class='tr_hight'><td>BorderActiveColor</td><td>Color</td><td>获取或设置画布中活动 Node 边框颜色</td></tr>

<tr><td>MarkForeColor</td><td>Color</td><td>获取或设置画布绘制 Node 标记详情采用的前景色</td></tr>

<tr class='tr_hight'><td>MarkBackColor</td><td>Color</td><td>获取或设置画布绘制 Node 标记详情采用的背景色</td></tr>

<tr><td>MagnetColor</td><td>Color</td><td>获取或设置画布中移动 Node 时候磁铁标记颜色</td></tr>

<tr class='tr_hight'><td>SelectedRectangleColor</td><td>Color</td><td>获取或设置画布中选择矩形区域的颜色</td></tr>

<tr><td>HighLineColor</td><td>Color</td><td>获取或设置画布中高亮连线的颜色</td></tr>

<tr class='tr_hight'><td>LocationForeColor</td><td>Color</td><td>获取或设置画布中边缘位置提示区域前景色</td></tr>

<tr><td>LocationBackColor</td><td>Color</td><td>获取或设置画布中边缘位置提示区域背景色</td></tr>

<tr class='tr_hight'><td>UnknownTypeColor</td><td>Color</td><td>获取或设置画布中当 Node 中 Option 数据类型无法确定时应当使用的颜色</td></tr>

</table>

</div>

<div><h2 class='h_option anchor_point' anchor='a_c'>Protected fields</h2></div>

<table>

<tr><th>Name</th><th>Type</th><th>Description</th></tr>

<tr><td>m_pt_in_control</td><td>Point</td><td>当前鼠标在控件中的实时位置</td></tr>

<tr class='tr_hight'><td>m_pt_in_canvas</td><td>PointF</td><td>当前鼠标在画布中的实时位置</td></tr>

<tr><td>m_pt_down_in_control</td><td>Point</td><td>鼠标点击时在控件上的位置</td></tr>

<tr class='tr_hight'><td>m_pt_down_in_canvas</td><td>PointF</td><td>鼠标点击时在画布中的位置</td></tr>

<tr><td>m_pt_canvas_old</td><td>PointF</td><td>用于鼠标点击移动画布时候鼠标点下时候的画布坐标位置</td></tr>

<tr class='tr_hight'><td>m_pt_dot_down</td><td>Point</td><td>用于保存连线过程中保存点下 Option 的起点坐标</td></tr>

<tr><td>m_option_down</td><td>STNodeOption</td><td>用于保存连线过程中鼠标点下的起点Option 当MouseUP时候确定是否连接此节点</td></tr>

<tr class='tr_hight'><td>m_node_down</td><td>STNode</td><td>当前鼠标点下的 STNode</td></tr>

<tr><td>m_mouse_in_control</td><td>bool</td><td>当前鼠标是否位于控件中</td></tr>

</table>

</div>

<div><h2 class='h_option anchor_point' anchor='a_d'>Events</h2></div>

<table>

<tr><th>Name</th><th>Description</th></tr>

<tr><td>ActiveChanged</td><td>活动的节点发生变化时候发生</td></tr>

<tr class='tr_hight'><td>SelectedChanged</td><td>选择的节点发生变化时候发生</td></tr>

<tr><td>HoverChanged</td><td>悬停的节点发生变化时候发生</td></tr>

<tr class='tr_hight'><td>NodeAdded</td><td>当节点被添加时候发生</td></tr>

<tr><td>NodeRemoved</td><td>当节点被移除时候发生</td></tr>

<tr class='tr_hight'><td>CanvasMoved</td><td>移动画布原点时候发生</td></tr>

<tr><td>CanvasScaled</td><td>缩放画布时候发生</td></tr>

<tr class='tr_hight'><td>OptionConnected</td><td>连接节点选项时候发生</td></tr>

<tr><td>OptionConnecting</td><td>正在连接节点选项时候发生</td></tr>

<tr class='tr_hight'><td>OptionDisConnected</td><td>断开节点选项时候发生</td></tr>

<tr><td>OptionDisConnecting</td><td>正在断开节点选项时候发生</td></tr>

</table>

</div>

<div><h2 class='h_option anchor_point' anchor='a_e'>Virtual method</h2></div>

OnDrawGrid

/// 当绘制背景网格线时候发生

/// </summary>

/// <param name="dt">绘制工具</param>

/// <param name="nWidth">需要绘制宽度</param>

/// <param name="nHeight">需要绘制高度</param>

protected virtual void OnDrawGrid(DrawingTools dt, int nWidth, int nHeight);</pre>

</div>

OnDrawNode

/// 当绘制 Node 时候发生

/// </summary>

/// <param name="dt">绘制工具</param>

/// <param name="rect">可视画布区域大小</param>

protected virtual void OnDrawNode(DrawingTools dt, Rectangle rect);</pre>

</div>

OnDrawNodeBorder

/// 当绘制 Node 边框时候发生

/// </summary>

/// <param name="dt">绘制工具</param>

/// <param name="node">目标node</param>

protected virtual void OnDrawNodeBorder(DrawingTools dt, STNode node);</pre>

</div>

OnDrawConnectedLine

/// 当绘制已连接路径时候发生

/// </summary>

/// <param name="dt">绘制工具</param>

protected virtual void OnDrawConnectedLine(DrawingTools dt);</pre>

</div>

OnDrawMark

/// 当绘制 Mark 详情信息时候发生

/// </summary>

/// <param name="dt">绘制工具</param>

protected virtual void OnDrawMark(DrawingTools dt);</pre>

</div>

OnDrawMagnet

/// 当移动 Node 时候需要显示对齐参考线时候发生

/// </summary>

/// <param name="dt">绘制工具</param>

/// <param name="mi">匹配的磁铁信息</param>

protected virtual void OnDrawMagnet(DrawingTools dt, MagnetInfo mi);</pre>

</div>

OnDrawSelectedRectangle

/// 绘制选择的矩形区域

/// </summary>

/// <param name="dt">绘制工具</param>

/// <param name="rectf">位于控件上的矩形区域</param>

protected virtual void OnDrawSelectedRectangle(DrawingTools dt, RectangleF rectf);</pre>

</div>

OnDrawNodeOutLocation

/// 绘制超出视觉区域的 Node 位置提示信息

/// </summary>

/// <param name="dt">绘制工具</param>

/// <param name="sz">提示框边距</param>

/// <param name="lstPts">超出视觉区域的 Node 位置信息</param>

protected virtual void OnDrawNodeOutLocation(DrawingTools dt, Size sz, List<Point> lstPts);</pre>

</div>

OnDrawAlert

/// 绘制提示信息

/// </summary>

/// <param name="dt">绘制工具</param>

/// <param name="rect">需要绘制区域</param>

/// <param name="strText">需要绘制文本</param>

/// <param name="foreColor">信息前景色</param>

/// <param name="backColor">信息背景色</param>

/// <param name="al">信息位置</param>

protected virtual void OnDrawAlert(DrawingTools dt, Rectangle rect, string strText, Color foreColor, Color backColor, AlertLocation al);</pre>

</div>

GetAlertRectangle

/// 获取提示信息需要绘制的矩形区域

/// </summary>

/// <param name="g">绘图表面</param>

/// <param name="strText">需要绘制文本</param>

/// <param name="al">信息位置</param>

/// <returns>矩形区域</returns>

protected virtual Rectangle GetAlertRectangle(Graphics g, string strText, AlertLocation al);</pre>

</div>

<div><h2 class='h_option anchor_point' anchor='a_f'>public method</h2></div>

FindNodeFromPoint

/// 通过画布坐标进行寻找

/// </summary>

/// <param name="pt">画布中的坐标</param>

/// <returns>寻找到的数据</returns>

public NodeFindInfo FindNodeFromPoint(PointF pt);</pre>

</div>

GetSelectedNode

/// 获取已经被选择的 Node 集合

/// </summary>

/// <returns>Node 集合</returns>

public STNode[] GetSelectedNode();</pre>

</div>

CanvasToControl

/// 将画布坐标转换为控件坐标

/// </summary>

/// <param name="number">参数</param>

/// <param name="isX">是否为 X 坐标</param>

/// <returns>转换后的坐标</returns>

public float CanvasToControl(float number, bool isX);</pre>

</div>

CanvasToControl

/// 将画布坐标转换为控件坐标

/// </summary>

/// <param name="pt">坐标</param>

/// <returns>转换后的坐标</returns>

public PointF CanvasToControl(PointF pt);</pre>

</div>

CanvasToControl

/// 将画布坐标转换为控件坐标

/// </summary>

/// <param name="pt">坐标</param>

/// <returns>转换后的坐标</returns>

public Point CanvasToControl(Point pt);</pre>

</div>

CanvasToControl

/// 将画布坐标转换为控件坐标

/// </summary>

/// <param name="rect">矩形区域</param>

/// <returns>转换后的矩形区域</returns>

public Rectangle CanvasToControl(Rectangle rect);</pre>

</div>

CanvasToControl

/// 将画布坐标转换为控件坐标

/// </summary>

/// <param name="rect">矩形区域</param>

/// <returns>转换后的矩形区域</returns>

public RectangleF CanvasToControl(RectangleF rect);</pre>

</div>

ControlToCanvas

/// 将控件坐标转换为画布坐标

/// </summary>

/// <param name="number">参数</param>

/// <param name="isX">是否为 X 坐标</param>

/// <returns>转换后的坐标</returns>

public float ControlToCanvas(float number, bool isX);</pre>

</div>

ControlToCanvas

/// 将控件坐标转换为画布坐标

/// </summary>

/// <param name="pt">坐标</param>

/// <returns>转换后的坐标</returns>

public Point ControlToCanvas(Point pt);</pre>

</div>

ControlToCanvas

/// 将控件坐标转换为画布坐标

/// </summary>

/// <param name="pt">坐标</param>

/// <returns>转换后的坐标</returns>

public PointF ControlToCanvas(PointF pt);</pre>

</div>

ControlToCanvas

/// 将控件坐标转换为画布坐标

/// </summary>

/// <param name="rect">矩形区域</param>

/// <returns>转换后的区域</returns>

public Rectangle ControlToCanvas(Rectangle rect);</pre>

</div>

ControlToCanvas

/// 将控件坐标转换为画布坐标

/// </summary>

/// <param name="rect">矩形区域</param>

/// <returns>转换后的区域</returns>

public RectangleF ControlToCanvas(RectangleF rect);</pre>

</div>

MoveCanvas

/// 移动画布原点坐标到指定的控件坐标位置

/// 当不存在 Node 时候无法移动

/// </summary>

/// <param name="x">X 坐标</param>

/// <param name="y">Y 坐标</param>

/// <param name="bAnimation">移动过程中是否启动动画效果</param>

/// <param name="ma">指定需要修改的坐标参数</param>

public void MoveCanvas(float x, float y, bool bAnimation, CanvasMoveArgs ma);</pre>

</div>

ScaleCanvas

/// 缩放画布

/// 当不存在 Node 时候无法缩放

/// </summary>

/// <param name="f">缩放比例</param>

/// <param name="x">缩放中心X位于控件上的坐标</param>

/// <param name="y">缩放中心Y位于控件上的坐标</param>

public void ScaleCanvas(float f, float x, float y);</pre>

</div>

GetConnectionInfo

/// 获取当前已连接的 Option 对应关系

/// </summary>

/// <returns>连接信息集合</returns>

public ConnectionInfo[] GetConnectionInfo();</pre>

</div>

GetCanvasImage

/// 获取画布中指定矩形区域图像

/// </summary>

/// <param name="rect">画布中指定的矩形区域</param>

/// <returns>图像</returns>

public Image GetCanvasImage(Rectangle rect);</pre>

</div>

GetCanvasImage

/// 获取画布中指定矩形区域图像

/// </summary>

/// <param name="rect">画布中指定的矩形区域</param>

/// <param name="fScale">缩放比例</param>

/// <returns>图像</returns>

public Image GetCanvasImage(Rectangle rect, float fScale);</pre>

</div>

SaveCanvas

/// 保存画布中的类容到文件中

/// </summary>

/// <param name="strFileName">文件路径</param>

public void SaveCanvas(string strFileName);</pre>

</div>

SaveCanvas

/// 保存画布中的类容到数据流

/// </summary>

/// <param name="s">数据流对象</param>

public void SaveCanvas(Stream s);</pre>

</div>

GetCanvasData

/// 获取画布中内容二进制数据

/// </summary>

/// <returns>二进制数据</returns>

public byte[] GetCanvasData();</pre>

</div>

LoadAssembly

/// 加载程序集

/// </summary>

/// <param name="strFiles">程序集集合</param>

/// <returns>存在STNode类型的文件的个数</returns>

public int LoadAssembly(string[] strFiles);</pre>

</div>

LoadAssembly

/// 加载程序集

/// </summary>

/// <param name="strFile">指定需要加载的文件</param>

/// <returns>是否加载成功</returns>

public bool LoadAssembly(string strFile);</pre>

</div>

GetTypes

/// 获取当前编辑器中已加载的Node类型

/// </summary>

/// <returns>类型集合</returns>

public Type[] GetTypes();</pre>

</div>

LoadCanvas

/// 从文件中加载数据

/// 注意: 此方法并不会清空画布中数据而是数据叠加

/// </summary>

/// <param name="strFileName">文件路径</param>

public void LoadCanvas(string strFileName);</pre>

</div>

LoadCanvas

/// 从二进制加载数据

/// 注意: 此方法并不会清空画布中数据而是数据叠加

/// </summary>

/// <param name="byData">二进制数据</param>

public void LoadCanvas(byte[] byData);</pre>

</div>

LoadCanvas

/// 从数据流中加载数据

/// 注意: 此方法并不会清空画布中数据而是数据叠加

/// </summary>

/// <param name="s">数据流对象</param>

public void LoadCanvas(Stream s);</pre>

</div>

ShowAlert

/// 在画布中显示提示信息

/// </summary>

/// <param name="strText">要显示的信息</param>

/// <param name="foreColor">信息前景色</param>

/// <param name="backColor">信息背景色</param>

</div>

ShowAlert

/// 在画布中显示提示信息

/// </summary>

/// <param name="strText">要显示的信息</param>

/// <param name="foreColor">信息前景色</param>

/// <param name="backColor">信息背景色</param>

/// <param name="al">信息要显示的位置</param>

public void ShowAlert(string strText, Color foreColor, Color backColor, AlertLocation al);</pre>

</div>

ShowAlert

/// 在画布中显示提示信息

/// </summary>

/// <param name="strText">要显示的信息</param>

/// <param name="foreColor">信息前景色</param>

/// <param name="backColor">信息背景色</param>

/// <param name="nTime">信息持续时间</param>

/// <param name="al">信息要显示的位置</param>

/// <param name="bRedraw">是否立即重绘</param>

</div>

SetActiveNode

/// 设置画布中活动的节点

/// </summary>

/// <param name="node">需要被设置为活动的节点</param>

/// <returns>设置前的活动节点</returns>

public STNode SetActiveNode(STNode node);</pre>

</div>

AddSelectedNode

/// 向画布中添加一个被选中的节点

/// </summary>

/// <param name="node">需要被选中的节点</param>

/// <returns>是否添加成功</returns>

public bool AddSelectedNode(STNode node);</pre>

</div>

RemoveSelectedNode

/// 向画布中移除一个被选中的节点

/// </summary>

/// <param name="node">需要被移除的节点</param>

/// <returns>是移除否成功</returns>

public bool RemoveSelectedNode(STNode node);</pre>

</div>

SetTypeColor

/// 向编辑器中添加默认数据类型颜色

/// </summary>

/// <param name="t">数据类型</param>

/// <param name="clr">对应颜色</param>

/// <returns>被设置后的颜色</returns>

public Color SetTypeColor(Type t, Color clr);</pre>

</div>

SetTypeColor

/// 向编辑器中添加默认数据类型颜色

/// </summary>

/// <param name="t">数据类型</param>

/// <param name="clr">对应颜色</param>

/// <param name="bReplace">若已经存在是否替换颜色</param>

/// <returns>被设置后的颜色</returns>

</div>

<h1 class='h_title anchor_point' anchor='a_g'>STNode</h1>

<div><h2 class='h_option anchor_point' anchor='a_h'>Properties</h2></div>

<table>

<tr><th>Name</th><th>Type</th><th>Description</th></tr>

<tr><td>Owner</td><td>STNodeEditor</td><td>获取当前 Node 所有者</td></tr>

<tr class='tr_hight'><td>IsSelected</td><td>bool</td><td>获取或设置 Node 是否处于被选中状态</td></tr>

<tr><td>IsActive</td><td>bool</td><td>获取 Node 是否处于活动状态</td></tr>

<tr class='tr_hight'><td>TitleColor</td><td>Color</td><td>获取或设置标题背景颜色</td></tr>

<tr><td>MarkColor</td><td>Color</td><td>获取或设置标记信息背景颜色</td></tr>

<tr class='tr_hight'><td>ForeColor</td><td>Color</td><td>获取或设置当前 Node 前景色</td></tr>

<tr><td>BackColor</td><td>Color</td><td>获取或设置当前 Node 背景色</td></tr>

<tr class='tr_hight'><td>Title</td><td>string</td><td>获取或设置 Node 标题</td></tr>

<tr><td>Mark</td><td>string</td><td>获取或设置 Node 标记信息</td></tr>

<tr class='tr_hight'><td>Left</td><td>int</td><td>获取或设置 Node 左边坐标</td></tr>

<tr><td>Top</td><td>int</td><td>获取或设置 Node 上边坐标</td></tr>

<tr class='tr_hight'><td>Width</td><td>int</td><td>获取或设置 Node 宽度当AutoSize被设置时无法设置此值</td></tr>

<tr><td>Height</td><td>int</td><td>获取或设置 Node 高度当AutoSize被设置时无法设置此值</td></tr>

<tr class='tr_hight'><td>ItemHeight</td><td>int</td><td>获取或设置 Node 每个选项的高度</td></tr>

<tr><td>AutoSize</td><td>bool</td><td>获取或设置 Node 是否自动计算宽高</td></tr>

<tr class='tr_hight'><td>Right</td><td>int</td><td>获取 Node 右边边坐标</td></tr>

<tr><td>Bottom</td><td>int</td><td>获取 Node 下边坐标</td></tr>

<tr class='tr_hight'><td>Rectangle</td><td>Rectangle</td><td>获取 Node 矩形区域</td></tr>

<tr><td>TitleRectangle</td><td>Rectangle</td><td>获取 Node 标题矩形区域</td></tr>

<tr class='tr_hight'><td>MarkRectangle</td><td>Rectangle</td><td>获取 Node 标记矩形区域</td></tr>

<tr><td>TitleHeight</td><td>int</td><td>获取或设置 Node 标题高度</td></tr>

<tr class='tr_hight'><td>InputOptionsCount</td><td>int</td><td>获取输入选项集合个数</td></tr>

<tr><td>OutputOptionsCount</td><td>int</td><td>获取输出选项个数</td></tr>

<tr class='tr_hight'><td>ControlsCount</td><td>int</td><td>获取 Node 所包含的控件集合个数</td></tr>

<tr><td>Location</td><td>Point</td><td>获取 Node 坐标位置</td></tr>

<tr><td>LockOption</td><td>bool</td><td>获取或设置是否锁定Option选项锁定后不在接受连接</td></tr>

<tr class='tr_hight'><td>LockLocation</td><td>bool</td><td>获取或设置是否锁定Node位置锁定后不可移动</td></tr>

<tr><td>ContextMenuStrip</td><td>ContextMenuStrip</td><td>获取或设置当前Node 上下文菜单</td></tr>

<tr class='tr_hight'><td>Tag</td><td>object</td><td>获取或设置用户自定义保存的数据</td></tr>

<tr><td>Guid</td><td>Guid</td><td>获取全局唯一标识</td></tr>

<tr class='tr_hight'><td>LetGetOptions</td><td>bool</td><td>获取或设置是否允许外部访问STNodeOption</td></tr>

</table>

</div>

<div><h2 class='h_option anchor_point' anchor='a_i'>Protected fields</h2></div>

<table>

<tr><th>Name</th><th>Type</th><th>Description</th></tr>

<tr><td>m_ctrl_active</td><td>STNodeControl</td><td>当前Node中活动的控件</td></tr>

<tr class='tr_hight'><td>m_ctrl_hover</td><td>STNodeControl</td><td>当前Node中悬停的控件</td></tr>

<tr><td>m_ctrl_down</td><td>STNodeControl</td><td>当前Node中鼠标点下的控件</td></tr>

</table>

</div>

<div><h2 class='h_option anchor_point' anchor='a_j'>Virtual method</h2></div>

OnCreate

/// 当Node被构造时候发生

/// </summary>

protected virtual void OnCreate();</pre>

</div>

OnDrawNode

/// 绘制整个Node

/// </summary>

/// <param name="dt">绘制工具</param>

protected internal virtual void OnDrawNode(DrawingTools dt);</pre>

</div>

OnDrawTitle

/// 绘制Node标题部分

/// </summary>

/// <param name="dt">绘制工具</param>

protected virtual void OnDrawTitle(DrawingTools dt);</pre>

</div>

OnDrawBody

/// 绘制Node主体部分除去标题部分

/// </summary>

/// <param name="dt">绘制工具</param>

protected virtual void OnDrawBody(DrawingTools dt);</pre>

</div>

OnDrawMark

/// 绘制标记信息

/// </summary>

/// <param name="dt">绘制工具</param>

protected internal virtual void OnDrawMark(DrawingTools dt);</pre>

</div>

OnDrawOptionDot

/// 绘制选项连线的点

/// </summary>

/// <param name="dt">绘制工具</param>

/// <param name="op">指定的选项</param>

protected virtual void OnDrawOptionDot(DrawingTools dt, STNodeOption op);</pre>

</div>

OnDrawOptionText

/// 绘制选项的文本

/// </summary>

/// <param name="dt">绘制工具</param>

/// <param name="op">指定的选项</param>

protected virtual void OnDrawOptionText(DrawingTools dt, STNodeOption op);</pre>

</div>

OnSetOptionDotLocation

/// 当计算Option连线点位置时候发生

/// </summary>

/// <param name="op">需要计算的Option</param>

/// <param name="pt">自动计算出的位置</param>

/// <param name="nIndex">当前Option的索引</param>

/// <returns>新的位置</returns>

protected virtual Point OnSetOptionDotLocation(STNodeOption op, Point pt, int nIndex);</pre>

</div>

OnSetOptionTextRectangle

/// 当计算Option文本区域时候发生

/// </summary>

/// <param name="op">需要计算的Option</param>

/// <param name="rect">自动计算出的区域</param>

/// <param name="nIndex">当前Option的索引</param>

/// <returns>新的区域</returns>

protected virtual Rectangle OnSetOptionTextRectangle(STNodeOption op, Rectangle rect, int nIndex);</pre>

</div>

GetDefaultNodeSize

/// 获取当前STNode所需要的默认大小

/// 返回的大小并不会限制绘制区域任然可以在此区域之外绘制

/// 但是并不会被STNodeEditor所接受并触发对应事件

/// </summary>

/// <param name="g">绘图面板</param>

/// <returns>计算出来的大小</returns>

protected virtual Size GetDefaultNodeSize(Graphics g);</pre>

</div>

OnBuildMarkRectangle

/// 计算当前Mark所需要的矩形区域

/// 返回的大小并不会限制绘制区域任然可以在此区域之外绘制

/// 但是并不会被STNodeEditor所接受并触发对应事件

/// </summary>

/// <param name="g">绘图面板</param>

/// <returns>计算后的区域</returns>

</div>

OnSaveNode

/// 当需要保存时候此Node有哪些需要额外保存的数据

/// 注意: 保存时并不会进行序列化还原时候仅重新通过空参数构造器创建此Node

/// 然后调用 OnLoadNode() 将保存的数据进行还原

/// </summary>

/// <param name="dic">需要保存的数据</param>

protected virtual void OnSaveNode(Dictionary<string, byte[]> dic);</pre>

</div>

OnLoadNode

/// 当还原该节点时候会将 OnSaveNode() 所返回的数据重新传入此函数

/// </summary>

/// <param name="dic">保存时候的数据</param>

protected internal virtual void OnLoadNode(Dictionary<string, byte[]> dic);</pre>

</div>

OnEditorLoadCompleted

/// 当编辑器加载完成所有的节点时候发生

/// </summary>

</div>

SetOptionText

/// 设置Option的文本信息

/// </summary>

/// <param name="op">目标Option</param>

/// <param name="strText">文本</param>

/// <returns>是否成功</returns>

protected bool SetOptionText(STNodeOption op, string strText);</pre>

</div>

SetOptionTextColor

/// 设置Option文本信息颜色

/// </summary>

/// <param name="op">目标Option</param>

/// <param name="clr">颜色</param>

/// <returns>是否成功</returns>

protected bool SetOptionTextColor(STNodeOption op, Color clr);</pre>

</div>

SetOptionDotColor

/// 设置Option连线点颜色

/// </summary>

/// <param name="op">目标Option</param>

/// <param name="clr">颜色</param>

/// <returns>是否成功</returns>

protected bool SetOptionDotColor(STNodeOption op, Color clr);</pre>

</div>

OnOwnerChanged

/// 当所有者发生改变时候发生

/// </summary>

protected virtual void OnOwnerChanged();</pre>

</div>

OnSelectedChanged

/// 当选中状态改变时候发生

/// </summary>

protected virtual void OnSelectedChanged();</pre>

</div>

OnActiveChanged

/// 当活动状态改变时候发生

/// </summary>

protected virtual void OnActiveChanged();</pre>

</div>

SetOptionsLocation

/// 计算每个Option的位置

/// </summary>

protected virtual void SetOptionsLocation();</pre>

</div>

<div><h2 class='h_option anchor_point' anchor='a_k'>public method</h2></div>

Invalidate

/// 重绘Node

/// </summary>

public void Invalidate();</pre>

</div>

Invalidate

/// 重绘 Node 指定区域

/// </summary>

/// <param name="rect">Node 指定区域</param>

public void Invalidate(Rectangle rect);</pre>

</div>

GetInputOptions

/// 获取此Node所包含的输入Option集合

/// </summary>

/// <returns>Option集合</returns>

public STNodeOption[] GetInputOptions();</pre>

</div>

GetOutputOptions

/// 获取此Node所包含的输出Option集合

/// </summary>

/// <returns>Option集合</returns>

public STNodeOption[] GetOutputOptions();</pre>

</div>

SetSelected

/// 设置Node的选中状态

/// </summary>

/// <param name="bSelected">是否选中</param>

/// <param name="bRedraw">是否重绘</param>

public void SetSelected(bool bSelected, bool bRedraw);</pre>

</div>

<h1 class='h_title anchor_point' anchor='a_l'>STNodeOption</h1>

<div><h2 class='h_option anchor_point' anchor='a_m'>Properties</h2></div>

<table>

<tr><th>Name</th><th>Type</th><th>Description</th></tr>

<tr><td>Owner</td><td>STNode</td><td>获取当前 Option 所属的 Node</td></tr>

<tr class='tr_hight'><td>IsSingle</td><td>bool</td><td>获取当前 Option 是否仅能被连接一次</td></tr>

<tr><td>IsInput</td><td>bool</td><td>获取当前 Option 是否是输入选项</td></tr>

<tr class='tr_hight'><td>TextColor</td><td>Color</td><td>获取或设置当前 Option 文本颜色</td></tr>

<tr><td>DotColor</td><td>Color</td><td>获取或设置当前 Option 连接点的颜色</td></tr>

<tr class='tr_hight'><td>Text</td><td>string</td><td>获取或设置当前 Option 显示文本当AutoSize被设置时无法修改此属性</td></tr>

<tr><td>DotLeft</td><td>int</td><td>获取当前 Option 连接点的左边坐标</td></tr>

<tr class='tr_hight'><td>DotTop</td><td>int</td><td>获取当前 Option 连接点的上边坐标</td></tr>

<tr><td>DotSize</td><td>int</td><td>获取当前 Option 连接点的宽度</td></tr>

<tr class='tr_hight'><td>TextRectangle</td><td>Rectangle</td><td>获取当前 Option 文本区域</td></tr>

<tr><td>Data</td><td>object</td><td>获取或者设置当前 Option 所包含的数据</td></tr>

<tr class='tr_hight'><td>DataType</td><td>Type</td><td>获取当前 Option 数据类型</td></tr>

<tr><td>DotRectangle</td><td>Rectangle</td><td>获取当前 Option 连接点的区域</td></tr>

<tr class='tr_hight'><td>ConnectionCount</td><td>int</td><td>获取当前 Option 被连接的个数</td></tr>

</table>

</div>

<div><h2 class='h_option anchor_point' anchor='a_n'>Events</h2></div>

<table>

<tr><th>Name</th><th>Description</th></tr>

<tr><td>Connected</td><td>当被连接时候发生</td></tr>

<tr class='tr_hight'><td>Connecting</td><td>当连接开始发生时发生</td></tr>

<tr><td>DisConnected</td><td>当连接断开时候发生</td></tr>

<tr class='tr_hight'><td>DisConnecting</td><td>当连接开始断开时发生</td></tr>

<tr><td>DataTransfer</td><td>当有数据传递时候发生</td></tr>

</table>

</div>

<div><h2 class='h_option anchor_point' anchor='a_o'>Constructor</h2></div>

Constructor

/// 构造一个 Option

/// </summary>

/// <param name="strText">显示文本</param>

/// <param name="dataType">数据类型</param>

/// <param name="bSingle">是否为单连接</param>

public STNodeOption(string strText, Type dataType, bool bSingle);</pre>

</div>

<div><h2 class='h_option anchor_point' anchor='a_p'>Virtual method</h2></div>

Invalidate

/// 重绘整个控件

/// </summary>

protected void Invalidate();</pre>

</div>

ConnectingOption

/// 当前 Option 开始连接目标 Option

/// </summary>

/// <param name="op">需要连接的 Option</param>

/// <returns>是否允许继续操作</returns>

protected virtual bool ConnectingOption(STNodeOption op);</pre>

</div>

DisConnectingOption

/// 当前 Option 开始断开目标 Option

/// </summary>

/// <param name="op">需要断开的 Option</param>

/// <returns>是否允许继续操作</returns>

protected virtual bool DisConnectingOption(STNodeOption op);</pre>

</div>

<div><h2 class='h_option anchor_point' anchor='a_q'>public method</h2></div>

DisConnectionAll

/// 断开当前 Option 的所有连接

/// </summary>

public void DisConnectionAll();</pre>

</div>

GetConnectedOption

/// 获取当前 Option 所连接的 Option 集合

/// </summary>

/// <returns>如果为null 则表示不存在所有者否则返回集合</returns>

public List<STNodeOption> GetConnectedOption();</pre>

</div>

TransferData

/// 向当前 Option 所连接的所有 Option 投递数据

/// </summary>

public void TransferData();</pre>

</div>

TransferData

/// 向当前 Option 所连接的所有 Option 投递数据

/// </summary>

/// <param name="data">需要投递的数据</param>

public void TransferData(object data);</pre>

</div>

TransferData

/// 向当前 Option 所连接的所有 Option 投递数据

/// </summary>

/// <param name="data">需要投递的数据</param>

/// <param name="bDisposeOld">是否释放旧数据</param>

public void TransferData(object data, bool bDisposeOld);</pre>

</div>

<h1 class='h_title anchor_point' anchor='a_r'>STNodePropertyGrid</h1>

<div><h2 class='h_option anchor_point' anchor='a_s'>Properties</h2></div>

<table>

<tr><th>Name</th><th>Type</th><th>Description</th></tr>

<tr><td>STNode</td><td>STNode</td><td>当前显示的STNode</td></tr>

<tr class='tr_hight'><td>ItemHoverColor</td><td>Color</td><td>获取或设置属性选项被鼠标悬停时候背景色</td></tr>

<tr><td>ItemSelectedColor</td><td>Color</td><td>获取或设置属性选项被选中时候背景色当AutoColor被设置时此属性不能被设置</td></tr>

<tr class='tr_hight'><td>ItemValueBackColor</td><td>Color</td><td>获取或设置属性选项值背景色</td></tr>

<tr><td>TitleColor</td><td>Color</td><td>获取或设置默认标题背景色</td></tr>

<tr class='tr_hight'><td>ErrorColor</td><td>Color</td><td>获取或设置属性设置错误时候提示信息背景色</td></tr>

<tr><td>DescriptionColor</td><td>Color</td><td>获取或设置属性描述信息背景色</td></tr>

<tr class='tr_hight'><td>ShowTitle</td><td>bool</td><td>获取或设置是否显示节点标题</td></tr>

<tr><td>AutoColor</td><td>bool</td><td>获取或设置是否根据STNode自动设置控件高亮颜色</td></tr>

<tr class='tr_hight'><td>InfoFirstOnDraw</td><td>bool</td><td>获取或当节点被设置时候是否优先绘制信息面板</td></tr>

<tr><td>ReadOnlyModel</td><td>bool</td><td>获取或设置当前属性编辑器是否处于只读模式</td></tr>

<tr class='tr_hight'><td>ScrollOffset</td><td>int</td><td>获取当前滚动条高度</td></tr>

</table>

</div>

<div><h2 class='h_option anchor_point' anchor='a_t'>Protected fields</h2></div>

<table>

<tr><th>Name</th><th>Type</th><th>Description</th></tr>

<tr><td>m_rect_link</td><td>Rectangle</td><td>作者链接地址区域</td></tr>

<tr class='tr_hight'><td>m_rect_help</td><td>Rectangle</td><td>查看帮助按钮区域</td></tr>

<tr><td>m_rect_title</td><td>Rectangle</td><td>编辑器标题区域</td></tr>

<tr class='tr_hight'><td>m_rect_switch</td><td>Rectangle</td><td>面板切换按钮区域</td></tr>

<tr><td>m_nOffsetY</td><td>int</td><td>控件在绘制过程中使用的垂直滚动偏移</td></tr>

<tr class='tr_hight'><td>m_nInfoOffsetY</td><td>int</td><td>保存的信息面板垂直滚动偏移</td></tr>

<tr><td>m_nPropertyOffsetY</td><td>int</td><td>保存的属性面板垂直滚动偏移</td></tr>

<tr class='tr_hight'><td>m_nVHeight</td><td>int</td><td>控件在绘制过程中使用的绘图区域总高度</td></tr>

<tr><td>m_nInfoVHeight</td><td>int</td><td>保存的信息面板需要的总高度</td></tr>

<tr class='tr_hight'><td>m_nPropertyVHeight</td><td>int</td><td>保存的属性面板需要的总高度</td></tr>

View remainder of file in raw view

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

FilesExpand file tree

api.html

Latest commit

History

api.html

File metadata and controls