Register a vox tools for scripting. More...

#include <SVox.h>

Static Public Member Functions
static void	opConstruct (Vox *=nullptr)
	Empty constructor. More...

static void	opConstructLoadFromFile (const std::string &filename, Vox *=nullptr)
	Load poly mesh from file. After loaded 'filename' a pointer set to the first branch. More...

static void	opDestruct (Vox *in)
	Destructor. More...

static void	opCopyConstruct (Vox &rhs, Vox *in)
	Copy constructor. More...

static Vox &	opAssign (Vox &rhs, Vox *lhs)
	Assign voxels. More...

static Vox &	append (const std::string &name, Vox *in=nullptr)
	Append a v-layer `name` as child of selected brunch. A mode `Surface` or `Voxel` shall be determined by parent. More...

static Vox &	appendToParent (const std::string &name, Vox *in=nullptr)
	Append v-layer `name` as child of parent's selected v-layer. In other words, add to the end of parent v-layer relatively selected. Appended v-layer becomes selected. More...

static Vox &	appendToParentMode (const std::string &name, bool surf, Vox *in=nullptr)
	Append v-layer `name` as child of parent's selected v-layer. In other words, add to the end of parent v-layer relatively selected. Appended v-layer set to mode (S=true/V=false) Appended v-layer becomes selected. More...

static Vox &	moveToIndex (const std::string &name, int index, Vox *in=nullptr)
	Move v-layer `name` as child of parent's selected v-layer into the relative index. v-layer becomes selected. More...

static Vox &	moveCurrentToIndex (int idx, Vox *in=nullptr)
	<summary> Move the current v-layer as child of parent's selected v-layer into the relative index. v-layer with index equals to idx becomes selected More...

static int	getIndex (Vox *in=nullptr)
	Get the index of current v-layer. More...

static std::string	names (Vox *in=nullptr)
	Returns all volumes for brunch (comma separated). More...

static std::string	name (Vox *in=nullptr)
	Returns the current volume name. More...

static Vox &	rename (const std::string &newName, Vox *in=nullptr)
	Rename the current volume. More...

static Vox &	to (const std::string &name, Vox *in=nullptr)
	Switch to v-layer named like `name`. More...

static Vox &	parent (Vox *in=nullptr)
	Selected a parent if parent isn't root. Don't moves to the root's v-layer. More...

static bool	hasParent (Vox *in=nullptr)
	Check if volume layer has parent. More...

static Vox &	firstForRoot (Vox *in=nullptr)
	Move to a first v-layer among childs of root's v-layer. More...

static Vox &	first (Vox *in=nullptr)
	Move to a first v-layer among childs of selected v-layer. More...

static Vox &	firstForParent (Vox *in=nullptr)
	Move to a first v-layer among childs of parent's selected v-layer. More...

static Vox &	nextForParent (Vox *in=nullptr)
	Move to a next v-layer among childs of parent's selected v-layer. Stops when parent is last. More...

static bool	hasChildren (Vox *in=nullptr)
	Check the children layers for current volume. More...

static bool	hasNextForParent (Vox *in=nullptr)
	Check the next layer for parent volume. More...

static bool	next (Vox *in=nullptr)
	Select the next volume. Move through all v-layers ignoring depths. More...

static Vox &	lastForRoot (Vox *in=nullptr)
	Move to a last v-layer among childs of root's v-layer. More...

static Vox &	last (Vox *in=nullptr)
	Move to a last v-layer among childs of selected v-layer. More...

static Vox &	lastForParent (Vox *in=nullptr)
	Move to a last v-layer among childs of parent's selected v-layer. More...

static Vox &	remove (Vox *in=nullptr)
	Remove the current v-layer from vox branch tree. More...

static comms::cMat4	transform (Vox *in=nullptr)
	Gets the transform matrix from current volume object. More...

static Vox &	setTransform (const comms::cMat4 &m, Vox *in=nullptr)
	Sets the transform matrix for the current volume object. More...

static bool	visible (Vox *in=nullptr)
	Gets the visibility of the current volume object. More...

static Vox &	setVisible (bool v, Vox *in=nullptr)
	Sets the visibility of the current volume object. More...

static bool	ghost (Vox *in=nullptr)
	Gets the ghost mode of the current volume object. More...

static Vox &	setGhost (bool v, Vox *in=nullptr)
	Sets on/off the ghost mode of the current volume object. More...

static std::string	nameShader (Vox *in=nullptr)
	Gets the shader name of the current volume object. More...

static Vox &	setShaderProperty (const std::string &name, const std::string &vs, Vox *in=nullptr)
	Sets the shader property of the current volume object. More...

static Vox &	setOpacity (float v, Vox *in=nullptr)
	Sets the opacity for current volume object. More...

static Vox &	setColor (int v, Vox *in=nullptr)
	Sets the color for current volume object. More...

static Vox &	setColorRGB (int r, int g, int b, Vox *in=nullptr)
	Sets the RGB color for current volume object. More...

static Vox &	toSurface (Vox *in=nullptr)
	Sets the current volume to surface mode. More...

static Vox &	toVoxel (Vox *in=nullptr)
	Sets the current volume to voxel mode. More...

static Vox &	toVoxelSuggestPoly (int suggestPoly, Vox *in=nullptr)
	Sets the current volume to voxel mode with corresponding number of polygons. More...

static Vox &	forRootEach (const std::string &func, Vox *in=nullptr)
	Move through all v-layers and run `func` for every. More...

static Vox &	forEach (const std::string &func, Vox *in=nullptr)
	Move through all parents v-layers (relative selected) and run `func` for every. More...

static Vox &	call (const std::string &func, Vox *in=nullptr)
	Run `func` for selected v-layer. More...

static Vox &	atForRoot (int i, Vox *in=nullptr)
	Select a child of root's v-layer by index. More...

static Vox &	at (int i, Vox *in=nullptr)
	Select a child of current v-layer by index. More...

static Vox &	atForParent (int i, Vox *in=nullptr)
	Select a child of parent for current v-layer by index. More...

static Vox &	showAllHidden (Vox *in=nullptr)
	Shows all v-layers More...

static Vox &	showHiddenSubtree (Vox *in=nullptr)
	Shows hidden subtree v-layers for current vox tree branch More...

static Vox &	decreaseObject2X (Vox *in=nullptr)
	Decreminate the dencity of volume object's by 2 times More...

static Vox &	increaseObject2X (Vox *in=nullptr)
	Increminate dencity of volume object's by 2 times More...

static Vox &	increaseResolution (Vox *in=nullptr)
	Increase resolution of volume object More...

static Vox &	toGlobalSpace (Vox *in=nullptr)
	Sets the volume objects to the global space More...

static Vox &	toUniformSpace (Vox *in=nullptr)
	Sets the volume objects to the uniform space More...

static Vox &	resample (Vox *in=nullptr)
	Change resolution of the volume object More...

static Vox &	applyAxialSymmetry (Vox *in=nullptr)
	Sets the radially array the object with any number of slices More...

static Vox &	extrude (Vox *in=nullptr)
	Extrude the volume object More...

static Vox &	turnToShell (Vox *in=nullptr)
	Thickens the surface of volume object. More...

static Vox &	makeVoxelHull (Vox *in=nullptr)
	Make a shell mesh using the voxel algorithm. It takes more time to calculate but works well for complex topology. More...

static Vox &	makeSurfaceHull (Vox *in=nullptr)
	Thickens the mesh object using surface extrusion. More...

static Vox &	closeSurfaceHoles (Vox *in=nullptr)
	<summary> Close the surface holes in mesh. More...

static Vox &	fillVoids (Vox *in=nullptr)
	Fills inner voids or hollows in the model More...

static Vox &	closeInvisibleHulls (Vox *in=nullptr)
	Close invisible hulls inside the object. Even if hull is not completely closed it may be closed by this tool because only small outer part of the hull is visible More...

static Vox &	decompose (Vox *in=nullptr)
	Creates an object in the VoxTree for each separated piece of geometry, and places the geometry into those objects More...

static Vox &	save3B (Vox *in=nullptr)
	Save Volume as 3B More...

static Vox &	saveSubtree3B (Vox *in=nullptr)
	Save Volume w/ Sub-Tree as 3B More...

static Vox &	merge3B (Vox *in=nullptr)
	Import external 3B file in scene More...

static Vox &	mergeCloud (Vox *in=nullptr)
	Import set of points as a sequence of small spheres More...

static Vox &	mergeObject (Vox *in=nullptr)
	Import 3D object More...

static Vox &	exportScene (Vox *in=nullptr)
	Export entire scene as a multi-object file More...

static Vox &	exportObject (Vox *in=nullptr)
	Export current object to a file on disk More...

static Vox &	exportPatternForMerge (Vox *in=nullptr)
	Export current object to be used as a preset in the Meshes panel. More...

static Vox &	exportCurveProfile (Vox *in=nullptr)
	Export current object to be used as a preset in the Meshes panel More...

static Vox &	autopoQuadrangulate (Vox *in=nullptr)
	Run AUTOPO and switch to Retopo room. More...

static Vox &	autopoQuadrangulateAndMergePtex (Vox *in=nullptr)
	Run AUTOPO and bake using PTEX technology More...

static Vox &	autopoQuadrangulateAndMerge (Vox *in=nullptr)
	Run AUTOPO to begin texturing in Paint room. More...

static Vox &	autopoQuadrangulateAndMergeDP (Vox *in=nullptr)
	AUTOPO for Per Pixel More...

static Vox &	putOnGround (Vox *in=nullptr)
	Snap object to ground (zero). Only vertical parallel motion will be used. More...

static Vox &	layOnGround (Vox *in=nullptr)

static Vox &	cloneInstance (Vox *in=nullptr)
	Lay object on ground. Object will be moved and rotated to get physically stable position on the ground. More...

static Vox &	clone (Vox *in=nullptr)
	Clone and transform volume object. More...

static Vox &	cloneInstanceWithSymmetry (Vox *in=nullptr)
	Clone instances with symmetry. More...

static Vox &	cloneSymmetry (Vox *in=nullptr)
	Clone with symmetry and transform More...

static Vox &	cloneDegrade (Vox *in=nullptr)
	Clone and decrease level of details twice. More...

static Vox &	cloneSpace (Vox *in=nullptr)
	Create space with identical density and transformation. It is important if you want to use copy tool without losing quality. Create new space and use copy tool. More...

static Vox &	flipX (Vox *in=nullptr)
	Flip object along X More...

static Vox &	flipY (Vox *in=nullptr)
	Flip object along Y More...

static Vox &	flipZ (Vox *in=nullptr)
	Flip object along Z More...

static Vox &	flipNormals (Vox *in=nullptr)
	Flip object normals More...

static Vox &	bakeColors (Vox *in=nullptr)
	Bake color from all visible volumes to the current one. The volume will turn to surface mode. More...

static Vox &	plainMergeVisible (Vox *in=nullptr)
	Merge Visible (no booleans) More...

static Vox &	plainMergeSubtree (Vox *in=nullptr)
	Merge Sub-Tree (no booleans) More...

static Vox &	plainMergeTo (const std::string &with, Vox *in=nullptr)
	Copy & Merge (no booleans). More...

static Vox &	plainMoveTo (const std::string &with, Vox *in=nullptr)
	Merge (move, no booleans) More...

static Vox &	mergeVisible (Vox *in=nullptr)
	Combine current layer with all child layers. More...

static Vox &	mergeSubtree (Vox *in=nullptr)
	Merge the Sub-Tree of current volume. All child layers will be deleted. More...

static Vox &	mergeTo (const std::string &with, Vox *in=nullptr)
	Merge copy of the object to other object. More...

static Vox &	moveTo (const std::string &with, Vox *in=nullptr)
	Move object to other object space. More...

static Vox &	subtractFrom (const std::string &with, Vox *in=nullptr)
	Subtract object from other object. More...

static Vox &	intersectWith (const std::string &with, Vox *in=nullptr)
	Intersect volume with other one. More...

static Vox &	removeIntersectionWith (const std::string &with, Vox *in=nullptr)
	Subtract current volume from the destination but leave both volumes. In so way intersecting part will be removed from the destination object. More...

static Vox &	splitWith (const std::string &with, Vox *in=nullptr)
	Split volume in two parts(volumes) with destination volume. More...

static Vox &	changeParent (const std::string &with, Vox *in=nullptr)
	Change parent of the object. More...

static void	addPaintLayer (const std::string &name, Vox *in=nullptr)
	Paint layers (p-layers) More...

static void	deletePaintLayers (Vox *in=nullptr)
	Delete the current paint layer. More...

static std::string	paintLayer (Vox *in=nullptr)
	Gets the current layer name. More...

static bool	setPaintLayer (const std::string &name, Vox *in=nullptr)
	Select the paint layer. More...

static void	renamePaintLayer (const std::string &newName, Vox *in=nullptr)
	Rename the current paint layer. More...

static void	firstPaintLayer (Vox *in=nullptr)
	Select the first paint layer. More...

static bool	nextPaintLayer (Vox *in=nullptr)
	Select the next paint layer. More...

static bool	visiblePaintLayer (Vox *in=nullptr)
	Gets the visibility of the current paint layer. More...

static void	setVisiblePaintLayer (bool v, Vox *in=nullptr)
	Gets the visibility mode of the current paint layer. More...

static float	opacityPaintLayer (Vox *in=nullptr)
	Gets the opacity of the current paint layer. More...

static void	setOpacityPaintLayer (float v, Vox *in=nullptr)
	Sets the opacity of the current paint layer. More...

static float	depthOpacityPaintLayer (Vox *in=nullptr)
	Gets the depth opacity of the current paint layer. More...

static void	setDepthOpacityPaintLayer (float v, Vox *in=nullptr)
	Sets the depth opacity of the current paint layer. More...

static void	setBlendingPaintLayer (const std::string &name, Vox *in=nullptr)
	Set blending mode of the current paint layer. More...

static void	setDepthBlendingPaintLayer (const std::string &name, Vox *in=nullptr)
	Sets depth blending mode of the current paint layer. More...

static void	addRetopoLayer (const std::string &name, Vox *in=nullptr)
	Add a new retopo layer More...

static void	deleteRetopoLayer (Vox *in=nullptr)
	retopo layers (r-layers) More...

static std::string	retopoLayer (Vox *in=nullptr)
	Gets the current retopo layer. More...

static bool	setRetopoLayer (const std::string &name, Vox *in=nullptr)
	Select retopo layer with name ID. More...

static void	renameRetopoLayer (const std::string &newName, Vox *in=nullptr)
	Rename the current retopo layer More...

static void	firstRetopoLayer (Vox *in=nullptr)
	Select first retopo layer. More...

static bool	nextRetopoLayer (Vox *in=nullptr)
	Select next retopo layer. More...

static bool	visibleRetopoLayer (Vox *in=nullptr)
	Gets visibility of the current retopo layer More...

static void	setVisibleRetopoLayer (bool v, Vox *in=nullptr)
	Set visibility of current retopo layer. More...

static void	addMaterial (const std::string &name, Vox *in=nullptr)
	Materials tool's. More...

static void	deleteMaterial (const std::string &name, Vox *in=nullptr)
	Delete the material from poly mesh materials. More...

static int	materialIndex (const std::string &name, Vox *in=nullptr)
	Gets the material index by name. More...

static std::string	materialName (int index, Vox *in=nullptr)
	Gets the material name by index. More...

static void	renameMaterial (const std::string &oldName, const std::string &newName, Vox *in=nullptr)
	Rename the old material name on the new name. More...

static bool	visibleMaterial (const std::string &name, Vox *in=nullptr)
	Gets the visibility of material. More...

static void	setVisibleMaterial (const std::string &name, bool, Vox *in=nullptr)
	Gets the visibility of material. More...

static void	lockMaterial (const std::string &name, bool b, Vox *in=nullptr)
	Set the lock mode of the material. More...

static void	addObject (const std::string &name, Vox *in=nullptr)
	Add the sub object to poly mesh. More...

static int	objectIndex (const std::string &name, Vox *in=nullptr)
	Gets index of object by name ID. More...

static std::string	objectName (int index, Vox *in=nullptr)
	Get the object name ID by index More...

static void	renameObject (const std::string &oldName, const std::string &newName, Vox *in=nullptr)
	Rename the sub object. More...

static bool	visibleObject (const std::string &name, Vox *in=nullptr)
	Get the object visibility. More...

static void	setVisibleObject (const std::string &name, bool v, Vox *in=nullptr)
	Get the object visibility. More...

static void	lockObject (const std::string &name, bool b, Vox *in=nullptr)
	Set the lock mode for named object. More...

static int	uvsetIndex (const std::string &name, Vox *in=nullptr)
	Gets the retopo UVsets index by name. More...

static std::string	uvsetName (int index, Vox *in=nullptr)
	Gets the retopo uvsets name by index. More...

static void	renameUVSet (const std::string &oldName, const std::string &newName, Vox *in=nullptr)
	Rename the old uvset name by new name More...

static bool	isEmpty (Vox *in=nullptr)
	Checks whether a volume is empty. More...

static bool	isSurface (Vox *in=nullptr)
	Checks whether a current volume mode is surface. More...

static bool	isVoxel (Vox *in=nullptr)
	Checks whether a current volume mode is voxel. More...

static Vox &	clearScene (Vox *in=nullptr)
	Clear a scene. More...

static int	count (Vox *in=nullptr)
	Calculate of child object's count for current voxel tree branch. More...

static float	square (Vox *in=nullptr)
	Gets a current volume square. More...

static float	volume (Vox *in=nullptr)
	Gets a volume of the current volume. More...

static int	polycount (Vox *in=nullptr)
	Gets the number of polygons of the current volume. More...

static int	polycountScene (Vox *in=nullptr)
	Gets polygons count of scene volumes More...

static int	countPaintLayer (Vox *in=nullptr)
	Gets a layers count of the poly mesh. More...

static int	countRetopoLayer (Vox *in=nullptr)
	Gets amount of retopo layers. More...

static int	countMaterial (Vox *in=nullptr)
	Gets amount of poly mesh materials. More...

static int	countObject (Vox *in=nullptr)
	Gets amount of poly mesh objects. More...

static int	countUVSet (Vox *in=nullptr)
	Gets amount of uvsets. More...

Detailed Description

Register a vox tools for scripting.

Since: 5.0

Member Function Documentation

static void RegisterVoxHelper::addMaterial	(	const std::string &	name,
		Vox *	in = `nullptr`
	)

inlinestatic

Materials tool's.

Add the material to poly mesh materials.

Parameters

name	material name

static void RegisterVoxHelper::addObject	(	const std::string &	name,
		Vox *	in = `nullptr`
	)

inlinestatic

Add the sub object to poly mesh.

Parameters

name	sub object name

static void RegisterVoxHelper::addPaintLayer	(	const std::string &	name,
		Vox *	in = `nullptr`
	)

inlinestatic

Paint layers (p-layers)

Add the paint layer.

Parameters

name	layer's name

static void RegisterVoxHelper::addRetopoLayer	(	const std::string &	name,
		Vox *	in = `nullptr`
	)

inlinestatic

Add a new retopo layer

Parameters

name	layer name

Vox & RegisterVoxHelper::append	(	const std::string &	name,
		Vox *	in = `nullptr`
	)

static

Append a v-layer name as child of selected brunch. A mode Surface or Voxel shall be determined by parent.

References VoxTreeBranch::Add().

Vox & RegisterVoxHelper::appendToParent	(	const std::string &	name,
		Vox *	in = `nullptr`
	)

static

Append v-layer name as child of parent's selected v-layer. In other words, add to the end of parent v-layer relatively selected. Appended v-layer becomes selected.

References VoxTreeBranch::Add().

Referenced by clearScene().

Vox & RegisterVoxHelper::appendToParentMode	(	const std::string &	name,
		bool	surf,
		Vox *	in = `nullptr`
	)

static

Append v-layer name as child of parent's selected v-layer. In other words, add to the end of parent v-layer relatively selected. Appended v-layer set to mode (S=true/V=false) Appended v-layer becomes selected.

References VoxTreeBranch::Add().

static Vox& RegisterVoxHelper::applyAxialSymmetry ( Vox * in = nullptr )

inlinestatic

Sets the radially array the object with any number of slices

Vox & RegisterVoxHelper::at	(	int	i,
		Vox *	in = `nullptr`
	)

static

Select a child of current v-layer by index.

References VoxTreeBranch::ChildObjects().

Vox & RegisterVoxHelper::atForParent	(	int	i,
		Vox *	in = `nullptr`
	)

static

Select a child of parent for current v-layer by index.

References VoxTreeBranch::ChildObjects().

Vox & RegisterVoxHelper::atForRoot	(	int	i,
		Vox *	in = `nullptr`
	)

static

Select a child of root's v-layer by index.

See Also: count()

static Vox& RegisterVoxHelper::autopoQuadrangulate ( Vox * in = nullptr )

inlinestatic

Run AUTOPO and switch to Retopo room.

static Vox& RegisterVoxHelper::autopoQuadrangulateAndMerge ( Vox * in = nullptr )

inlinestatic

Run AUTOPO to begin texturing in Paint room.

static Vox& RegisterVoxHelper::autopoQuadrangulateAndMergeDP ( Vox * in = nullptr )

inlinestatic

AUTOPO for Per Pixel

static Vox& RegisterVoxHelper::autopoQuadrangulateAndMergePtex ( Vox * in = nullptr )

inlinestatic

Run AUTOPO and bake using PTEX technology

static Vox& RegisterVoxHelper::bakeColors ( Vox * in = nullptr )

inlinestatic

Bake color from all visible volumes to the current one. The volume will turn to surface mode.

Vox & RegisterVoxHelper::call	(	const std::string &	func,
		Vox *	in = `nullptr`
	)

static

Run func for selected v-layer.

static Vox& RegisterVoxHelper::changeParent	(	const std::string &	with,
		Vox *	in = `nullptr`
	)

inlinestatic

Change parent of the object.

Parameters

with	name of the object to change

Vox & RegisterVoxHelper::clearScene ( Vox * in = nullptr )

static

Clear a scene.

References appendToParent(), firstForRoot(), and BaseClass::valid().

static Vox& RegisterVoxHelper::clone ( Vox * in = nullptr )

inlinestatic

Clone and transform volume object.

static Vox& RegisterVoxHelper::cloneDegrade ( Vox * in = nullptr )

inlinestatic

Clone and decrease level of details twice.

static Vox& RegisterVoxHelper::cloneInstance ( Vox * in = nullptr )

inlinestatic

Lay object on ground. Object will be moved and rotated to get physically stable position on the ground.

static Vox& RegisterVoxHelper::cloneInstanceWithSymmetry ( Vox * in = nullptr )

inlinestatic

Clone instances with symmetry.

static Vox& RegisterVoxHelper::cloneSpace ( Vox * in = nullptr )

inlinestatic

Create space with identical density and transformation. It is important if you want to use copy tool without losing quality. Create new space and use copy tool.

static Vox& RegisterVoxHelper::cloneSymmetry ( Vox * in = nullptr )

inlinestatic

Clone with symmetry and transform

static Vox& RegisterVoxHelper::closeInvisibleHulls ( Vox * in = nullptr )

inlinestatic

Close invisible hulls inside the object. Even if hull is not completely closed it may be closed by this tool because only small outer part of the hull is visible

static Vox& RegisterVoxHelper::closeSurfaceHoles ( Vox * in = nullptr )

inlinestatic

<summary>

Close the surface holes in mesh.

int RegisterVoxHelper::count ( Vox * in = nullptr )

static

Calculate of child object's count for current voxel tree branch.

Returns: Number of child objects

static int RegisterVoxHelper::countMaterial ( Vox * in = nullptr )

inlinestatic

Gets amount of poly mesh materials.

Returns: numbers of materials

Referenced by visibleMaterial().

static int RegisterVoxHelper::countObject ( Vox * in = nullptr )

inlinestatic

Gets amount of poly mesh objects.

Returns: numbers of objects.

Referenced by visibleObject().

static int RegisterVoxHelper::countPaintLayer ( Vox * in = nullptr )

inlinestatic

Gets a layers count of the poly mesh.

Returns: layers count

int RegisterVoxHelper::countRetopoLayer ( Vox * in = nullptr )

static

Gets amount of retopo layers.

Parameters

in

Returns: number of retopo layers

static int RegisterVoxHelper::countUVSet ( Vox * in = nullptr )

inlinestatic

Gets amount of uvsets.

Returns: number of uvsets.

static Vox& RegisterVoxHelper::decompose ( Vox * in = nullptr )

inlinestatic

Creates an object in the VoxTree for each separated piece of geometry, and places the geometry into those objects

static Vox& RegisterVoxHelper::decreaseObject2X ( Vox * in = nullptr )

inlinestatic

Decreminate the dencity of volume object's by 2 times

void RegisterVoxHelper::deleteMaterial	(	const std::string &	name,
		Vox *	in = `nullptr`
	)

static

Delete the material from poly mesh materials.

Parameters

name	material to delete

References materialIndex().

static void RegisterVoxHelper::deletePaintLayers ( Vox * in = nullptr )

inlinestatic

Delete the current paint layer.

static void RegisterVoxHelper::deleteRetopoLayer ( Vox * in = nullptr )

inlinestatic

retopo layers (r-layers)

Delete the current retopo layer.

float RegisterVoxHelper::depthOpacityPaintLayer ( Vox * in = nullptr )

static

Gets the depth opacity of the current paint layer.

Returns: depth opacity

static Vox& RegisterVoxHelper::exportCurveProfile ( Vox * in = nullptr )

inlinestatic

Export current object to be used as a preset in the Meshes panel

static Vox& RegisterVoxHelper::exportObject ( Vox * in = nullptr )

inlinestatic

Export current object to a file on disk

static Vox& RegisterVoxHelper::exportPatternForMerge ( Vox * in = nullptr )

inlinestatic

Export current object to be used as a preset in the Meshes panel.

static Vox& RegisterVoxHelper::exportScene ( Vox * in = nullptr )

inlinestatic

Export entire scene as a multi-object file

static Vox& RegisterVoxHelper::extrude ( Vox * in = nullptr )

inlinestatic

Extrude the volume object

static Vox& RegisterVoxHelper::fillVoids ( Vox * in = nullptr )

inlinestatic

Fills inner voids or hollows in the model

Vox & RegisterVoxHelper::first ( Vox * in = nullptr )

static

Move to a first v-layer among childs of selected v-layer.

References VoxTreeBranch::ChildObjects().

Vox & RegisterVoxHelper::firstForParent ( Vox * in = nullptr )

static

Move to a first v-layer among childs of parent's selected v-layer.

References VoxTreeBranch::ChildObjects().

Vox & RegisterVoxHelper::firstForRoot ( Vox * in = nullptr )

static

Move to a first v-layer among childs of root's v-layer.

Referenced by clearScene().

static void RegisterVoxHelper::firstPaintLayer ( Vox * in = nullptr )

inlinestatic

Select the first paint layer.

static void RegisterVoxHelper::firstRetopoLayer ( Vox * in = nullptr )

inlinestatic

Select first retopo layer.

Parameters

in

static Vox& RegisterVoxHelper::flipNormals ( Vox * in = nullptr )

inlinestatic

Flip object normals

static Vox& RegisterVoxHelper::flipX ( Vox * in = nullptr )

inlinestatic

Flip object along X

static Vox& RegisterVoxHelper::flipY ( Vox * in = nullptr )

inlinestatic

Flip object along Y

static Vox& RegisterVoxHelper::flipZ ( Vox * in = nullptr )

inlinestatic

Flip object along Z

Vox & RegisterVoxHelper::forEach	(	const std::string &	func,
		Vox *	in = `nullptr`
	)

static

Move through all parents v-layers (relative selected) and run func for every.

References VoxTreeBranch::ChildObjects().

Vox & RegisterVoxHelper::forRootEach	(	const std::string &	func,
		Vox *	in = `nullptr`
	)

static

Move through all v-layers and run func for every.

int RegisterVoxHelper::getIndex ( Vox * in = nullptr )

static

Get the index of current v-layer.

References VoxTreeBranch::ChildObjects(), and parent().

static bool RegisterVoxHelper::ghost ( Vox * in = nullptr )

inlinestatic

Gets the ghost mode of the current volume object.

bool RegisterVoxHelper::hasChildren ( Vox * in = nullptr )

static

Check the children layers for current volume.

Returns: TRUE when selected v-layer consist of other v-layers.

bool RegisterVoxHelper::hasNextForParent ( Vox * in = nullptr )

static

Check the next layer for parent volume.

Returns: TRUE when has a next v-layer for childs of parent's selected v-layer.

References VoxTreeBranch::ChildObjects().

bool RegisterVoxHelper::hasParent ( Vox * in = nullptr )

static

Check if volume layer has parent.

Returns: TRUE when selected v-layer have a not root's parent.

static Vox& RegisterVoxHelper::increaseObject2X ( Vox * in = nullptr )

inlinestatic

Increminate dencity of volume object's by 2 times

static Vox& RegisterVoxHelper::increaseResolution ( Vox * in = nullptr )

inlinestatic

Increase resolution of volume object

static Vox& RegisterVoxHelper::intersectWith	(	const std::string &	with,
		Vox *	in = `nullptr`
	)

inlinestatic

Intersect volume with other one.

Parameters

with	name of the object to intersect with

static bool RegisterVoxHelper::isEmpty ( Vox * in = nullptr )

inlinestatic

Checks whether a volume is empty.

Returns: true if the volume is empty, false otherwise.

Referenced by polycount(), polycountScene(), square(), and volume().

static bool RegisterVoxHelper::isSurface ( Vox * in = nullptr )

inlinestatic

Checks whether a current volume mode is surface.

Returns: true if the current volume mode is surface, false otherwise.

Referenced by isVoxel().

static bool RegisterVoxHelper::isVoxel ( Vox * in = nullptr )

inlinestatic

Checks whether a current volume mode is voxel.

Returns: true if the current volume mode is voxel, false otherwise.

References isSurface().

Vox & RegisterVoxHelper::last ( Vox * in = nullptr )

static

Move to a last v-layer among childs of selected v-layer.

References VoxTreeBranch::ChildObjects().

Referenced by moveToIndex().

Vox & RegisterVoxHelper::lastForParent ( Vox * in = nullptr )

static

Move to a last v-layer among childs of parent's selected v-layer.

References VoxTreeBranch::ChildObjects().

Vox & RegisterVoxHelper::lastForRoot ( Vox * in = nullptr )

static

Move to a last v-layer among childs of root's v-layer.

static Vox& RegisterVoxHelper::layOnGround ( Vox * in = nullptr )

inlinestatic

void RegisterVoxHelper::lockMaterial	(	const std::string &	name,
		bool	b,
		Vox *	in = `nullptr`
	)

static

Set the lock mode of the material.

Parameters

name	material name
b	locked flag (true/false)

References materialIndex().

void RegisterVoxHelper::lockObject	(	const std::string &	name,
		bool	b,
		Vox *	in = `nullptr`
	)

static

Set the lock mode for named object.

Parameters

name	object name
b	lock flag

References objectIndex().

static Vox& RegisterVoxHelper::makeSurfaceHull ( Vox * in = nullptr )

inlinestatic

Thickens the mesh object using surface extrusion.

static Vox& RegisterVoxHelper::makeVoxelHull ( Vox * in = nullptr )

inlinestatic

Make a shell mesh using the voxel algorithm. It takes more time to calculate but works well for complex topology.

static int RegisterVoxHelper::materialIndex	(	const std::string &	name,
		Vox *	in = `nullptr`
	)

inlinestatic

Gets the material index by name.

Parameters

name	material name
in	Return material index

Referenced by deleteMaterial(), lockMaterial(), renameMaterial(), setVisibleMaterial(), and visibleMaterial().

static std::string RegisterVoxHelper::materialName	(	int	index,
		Vox *	in = `nullptr`
	)

inlinestatic

Gets the material name by index.

Parameters

index material index

Returns: material name

static Vox& RegisterVoxHelper::merge3B ( Vox * in = nullptr )

inlinestatic

Import external 3B file in scene

static Vox& RegisterVoxHelper::mergeCloud ( Vox * in = nullptr )

inlinestatic

Import set of points as a sequence of small spheres

static Vox& RegisterVoxHelper::mergeObject ( Vox * in = nullptr )

inlinestatic

Import 3D object

static Vox& RegisterVoxHelper::mergeSubtree ( Vox * in = nullptr )

inlinestatic

Merge the Sub-Tree of current volume. All child layers will be deleted.

static Vox& RegisterVoxHelper::mergeTo	(	const std::string &	with,
		Vox *	in = `nullptr`
	)

inlinestatic

Merge copy of the object to other object.

Parameters

with	name of the destination volume

static Vox& RegisterVoxHelper::mergeVisible ( Vox * in = nullptr )

inlinestatic

Combine current layer with all child layers.

Vox & RegisterVoxHelper::moveCurrentToIndex	(	int	idx,
		Vox *	in = `nullptr`
	)

static

<summary>

Move the current v-layer as child of parent's selected v-layer into the relative index. v-layer with index equals to idx becomes selected

Parameters

idx	v-layer index

References moveToIndex().

static Vox& RegisterVoxHelper::moveTo	(	const std::string &	with,
		Vox *	in = `nullptr`
	)

inlinestatic

Move object to other object space.

Parameters

with	name of the destination object

Vox & RegisterVoxHelper::moveToIndex	(	const std::string &	name,
		int	index,
		Vox *	in = `nullptr`
	)

static

Move v-layer name as child of parent's selected v-layer into the relative index. v-layer becomes selected.

References VoxTreeBranch::ChildObjects(), last(), and parent().

Referenced by moveCurrentToIndex().

static std::string RegisterVoxHelper::name ( Vox * in = nullptr )

inlinestatic

Returns the current volume name.

std::string RegisterVoxHelper::names ( Vox * in = nullptr )

static

Returns all volumes for brunch (comma separated).

static std::string RegisterVoxHelper::nameShader ( Vox * in = nullptr )

inlinestatic

Gets the shader name of the current volume object.

static bool RegisterVoxHelper::next ( Vox * in = nullptr )

inlinestatic

Select the next volume. Move through all v-layers ignoring depths.

Vox & RegisterVoxHelper::nextForParent ( Vox * in = nullptr )

static

Move to a next v-layer among childs of parent's selected v-layer. Stops when parent is last.

References VoxTreeBranch::ChildObjects().

static bool RegisterVoxHelper::nextPaintLayer ( Vox * in = nullptr )

inlinestatic

Select the next paint layer.

static bool RegisterVoxHelper::nextRetopoLayer ( Vox * in = nullptr )

inlinestatic

Select next retopo layer.

Returns: false if current layer is last and no new layer was selected.

static int RegisterVoxHelper::objectIndex	(	const std::string &	name,
		Vox *	in = `nullptr`
	)

inlinestatic

Gets index of object by name ID.

Parameters

name	object name ID

Returns: object index

Referenced by lockObject(), renameObject(), setVisibleObject(), and visibleObject().

static std::string RegisterVoxHelper::objectName	(	int	index,
		Vox *	in = `nullptr`
	)

inlinestatic

Get the object name ID by index

Parameters

index object index

Returns: object name

float RegisterVoxHelper::opacityPaintLayer ( Vox * in = nullptr )

static

Gets the opacity of the current paint layer.

Returns: opacity

static Vox& RegisterVoxHelper::opAssign	(	Vox &	rhs,
		Vox *	lhs
	)

inlinestatic

Assign voxels.

void RegisterVoxHelper::opConstruct ( Vox * in = nullptr )

static

Empty constructor.

Referenced by opConstructLoadFromFile().

void RegisterVoxHelper::opConstructLoadFromFile	(	const std::string &	filename,
		Vox *	in = `nullptr`
	)

static

Load poly mesh from file. After loaded 'filename' a pointer set to the first branch.

References opConstruct().

static void RegisterVoxHelper::opCopyConstruct	(	Vox &	rhs,
		Vox *	in
	)

inlinestatic

Copy constructor.

static void RegisterVoxHelper::opDestruct ( Vox * in )

inlinestatic

Destructor.

static std::string RegisterVoxHelper::paintLayer ( Vox * in = nullptr )

inlinestatic

Gets the current layer name.

Returns: string name

Vox & RegisterVoxHelper::parent ( Vox * in = nullptr )

static

Selected a parent if parent isn't root.

Don't moves to the root's v-layer.

See Also: root() which was commented.

Referenced by getIndex(), moveToIndex(), and remove().

static Vox& RegisterVoxHelper::plainMergeSubtree ( Vox * in = nullptr )

inlinestatic

Merge Sub-Tree (no booleans)

static Vox& RegisterVoxHelper::plainMergeTo	(	const std::string &	with,
		Vox *	in = `nullptr`
	)

inlinestatic

Copy & Merge (no booleans).

static Vox& RegisterVoxHelper::plainMergeVisible ( Vox * in = nullptr )

inlinestatic

Merge Visible (no booleans)

static Vox& RegisterVoxHelper::plainMoveTo	(	const std::string &	with,
		Vox *	in = `nullptr`
	)

inlinestatic

Merge (move, no booleans)

static int RegisterVoxHelper::polycount ( Vox * in = nullptr )

inlinestatic

Gets the number of polygons of the current volume.

Returns: polygons count

References isEmpty().

static int RegisterVoxHelper::polycountScene ( Vox * in = nullptr )

inlinestatic

Gets polygons count of scene volumes

Parameters

in

Returns: polygons count

References isEmpty().

static Vox& RegisterVoxHelper::putOnGround ( Vox * in = nullptr )

inlinestatic

Snap object to ground (zero). Only vertical parallel motion will be used.

Vox & RegisterVoxHelper::remove ( Vox * in = nullptr )

static

Remove the current v-layer from vox branch tree.

References parent().

static Vox& RegisterVoxHelper::removeIntersectionWith	(	const std::string &	with,
		Vox *	in = `nullptr`
	)

inlinestatic

Subtract current volume from the destination but leave both volumes. In so way intersecting part will be removed from the destination object.

Parameters

with	name of the object to intersect with

Vox & RegisterVoxHelper::rename	(	const std::string &	newName,
		Vox *	in = `nullptr`
	)

static

Rename the current volume.

void RegisterVoxHelper::renameMaterial	(	const std::string &	oldName,
		const std::string &	newName,
		Vox *	in = `nullptr`
	)

static

Rename the old material name on the new name.

Parameters

oldName	old name
newName	new name

References materialIndex().

void RegisterVoxHelper::renameObject	(	const std::string &	oldName,
		const std::string &	newName,
		Vox *	in = `nullptr`
	)

static

Rename the sub object.

Parameters

oldName	old object name
newName	new objejct name

References objectIndex().

static void RegisterVoxHelper::renamePaintLayer	(	const std::string &	newName,
		Vox *	in = `nullptr`
	)

inlinestatic

Rename the current paint layer.

Parameters

newName layer's name

static void RegisterVoxHelper::renameRetopoLayer	(	const std::string &	newName,
		Vox *	in = `nullptr`
	)

inlinestatic

Rename the current retopo layer

Parameters

newName name to rename

void RegisterVoxHelper::renameUVSet	(	const std::string &	oldName,
		const std::string &	newName,
		Vox *	in = `nullptr`
	)

static

Rename the old uvset name by new name

Parameters

oldName	old name
newName	new name

References uvsetIndex().

static Vox& RegisterVoxHelper::resample ( Vox * in = nullptr )

inlinestatic

Change resolution of the volume object

static std::string RegisterVoxHelper::retopoLayer ( Vox * in = nullptr )

inlinestatic

Gets the current retopo layer.

Returns: layer name

static Vox& RegisterVoxHelper::save3B ( Vox * in = nullptr )

inlinestatic

Save Volume as 3B

static Vox& RegisterVoxHelper::saveSubtree3B ( Vox * in = nullptr )

inlinestatic

Save Volume w/ Sub-Tree as 3B

static void RegisterVoxHelper::setBlendingPaintLayer	(	const std::string &	name,
		Vox *	in = `nullptr`
	)

inlinestatic

Set blending mode of the current paint layer.

Parameters

name	id's of the color blending mode

static Vox& RegisterVoxHelper::setColor	(	int	v,
		Vox *	in = `nullptr`
	)

inlinestatic

Sets the color for current volume object.

Parameters

v	color 32-bits(argb) value

Referenced by setColorRGB().

static Vox& RegisterVoxHelper::setColorRGB	(	int	r,
		int	g,
		int	b,
		Vox *	in = `nullptr`
	)

inlinestatic

Sets the RGB color for current volume object.

Parameters

r	red channel
g	green channel
b	blue channel

References setColor().

static void RegisterVoxHelper::setDepthBlendingPaintLayer	(	const std::string &	name,
		Vox *	in = `nullptr`
	)

inlinestatic

Sets depth blending mode of the current paint layer.

Parameters

name	id's of the depth blending mode

void RegisterVoxHelper::setDepthOpacityPaintLayer	(	float	v,
		Vox *	in = `nullptr`
	)

static

Sets the depth opacity of the current paint layer.

Parameters

v	opacity value(0..1)

static Vox& RegisterVoxHelper::setGhost	(	bool	v,
		Vox *	in = `nullptr`
	)

inlinestatic

Sets on/off the ghost mode of the current volume object.

static Vox& RegisterVoxHelper::setOpacity	(	float	v,
		Vox *	in = `nullptr`
	)

inlinestatic

Sets the opacity for current volume object.

Parameters

v	opacity value

void RegisterVoxHelper::setOpacityPaintLayer	(	float	v,
		Vox *	in = `nullptr`
	)

static

Sets the opacity of the current paint layer.

Parameters

v	opacity value(0..1)

static bool RegisterVoxHelper::setPaintLayer	(	const std::string &	name,
		Vox *	in = `nullptr`
	)

inlinestatic

Select the paint layer.

Parameters

name	layer's name

static bool RegisterVoxHelper::setRetopoLayer	(	const std::string &	name,
		Vox *	in = `nullptr`
	)

inlinestatic

Select retopo layer with name ID.

Parameters

name	id of layer name

Returns: false if layer not found.

static Vox& RegisterVoxHelper::setShaderProperty	(	const std::string &	name,
		const std::string &	vs,
		Vox *	in = `nullptr`
	)

inlinestatic

Sets the shader property of the current volume object.

Parameters

name	property id
vs	string value

static Vox& RegisterVoxHelper::setTransform	(	const comms::cMat4 &	m,
		Vox *	in = `nullptr`
	)

inlinestatic

Sets the transform matrix for the current volume object.

static Vox& RegisterVoxHelper::setVisible	(	bool	v,
		Vox *	in = `nullptr`
	)

inlinestatic

Sets the visibility of the current volume object.

Referenced by coat::scripto::SculptLayer::visible().

void RegisterVoxHelper::setVisibleMaterial	(	const std::string &	name,
		bool	v,
		Vox *	in = `nullptr`
	)

static

Gets the visibility of material.

Parameters

name	material name

References materialIndex().

void RegisterVoxHelper::setVisibleObject	(	const std::string &	name,
		bool	v,
		Vox *	in = `nullptr`
	)

static

Get the object visibility.

Parameters

name	object name
v	visibility flag

References objectIndex().

static void RegisterVoxHelper::setVisiblePaintLayer	(	bool	v,
		Vox *	in = `nullptr`
	)

inlinestatic

Gets the visibility mode of the current paint layer.

Parameters

v	visible value

static void RegisterVoxHelper::setVisibleRetopoLayer	(	bool	v,
		Vox *	in = `nullptr`
	)

inlinestatic

Set visibility of current retopo layer.

Parameters

v	visibility mode.

static Vox& RegisterVoxHelper::showAllHidden ( Vox * in = nullptr )

inlinestatic

Shows all v-layers

static Vox& RegisterVoxHelper::showHiddenSubtree ( Vox * in = nullptr )

inlinestatic

Shows hidden subtree v-layers for current vox tree branch

static Vox& RegisterVoxHelper::splitWith	(	const std::string &	with,
		Vox *	in = `nullptr`
	)

inlinestatic

Split volume in two parts(volumes) with destination volume.

Parameters

with	name of the object to split with

static float RegisterVoxHelper::square ( Vox * in = nullptr )

inlinestatic

Gets a current volume square.

Returns: square value

References isEmpty().

static Vox& RegisterVoxHelper::subtractFrom	(	const std::string &	with,
		Vox *	in = `nullptr`
	)

inlinestatic

Subtract object from other object.

Parameters

with	name of the object to subtract from

Vox & RegisterVoxHelper::to	(	const std::string &	name,
		Vox *	in = `nullptr`
	)

static

Switch to v-layer named like name.

static Vox& RegisterVoxHelper::toGlobalSpace ( Vox * in = nullptr )

inlinestatic

Sets the volume objects to the global space

Vox & RegisterVoxHelper::toSurface ( Vox * in = nullptr )

static

Sets the current volume to surface mode.

Referenced by coat::scripto::SculptLayer::surface().

static Vox& RegisterVoxHelper::toUniformSpace ( Vox * in = nullptr )

inlinestatic

Sets the volume objects to the uniform space

static Vox& RegisterVoxHelper::toVoxel ( Vox * in = nullptr )

inlinestatic

Sets the current volume to voxel mode.

References toVoxelSuggestPoly().

Referenced by coat::scripto::SculptLayer::surface().

Vox & RegisterVoxHelper::toVoxelSuggestPoly	(	int	suggestPoly,
		Vox *	in = `nullptr`
	)

static

Sets the current volume to voxel mode with corresponding number of polygons.

Referenced by toVoxel().

static comms::cMat4 RegisterVoxHelper::transform ( Vox * in = nullptr )

inlinestatic

Gets the transform matrix from current volume object.

static Vox& RegisterVoxHelper::turnToShell ( Vox * in = nullptr )

inlinestatic

Thickens the surface of volume object.

int RegisterVoxHelper::uvsetIndex	(	const std::string &	name,
		Vox *	in = `nullptr`
	)

static

Gets the retopo UVsets index by name.

Parameters

name	retopo uvsets name

Returns: uvsets index.

Referenced by renameUVSet().

static std::string RegisterVoxHelper::uvsetName	(	int	index,
		Vox *	in = `nullptr`
	)

inlinestatic

Gets the retopo uvsets name by index.

Parameters

index index value

Returns: uvset name

static bool RegisterVoxHelper::visible ( Vox * in = nullptr )

inlinestatic

Gets the visibility of the current volume object.

bool RegisterVoxHelper::visibleMaterial	(	const std::string &	name,
		Vox *	in = `nullptr`
	)

static

Gets the visibility of material.

Parameters

name	material name

Returns: true if material is visiable otherwise false.

References countMaterial(), and materialIndex().

bool RegisterVoxHelper::visibleObject	(	const std::string &	name,
		Vox *	in = `nullptr`
	)

static

Get the object visibility.

Parameters

name	object name
in

Returns: true if object is visiable otherwise false.

References countObject(), and objectIndex().

static bool RegisterVoxHelper::visiblePaintLayer ( Vox * in = nullptr )

inlinestatic

Gets the visibility of the current paint layer.

Returns: true if paint layer is visiable otherwize false.

static bool RegisterVoxHelper::visibleRetopoLayer ( Vox * in = nullptr )

inlinestatic

Gets visibility of the current retopo layer

Returns: visibility mode.

static float RegisterVoxHelper::volume ( Vox * in = nullptr )

inlinestatic

Gets a volume of the current volume.

Returns: volume value

References isEmpty().

The documentation for this class was generated from the following files:

3d-coat/3D-CoatV4/3D-Coat/Scripto/SVox.h
3d-coat/3D-CoatV4/3D-Coat/Scripto/SVox.cpp

Static Public Member Functions

Don't moves to the root's v-layer.

Detailed Description

Member Function Documentation

Don't moves to the root's v-layer.