dolphin.authoring · class ·

dolphinAuthoringSession

A dolphin authoring session record carrying document, runtime, undo, selection, mode, and related state.

authoringclasscpudolphindolphin.authoringmethodsource-example

Represent editable scenes and graph canvases, validate edits, and manage undoable transactions.

external class dolphinAuthoringSession

Status: source-declared

Fields and methods (18)
dolphinSceneDocument document
Stores document as dolphinSceneDocument.
dolphinSceneDocument runtime
Stores runtime as dolphinSceneDocument.
list of dolphinSceneDocument undo
Stores undo as list of dolphinSceneDocument.
list of int selection
Stores selection as list of int.
int mode
Stores mode as int.
text status
Stores status as text.
dolphinAuthoringSession(dolphinSceneDocument document)
Dolphin authoring session.
Selected(int id) returns bool
Selected. Complete example
Select(int id,bool additive)
Select. Complete example
Commit(dolphinSceneDocument next,text action) returns bool
Commit. Complete example
Undo()
Undo. Complete example
Redo()
Redo. Complete example
Attach(int component) returns bool
Attach. Complete example
Reference(int target) returns bool
Reference. Complete example
Play()
Play. Complete example
Pause()
Pause. Complete example
Stop()
Stop. Complete example
Step()
Step. Complete example

Use dolphinAuthoringSession

A complete small caller. Values are illustrative; check the returned result and package requirements before connecting live resources.

cpu · source-example · type checked

using dolphin.authoring

// Represent editable scenes and graph canvases, validate edits, and manage undoable transactions.
dolphinAuthoringSession sample = dolphinAuthoringSession(dolphinSceneDocument())
Console.Log(Text.From(sample.mode))
project.mech
manifestVersion = "2"
package = "api.example.dolphin_authoring__dolphinauthoringsession"
version = "0.1.0"
languageEdition = "yeho-core-2026.1"

[app]
kind = "headless"

[[dependencies]]
package = "dolphin.authoring"
version = "0.1.0"
path = "../../../dolphin/packages/authoring"

[[dependencies]]
package = "dolphin.math"
version = "0.1.0"
path = "../../../dolphin/packages/math"

[[dependencies]]
package = "dolphin.spatial3d"
version = "0.1.0"
path = "../../../dolphin/packages/spatial3d"

dolphinAuthoringSession.Selected

A complete caller for this public method. Sample inputs are illustrative; native resources require their owning lifecycle.

cpu · method · source-example · type checked

using dolphin.authoring

// Selected.
dolphinAuthoringSession instance = dolphinAuthoringSession(dolphinSceneDocument())
int argument_id = 1
bool result = instance.Selected(argument_id)
Console.Log(Text.From(result))
project.mech
manifestVersion = "2"
package = "api.example.dolphin_authoring__dolphinauthoringsession"
version = "0.1.0"
languageEdition = "yeho-core-2026.1"

[app]
kind = "headless"

[[dependencies]]
package = "dolphin.authoring"
version = "0.1.0"
path = "../../../dolphin/packages/authoring"

[[dependencies]]
package = "dolphin.math"
version = "0.1.0"
path = "../../../dolphin/packages/math"

[[dependencies]]
package = "dolphin.spatial3d"
version = "0.1.0"
path = "../../../dolphin/packages/spatial3d"

dolphinAuthoringSession.Select

A complete caller for this public method. Sample inputs are illustrative; native resources require their owning lifecycle.

cpu · method · source-example · type checked

using dolphin.authoring

// Select.
dolphinAuthoringSession instance = dolphinAuthoringSession(dolphinSceneDocument())
int argument_id = 1
bool argument_additive = true
instance.Select(argument_id, argument_additive)
Console.Log("Select completed")
project.mech
manifestVersion = "2"
package = "api.example.dolphin_authoring__dolphinauthoringsession"
version = "0.1.0"
languageEdition = "yeho-core-2026.1"

[app]
kind = "headless"

[[dependencies]]
package = "dolphin.authoring"
version = "0.1.0"
path = "../../../dolphin/packages/authoring"

[[dependencies]]
package = "dolphin.math"
version = "0.1.0"
path = "../../../dolphin/packages/math"

[[dependencies]]
package = "dolphin.spatial3d"
version = "0.1.0"
path = "../../../dolphin/packages/spatial3d"

dolphinAuthoringSession.Commit

A complete caller for this public method. Sample inputs are illustrative; native resources require their owning lifecycle.

cpu · method · source-example · type checked

using dolphin.authoring

// Commit.
dolphinAuthoringSession instance = dolphinAuthoringSession(dolphinSceneDocument())
dolphinSceneDocument argument_next = dolphinSceneDocument()
text argument_action = "argument action"
bool result = instance.Commit(argument_next, argument_action)
Console.Log(Text.From(result))
project.mech
manifestVersion = "2"
package = "api.example.dolphin_authoring__dolphinauthoringsession"
version = "0.1.0"
languageEdition = "yeho-core-2026.1"

[app]
kind = "headless"

[[dependencies]]
package = "dolphin.authoring"
version = "0.1.0"
path = "../../../dolphin/packages/authoring"

[[dependencies]]
package = "dolphin.math"
version = "0.1.0"
path = "../../../dolphin/packages/math"

[[dependencies]]
package = "dolphin.spatial3d"
version = "0.1.0"
path = "../../../dolphin/packages/spatial3d"

dolphinAuthoringSession.Undo

A complete caller for this public method. Sample inputs are illustrative; native resources require their owning lifecycle.

cpu · method · source-example · type checked

using dolphin.authoring

// Undo.
dolphinAuthoringSession instance = dolphinAuthoringSession(dolphinSceneDocument())
instance.Undo()
Console.Log("Undo completed")
project.mech
manifestVersion = "2"
package = "api.example.dolphin_authoring__dolphinauthoringsession"
version = "0.1.0"
languageEdition = "yeho-core-2026.1"

[app]
kind = "headless"

[[dependencies]]
package = "dolphin.authoring"
version = "0.1.0"
path = "../../../dolphin/packages/authoring"

[[dependencies]]
package = "dolphin.math"
version = "0.1.0"
path = "../../../dolphin/packages/math"

[[dependencies]]
package = "dolphin.spatial3d"
version = "0.1.0"
path = "../../../dolphin/packages/spatial3d"

dolphinAuthoringSession.Redo

A complete caller for this public method. Sample inputs are illustrative; native resources require their owning lifecycle.

cpu · method · source-example · type checked

using dolphin.authoring

// Redo.
dolphinAuthoringSession instance = dolphinAuthoringSession(dolphinSceneDocument())
instance.Redo()
Console.Log("Redo completed")
project.mech
manifestVersion = "2"
package = "api.example.dolphin_authoring__dolphinauthoringsession"
version = "0.1.0"
languageEdition = "yeho-core-2026.1"

[app]
kind = "headless"

[[dependencies]]
package = "dolphin.authoring"
version = "0.1.0"
path = "../../../dolphin/packages/authoring"

[[dependencies]]
package = "dolphin.math"
version = "0.1.0"
path = "../../../dolphin/packages/math"

[[dependencies]]
package = "dolphin.spatial3d"
version = "0.1.0"
path = "../../../dolphin/packages/spatial3d"

dolphinAuthoringSession.Attach

A complete caller for this public method. Sample inputs are illustrative; native resources require their owning lifecycle.

cpu · method · source-example · type checked

using dolphin.authoring

// Attach.
dolphinAuthoringSession instance = dolphinAuthoringSession(dolphinSceneDocument())
int argument_component = 1
bool result = instance.Attach(argument_component)
Console.Log(Text.From(result))
project.mech
manifestVersion = "2"
package = "api.example.dolphin_authoring__dolphinauthoringsession"
version = "0.1.0"
languageEdition = "yeho-core-2026.1"

[app]
kind = "headless"

[[dependencies]]
package = "dolphin.authoring"
version = "0.1.0"
path = "../../../dolphin/packages/authoring"

[[dependencies]]
package = "dolphin.math"
version = "0.1.0"
path = "../../../dolphin/packages/math"

[[dependencies]]
package = "dolphin.spatial3d"
version = "0.1.0"
path = "../../../dolphin/packages/spatial3d"

dolphinAuthoringSession.Reference

A complete caller for this public method. Sample inputs are illustrative; native resources require their owning lifecycle.

cpu · method · source-example · type checked

using dolphin.authoring

// Reference.
dolphinAuthoringSession instance = dolphinAuthoringSession(dolphinSceneDocument())
int argument_target = 1
bool result = instance.Reference(argument_target)
Console.Log(Text.From(result))
project.mech
manifestVersion = "2"
package = "api.example.dolphin_authoring__dolphinauthoringsession"
version = "0.1.0"
languageEdition = "yeho-core-2026.1"

[app]
kind = "headless"

[[dependencies]]
package = "dolphin.authoring"
version = "0.1.0"
path = "../../../dolphin/packages/authoring"

[[dependencies]]
package = "dolphin.math"
version = "0.1.0"
path = "../../../dolphin/packages/math"

[[dependencies]]
package = "dolphin.spatial3d"
version = "0.1.0"
path = "../../../dolphin/packages/spatial3d"

dolphinAuthoringSession.Play

A complete caller for this public method. Sample inputs are illustrative; native resources require their owning lifecycle.

cpu · method · source-example · type checked

using dolphin.authoring

// Play.
dolphinAuthoringSession instance = dolphinAuthoringSession(dolphinSceneDocument())
instance.Play()
Console.Log("Play completed")
project.mech
manifestVersion = "2"
package = "api.example.dolphin_authoring__dolphinauthoringsession"
version = "0.1.0"
languageEdition = "yeho-core-2026.1"

[app]
kind = "headless"

[[dependencies]]
package = "dolphin.authoring"
version = "0.1.0"
path = "../../../dolphin/packages/authoring"

[[dependencies]]
package = "dolphin.math"
version = "0.1.0"
path = "../../../dolphin/packages/math"

[[dependencies]]
package = "dolphin.spatial3d"
version = "0.1.0"
path = "../../../dolphin/packages/spatial3d"

dolphinAuthoringSession.Pause

A complete caller for this public method. Sample inputs are illustrative; native resources require their owning lifecycle.

cpu · method · source-example · type checked

using dolphin.authoring

// Pause.
dolphinAuthoringSession instance = dolphinAuthoringSession(dolphinSceneDocument())
instance.Pause()
Console.Log("Pause completed")
project.mech
manifestVersion = "2"
package = "api.example.dolphin_authoring__dolphinauthoringsession"
version = "0.1.0"
languageEdition = "yeho-core-2026.1"

[app]
kind = "headless"

[[dependencies]]
package = "dolphin.authoring"
version = "0.1.0"
path = "../../../dolphin/packages/authoring"

[[dependencies]]
package = "dolphin.math"
version = "0.1.0"
path = "../../../dolphin/packages/math"

[[dependencies]]
package = "dolphin.spatial3d"
version = "0.1.0"
path = "../../../dolphin/packages/spatial3d"

dolphinAuthoringSession.Stop

A complete caller for this public method. Sample inputs are illustrative; native resources require their owning lifecycle.

cpu · method · source-example · type checked

using dolphin.authoring

// Stop.
dolphinAuthoringSession instance = dolphinAuthoringSession(dolphinSceneDocument())
instance.Stop()
Console.Log("Stop completed")
project.mech
manifestVersion = "2"
package = "api.example.dolphin_authoring__dolphinauthoringsession"
version = "0.1.0"
languageEdition = "yeho-core-2026.1"

[app]
kind = "headless"

[[dependencies]]
package = "dolphin.authoring"
version = "0.1.0"
path = "../../../dolphin/packages/authoring"

[[dependencies]]
package = "dolphin.math"
version = "0.1.0"
path = "../../../dolphin/packages/math"

[[dependencies]]
package = "dolphin.spatial3d"
version = "0.1.0"
path = "../../../dolphin/packages/spatial3d"

dolphinAuthoringSession.Step

A complete caller for this public method. Sample inputs are illustrative; native resources require their owning lifecycle.

cpu · method · source-example · type checked

using dolphin.authoring

// Step.
dolphinAuthoringSession instance = dolphinAuthoringSession(dolphinSceneDocument())
instance.Step()
Console.Log("Step completed")
project.mech
manifestVersion = "2"
package = "api.example.dolphin_authoring__dolphinauthoringsession"
version = "0.1.0"
languageEdition = "yeho-core-2026.1"

[app]
kind = "headless"

[[dependencies]]
package = "dolphin.authoring"
version = "0.1.0"
path = "../../../dolphin/packages/authoring"

[[dependencies]]
package = "dolphin.math"
version = "0.1.0"
path = "../../../dolphin/packages/math"

[[dependencies]]
package = "dolphin.spatial3d"
version = "0.1.0"
path = "../../../dolphin/packages/spatial3d"
Notes and source

Package presence and a declaration do not establish support on every host. Host services need their platform and lifecycle setup.

dolphin/packages/authoring/src/authoring.yh:160