cPy.cScene module

class VoxMethadata

Bases: cTool

Base class for voxel metadata extensions.

Allows attaching additional data or logic to a specific VoxTreeBranch.

static dynamic_cast(pObject: BaseClass) → VoxMethadata

An analogue of the dynamic_cast function from C++, it checks whether the object pObject is a VoxMethadata class or its descendant, and if so, returns the specified object, but of the VoxMethadata type.

static ProcessMethadata()

static SetZeroCur()

Parent: any

OnActivateVolume(T: any)

Called when the associated volume becomes active.

OnDeactivateVolume(T: any)

class CutsCollector

Bases: object

Utility class for collecting intersection curves and processing boolean edges.

Used for operations like creating curves from volume intersections,

generating tubes along intersections, or splitting mesh boundaries.

preferred_name: cStr

transform(m: cMat4)

fromVolumesIntersection(volume1: any, volume2: any)

Collects intersection edges between two voxel volumes.

makeCurves()

Collects intersection edges between a voxel volume and a mesh.

relaxInTube(volume: any, radius: float, symm: bool = True)

Relaxes the collected curves inside a tubular volume.

createWeightsVolume(dest: VolumeObject, radius: float, edges_transform: cMat4)

mergeTubeTo(dest: any, radius: float)

class VoxTreeBranch

Bases: object

Main element of the object tree in the sculpt room, rooted at RootVTree.

Hierarchical layers (voxel and surface) which you see in the SculptRoom.

Every item in this object contains transform matrix and reference to the item in VTree.

It refers VolumeObject. There may be multiple references on same VolumeObject from separate VoxTreeBranch-es.

Root of all VoxTreeBranches kept in RootVTree.

see VolumeObject

static dynamic_cast(pObject: any) → VoxTreeBranch

An analogue of the dynamic_cast function from C++, it checks whether the object pObject is a VoxTreeBranch class or its descendant, and if so, returns the specified object, but of the VoxTreeBranch type.

Parent: VoxTreeBranch

Obj: VolumeObject

Reference to the actual geometric/volumetric data.

StoreMode: bool = False

cStr Name; ///< name in tree

Ghost: bool

bool Visible; ///< visibility

pVoxSurf: bool

< ghosting mode

VoxSurf: bool

brief True means Surface mode, false means Voxel mode.

HideInViewport: bool

Procesed: bool

< Hidden in viewport, but pickable/visible in tree.

IsRef: bool

bool OpenState; ///< branch is open

IsActive: bool

IsInTransform: bool

ToDestroy: bool

InCache: bool

< should be destroyed. Don’t delete leafs manually, just set this flag!

Instance: bool

Indicates if the object is an instance. If false, it is the original object. If true, the object references an existing VolumeObject to save memory.

SkipPick: bool

Inverse: bool

SelectionTime: int

bool Selected;

CacheName: cStr

ExData: cStr

< reference to cache name

SymmetryData: cStr

< metadata string

SpaceID: int

< symmetry data kept to be stored in undo routine

ProxyScale: float

int Level; ///< deph in VoxTree structure

Transform: cMat4

InvTransform: cMat4

< transform for local to global scale

LocalTransform: cMat4

todo ???

GizmoCenter: cVec3

Last used transform gizmo parameters.

GizmoCenrtified: bool

GizmoDirected: bool

GizmoX: cVec3

GizmoY: cVec3

GizmoZ: cVec3

Methadata: any

LockedVolumeChanged: VoxTreeBranch = None

tmpLinkedObjects: any

GetLinkedObjects() → any

SceneNGObjects: ClassArray_NGObject = <Coat_CPP.ClassArray_NGObject object>

NGObjectIdx: int

GetNodeSystem() → any

LastTransformTick: int

MergeDisplacement: float = 0.0

ChildObjects(i: int) → VoxTreeBranch

ClassArray<VoxTreeBranch> ChildObjects;

ChildObjectsCount() → int

GetObjectsCountRecursive() → int

ChildObjectsAdd(tb: VoxTreeBranch)

ChildObjectsInsert(Pos: int, tb: VoxTreeBranch)

ChildObjectsClear()

ChildObjectsDel(idx: int, count: int)

ChildObjectsDelElement(idx: int)

TransformedRecently() → bool

NotifyTransformed()

PrimPresets: any

primitives usage history

Delete()

see Del()

CreateRmbMenu(Prop: any)

overrides from ItemsTree

DropTreeStructureToUndo()

OnDuplicate(CopyPtr: any)

AdditionalElementRenderingInUI(BaseBox: any)

IgnoreAltIsolate() → bool

ApplyBooleans(Source: any, shift: bool, ctrl: bool, Keep: bool)

ChangeParentItem(NewParent: any)

NotifyParentChange(NewParent: any)

ProcessItem()

end of overrides from ItemsTree

Add(name: str, CheckExisting: bool, T: cMat4 = None) → VoxTreeBranch

CheckPresenceInSubTree(Element: VoxTreeBranch) → bool

Restores the child structure from a helper list.

InstanceToParentInstances()

Insert(idx: int)

EditShader() → bool

ApplyNodes() → bool

static CreateNewShader(BaseShader: str, NewShaderName: str = None, Activate: bool = True)

Rename()

Save3B(subtree: bool, name: str, sel: bool = False)

Saves the volume data to a 3B file.

Merge3B(name: str)

Merges a 3B file into the scene.

CheckInstanceRemoving()

Add1() → bool

Decompose()

DecomposeFrozen()

Resample(scale: float, Q: int)

Resamples the volume (changes resolution).

TransformIt() → bool

Del(onlythis: bool) → bool

DelSelected() → bool

DelNoUndo() → bool

static validate_cur()

ImportPointsCloud() → bool

Import/Export

ImportModel() → bool

ExportScene() → bool

ExportObject() → bool

ExportPatternForMerge(idx: any) → bool

ExportPatternAsPen() → bool

ExportCurveProfile() → bool

Approve(p: VoxTreeBranch) → VoxTreeBranch

CheckMultiselectionCancel() → bool

GetSelHighlight() → cVec4

HighlightIt(IfPassive: bool)

Highlighted() → bool

MergeObj(p: VoxTreeBranch) → bool

PlainMergeObj(p: VoxTreeBranch) → bool

Flip(x: any, y: any, z: any)

Flips the object along specified axes.

FlipSel(x: any, y: any, z: any)

static ApplyTransformToInstances(M: cMat4, vo: VolumeObject, InstOnly: bool = False, R: bool = False, applyNGScale: bool = True)

CombineChildren()

FlipNormals()

MakeUniform()

MakeUniform2()

AllUniform()

isUniform() → bool

MoveObj(p: VoxTreeBranch, KeepSource: bool) → bool

Boolean Operations

PlainMoveObj(p: VoxTreeBranch) → bool

SubObj(p: VoxTreeBranch, KeepSource: bool) → bool

IntrsObj(p: VoxTreeBranch, KeepSource: bool) → bool

RemIntrsObj(p: VoxTreeBranch) → bool

SplitObj(p: VoxTreeBranch) → bool

MakeHull() → bool

Hull & Repair

MakeHull2() → bool

CloseHoles() → bool

CloseTunnels() → bool

Extrude() → bool

SetDirty()

SetVoxShader(obj: any, id: any) → bool

ApplyAxialSymmetry() → bool

ChangeParent(p: VoxTreeBranch) → bool

ChangeThisParent(p: VoxTreeBranch) → bool

ShowHideButThis()

Visibility & Ghosting

GhostButThis()

UnghostWithSubtree()

GhostWithSubtree()

InvertGhostWithSubtree()

InvertVisibleWithSubtree()

BakeColorsThere()

ShowAll() → bool

ShowSubtree() → bool

PutOnGroundEx(minvt: cVec3, cm: cVec3)

Positioning

PutOnGround()

LayOnGround()

GlueToGround()

InvertHiddenFaces()

DeleteHiddenFaces(invert: bool)

CalcHash(d: int = 1) → int

static valid(ctb: any) → bool

GetRoot() → VoxTreeBranch

DeselectAll(R: VoxTreeBranch = None) → bool

StoreSymm()

RestoreSymm()

GetUniqueName(takethisname: bool, suffix: str) → cStr

CreateUniqSpace(safe: bool, suffix: str) → VoxTreeBranch

Clone(Recursive: bool = False, dest: VoxTreeBranch = None, Inst: bool = False, Subtree: bool = False, T: cMat4 = cPy.cTypes.cMat4.Identity, ChangeTool: bool = True, CopyData: bool = True, SetCurr: bool = True, ForceReplaceDest: bool = False, SelectedOnly: bool = False) → VoxTreeBranch

Clones the object/branch.

Parameters:

• Recursive (bool) – Clone children recursively.

• dest (VoxTreeBranch) – Destination branch (parent).

• Inst (bool) – Create as an instance (share volume data).

• Subtree (bool) – Include full subtree.

• T (cMat4) – Optional transform offset.

Returns:

Pointer to the cloned branch.

Return type:

VoxTreeBranch

Clone2()

CloneInst2()

CloneDegrade(Undo: bool) → bool

CloneAndDegradeCur()

SeparateHidden()

MergeVisible()

PlainMergeVisible()

MergeSelected()

PlainMergeSelected()

MergeSubtree()

void MergeDown(); // implementation not found

PlainMergeSubtree()

MergeTo(Dest: VoxTreeBranch, sub: int, ClearThis: bool, NoUndo: bool)

PlainMergeTo(Dest: VoxTreeBranch, NoUndo: bool)

find(gu: int, NonInstance: bool = True) → VoxTreeBranch

GetParent(tb: VoxTreeBranch) → VoxTreeBranch

CloneSpaceVT(changetool: bool = True, subtree: bool = False) → VoxTreeBranch

static Current() → VoxTreeBranch

SeekByUserInt(val: int) → VoxTreeBranch

SetupNewNodeSystem()

CloneSpace() → bool

IncDencity2X() → bool

DecDencity2X() → bool

CloneSymm2()

CloneInstSymm2()

SelectCurrent()

SelectCurrentOnScreen()

SimpleSelect()

QuadrangulateAndMergeDP() → bool

Retopology / Quadrangulation

DecToRetopo()

DecToRetopoAll()

PushMatrix()

PopMatrix()

UnIstance(copy: bool = True)

BlendTransforms(name1: str, name2: str, blend: float)

SaveTransforms()

LoadTransforms()

SetTransform(m: cMat4)

static BestCurentCandidate() → VoxTreeBranch

SelectVisibleSubtree()

ChooseRefColor()

TopologyLocked() → bool

OnChangeMember(mc: BaseClass, mp: any, me: any, mn: str) → bool

OnScriptRecorder(mc: BaseClass, mp: any, me: any, mn: str) → bool

ApproveThis() → bool

OnModifyControl(Name: str, BW: any, Context: any)

RMBHotkeysActiveForThisItem() → bool

GetClassMask() → int

GetElementLevel(name: str) → int

ProcessNodeCleanup()

ProcessNodeVisibility(MakeInvisible: bool = False)

UpdateHash(H: any, data: any = None, extra: any = None)

IsNameUniq(name: str) → bool

StoreVOTree(B: any, bin: bool)

CheckIfParent(child: VoxTreeBranch) → bool

FindParent(root: VoxTreeBranch, index: int) → VoxTreeBranch

RefreshLevels()

SetupLevels(L: int)

SetupVOMat()

RestoreVOTree(B: any, Clear: bool = True)

SetDestroyState()

SetVIDS()

SetInvM()

FindVOBS()

GetMainAxis(X: cVec3, Y: cVec3, Z: cVec3, SelectedOnly: bool) → cVec3

ScrollTo()

CheckLockedVolume() → bool

removeThis()

duplicate() → any

setTransform(m: cMat4)

setTransformRecursive(m: cMat4)

duplicateAsInstance() → any

instancingSupported() → bool

getTransform() → cMat4

SemiBoolean(other: VoxTreeBranch, op_type: int)

static ApplySurfaceChangesToVoxelsVolumes()

static float GetCut(cVec2& minmax, const Vector3D& p, VolumeObject* except, float* unitlen); // implementation not found

createIntersectionCurveWith(with_vtb: VoxTreeBranch)

class HullParams

Bases: BaseClass

EdgeThickness: float

class VoxVisualTree

Bases: VoxTreeBranch

The root class representing the visual object tree structure.

Manages global tree operations like adding new volumes, deleting selected, and cloning spaces.

AddNewVolume()

DeleteSelectedVolumes()

DuplicateSelectedVolumes()

CloneSpaceDencity()

SymmCopy()

EditShader()

IncRes()

ClearCurrLayer()