The scene element, like sculpt object or curve. More...

#include <CoreAPI.h>

Public Member Functions
SceneElement	parent ()
	get the parent scene graph element More...

int	childCount ()
	returns the child elements count More...

SceneElement	child (int index)
	returns child element by index More...

bool	isSculptObject ()
	Check if it is the sculpt object. More...

bool	isCurve ()
	Check if the element is curve. More...

SceneElement &	setTransform (const mat4 &Transform)
	Set the transform matrix. More...

SceneElement &	transform (const mat4 &Transform)
	Additional transform over the object. More...

mat4	getTransform ()
	get the scene element transform More...

SceneElement &	clear ()
	Clear the element content. More...

const char *	name ()
	get the element name More...

SceneElement &	rename (const char *name)
	rename the element More...

SceneElement	addChild (const char *name)
	add the child element of the same nature More...

SceneElement	findInSubtree (const char *name)
	find the element in subtree by name More...

void	mergeSubtree (bool booleanMerge=false)
	merge all subtree volumes into this More...

void	removeSubtree ()
	remove the whole subtree More...

void	removeSubtreeItem (int index)
	remove one child from the subtree More...

void	remove ()
	remove this item and all child objects from the scene More...

SceneElement	duplicate ()
	diplicate the item More...

SceneElement	duplicateAsInstance ()
	create the instance of the object if instancing supported More...

void	changeParent (SceneElement newParent)
	change the parent element for the current one More...

bool &	visible ()
	returns own visibility state reference. It does not take into account that parent may be invisible. More...

Volume	Volume ()
	returns the volume object to operate over voxels or surface More...

Detailed Description

The scene element, like sculpt object or curve.

Member Function Documentation

coat::SceneElement coat::SceneElement::addChild ( const char * name )

add the child element of the same nature

Parameters

name the name

Returns: the new element reference

void coat::SceneElement::changeParent ( SceneElement newParent )

change the parent element for the current one

Parameters

newParent the new parent reference. Pay attention, changing paren is not always possible!

coat::SceneElement coat::SceneElement::child ( int index )

returns child element by index

Parameters

index the index of the element in subtree

Returns: the child reference

int coat::SceneElement::childCount ( )

returns the child elements count

Returns: child count

coat::SceneElement & coat::SceneElement::clear ( )

Clear the element content.

Returns: this element reference

coat::SceneElement coat::SceneElement::duplicate ( )

diplicate the item

Returns: the new item reference

coat::SceneElement coat::SceneElement::duplicateAsInstance ( )

create the instance of the object if instancing supported

Returns: the instance reference

coat::SceneElement coat::SceneElement::findInSubtree ( const char * name )

find the element in subtree by name

Parameters

name	the name t seek

Returns: the element reference

Matrix4D coat::SceneElement::getTransform ( )

get the scene element transform

Returns: the transform matrix

bool coat::SceneElement::isCurve ( )

Check if the element is curve.

Returns: true if this is curve

bool coat::SceneElement::isSculptObject ( )

Check if it is the sculpt object.

Returns: true if this is the sculpt object

void coat::SceneElement::mergeSubtree ( bool booleanMerge = false )

merge all subtree volumes into this

Parameters

booleanMerge use boolean summ to merge. Othervice merge meshes without booleans. This option works only for surfave, in voxels it will always do boolean summ

const char * coat::SceneElement::name ( )

get the element name

Returns: the name

coat::SceneElement coat::SceneElement::parent ( )

get the parent scene graph element

Returns: the parent reference

void coat::SceneElement::remove ( )

remove this item and all child objects from the scene

void coat::SceneElement::removeSubtree ( )

remove the whole subtree

void coat::SceneElement::removeSubtreeItem ( int index )

remove one child from the subtree

Parameters

index index of the child

coat::SceneElement & coat::SceneElement::rename ( const char * name )

rename the element

Parameters

name	the new name

Returns: this element reference

coat::SceneElement & coat::SceneElement::setTransform ( const mat4 & Transform )

Set the transform matrix.

Parameters

Transform the transform matrix

Returns: this element reference

References setTransform().

Referenced by setTransform().

coat::SceneElement & coat::SceneElement::transform ( const mat4 & Transform )

Additional transform over the object.

Parameters

Transform the matrix

Returns: this element reference

References transform().

Referenced by transform().

bool & coat::SceneElement::visible ( )

returns own visibility state reference. It does not take into account that parent may be invisible.

Returns: item local visibility reference, you may get and set the visibility with the reference.

coat::Volume coat::SceneElement::Volume ( )

returns the volume object to operate over voxels or surface

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

3d-coat/3D-CoatV4/CoreAPI/CoreAPI.h
3d-coat/3D-CoatV4/CoreAPI/CoreAPI.cpp

Public Member Functions

Detailed Description

Member Function Documentation