Sculpt

Detailed Description

Groups
	SCULPT

Classes
class	SculptLayerData
class	SculptLayerBase
class	SculptLayer
class	SculptFolder
class	SculptLayerSystem
struct	SculptHitData
class	SculptObject
class	SculptTag

Macros
#define	LIBRARY_SCULPT

Functions
SculptObject *	GetSelectedSculptObject (BaseDocument *doc, Bool includeHiddenObjects=false)
const SculptObject *	GetSelectedSculptObject (const BaseDocument *doc, Bool includeHiddenObjects=false)
SculptObject *	MakeSculptObject (PolygonObject *poly, BaseDocument *doc, Bool addUndo=false)
Bool	IsObjectEnabled (BaseObject *pObject)
void	EnsureSculptObjectReady (PolygonObject *obj, BaseDocument *doc)

Macro Definition Documentation

LIBRARY_SCULPT

#define LIBRARY_SCULPT

Sculpt library ID.

Function Documentation

GetSelectedSculptObject() [1/2]

SculptObject* cinema::GetSelectedSculptObject	(	BaseDocument *	doc,
		Bool	includeHiddenObjects = false
	)

Gets the currently selected SculptObject in the document. This is the first selected PolygonObject that has a SculptTag.

Parameters

[in]	doc	The document to search. The caller owns the pointed document.
[in]	includeHiddenObjects	true to include selected hidden objects.

Returns

The SculptObject that the SculptTag references.

GetSelectedSculptObject() [2/2]

const SculptObject* cinema::GetSelectedSculptObject	(	const BaseDocument *	doc,
		Bool	includeHiddenObjects = false
	)

Gets the currently selected SculptObject in the document. This is the first selected PolygonObject that has a SculptTag.

Parameters

[in]	doc	The document to search. The caller owns the pointed document.
[in]	includeHiddenObjects	true to include selected hidden objects.

Returns

The SculptObject that the SculptTag references.

MakeSculptObject()

SculptObject* cinema::MakeSculptObject	(	PolygonObject *	poly,
		BaseDocument *	doc,
		Bool	addUndo = false
	)

Adds a SculptTag to the PolygonObject if one does not exist then return the SculptObject that the newly created SculptTag references.

Parameters

[in]	poly	The PolygonObject to add the SculptTag to. The caller owns the pointed PolygonObject.
[in]	doc	The document that the PolygonObject belongs to. The caller owns the pointed document.
[in]	addUndo	If true then an undo event will be added so that the addition of the SculptTag can be undone.

Returns

The SculptObject that the SculptTag references.

IsObjectEnabled()

Bool cinema::IsObjectEnabled

(

BaseObject *

pObject

)

Checks if an object is currently visible in the viewport.

Parameters

[in]

pObject

The object to check. The caller owns the pointed object.

Returns

true if the object is enabled in the editor viewport, otherwise false.

EnsureSculptObjectReady()

void cinema::EnsureSculptObjectReady	(	PolygonObject *	obj,
		BaseDocument *	doc
	)

Ensures that a copy a PolygonObject that has a SculptTag on it is initialized correctly straight after adding it to a document.

Parameters

[in]	obj	The PolygonObject that has the SculptTag. The caller owns the pointed PolygonObject.
[in]	doc	The document the object belongs to. The caller owns the pointed document.