Buffer

CopyBuffer

Copy content of source buffer to target buffer, content in target buffer will be overwrote.

注解

This command only apply to object buffers

Parameters
Name Required Description
fromBuffer Yes source buffer path
toBuffer Yes target buffer path

Example

  • copy buffer by full path
1
2
3
4
5
{
    "cmd": "CopyBuffer",
    "fromBuffer":{"ObjectManager":"RunBuffer/buffer1"},
    "toBuffer":{"ObjectManager":"RunBuffer/buffer2"}
}
  • copy buffer by relative path
1
2
3
4
5
{
    "cmd": "CopyBuffer",
    "fromBuffer":"buffer1",
    "toBuffer":"buffer2"
}

NOTE

  • buffer1 same as {"ObjectManager":"RunBuffer/buffer1"}
  • buffer2 same as {"ObjectManager":"RunBuffer/buffer2"}

MergeBuffer

Copy content of source buffer to target buffer, content in target buffer will be reserved.

注解

This command only apply to object buffers

Parameters
Name Required Description
fromBuffer Yes source buffer path
toBuffer Yes target buffer path

Example

1
2
3
4
5
{
    "cmd": "MergeBuffer",
    "fromBuffer":{"ObjectManager":"RunBuffer/buffer1"},
    "toBuffer":{"ObjectManager":"RunBuffer/buffer2"}
}

SubtractBuffer

Delete objects in target buffer which are identical to objects in source buffer.

注解

This command only apply to object buffers

Parameters
Name Required Description
fromBuffer Yes source buffer path
toBuffer Yes target buffer path

Example

1
2
3
4
5
{
    "cmd": "SubtractBuffer",
    "fromBuffer":{"ObjectManager":"RunBuffer/buffer1"},
    "toBuffer":{"ObjectManager":"RunBuffer/buffer2"}
}

SetObjectsToBuffer

Assign object to buffer.

Parameters
Name Required Description
Object Reference Yes Object Reference
toBuffer Yes target buffer path

Example

  • refer object by uid
1
2
3
4
5
{
    "cmd": "SetObjectsToBuffer",
    "uid":"obj01",
    "toBuffer":{"ObjectManager":"RunBuffer/objsBuffer"}
}
  • object uid list
1
2
3
4
5
{
    "cmd": "SetObjectsToBuffer",
    "uids":["obj01", "obj02"],
    "toBuffer":{"ObjectManager":"RunBuffer/objsBuffer"}
}
  • refer object by id
1
2
3
4
5
{
    "cmd": "SetObjectsToBuffer",
    "id":"dg23dvw41hrdve",
    "toBuffer":{"ObjectManager":"RunBuffer/objsBuffer"}
}

SetBufferValue

Assign value to buffer.

Parameters
Name Required Description
toBuffer Yes target buffer path
value Yes value to be set

Example

  • empty buffer
1
2
3
4
5
{
    "cmd": "SetBufferValue",
    "toBuffer":{"ObjectManager":"RunBuffer/buffer1"},
    "value":""
}