Inheritance diagram for Catalyzer:

Public Member Functions
	Catalyzer ()

unsigned int	GetScriptCount ()

void	AddScript (String scriptPath)

void	InsertScriptAtIndex (String scriptPath, unsigned int index)

void	RemoveScriptAtIndex (unsigned int index)

String	GetScriptAtIndex (unsigned int index)

void	RunScripts ()

void	SetNeedsReaction ()

RefreshModeType	GetRefreshMode ()

void	SetRefreshMode (RefreshModeType mode)

bool	IsPrefixingObjectNames ()

void	SetPrefixingObjectNames (bool enabled)

void	DeleteOverriddenProperty (String objectName, String attributeName, OverriddenPropertyType_e typeToDelete=OVERRIDDEN_ALL)

void	DeleteAllOverriddenPropertiesOfType (OverriddenPropertyType_e overriddenPropertyType)

std::map< String, std::vector< std::pair< String, String > > >	GetOverriddenProperties (OverriddenPropertyType_e overriddenPropertyType=OVERRIDDEN_ALL)

Document *	GetDocument (void)

String	GetAttributeValueString (String attribName)

void	SetAttributeValueString (String attribName, String value)

Public Member Functions inherited from Group
	Group ()

	Group (DisplayObjectArray *objs)

void	Ungroup ()

void	InsertObject (DisplayObject *obj, bool reparent=true, bool recalculateBoundingbox=true, int loc=DEFAULT_GROUP_LOCATION, bool renameName=false)

void	InsertObjectAllowDuplicateNames (DisplayObject *obj, bool reparent=true, bool recalculateBoundingbox=true, int loc=DEFAULT_GROUP_LOCATION)

void	MoveObjectToGroup (DisplayObject *obj, bool recalculateBoundingbox=true, int loc=DEFAULT_GROUP_LOCATION, bool renameName=false)

void	MoveObjectToGroupAllowDuplicateNames (DisplayObject *obj, bool recalculateBoundingbox=true, int loc=DEFAULT_GROUP_LOCATION)

void	ReorderObject (unsigned int oldIndex, unsigned int newIndex)

DisplayObjectArray *	GetObjectList ()

DisplayObject *	GetObjectByIndex (unsigned int index)

unsigned int	Count (void)

void	CalculateTextureCoordinates (void)

void	SetGroupLocation (Vertex &v)

void	CalculateBoundingBox ()

unsigned int	GetCount ()

Public Member Functions inherited from DisplayObject
bool	isNULL (void)

String	GetName ()

String	SetName (String name)

void	SetProtectionMode (DisplayObject::MemberAccess_e mode)

DisplayObject::MemberAccess_e	GetProtectionMode (void)

void	SetLocked (bool val)

bool	GetLocked (void)

bool	GetGenerateMemberVariable ()

void	SetGenerateMemberVariable (bool b)

bool	GetAntiAliasing ()

void	SetAntiAliasing (bool antiAliasing)

bool	GetBlinking ()

void	SetBlinking (bool blinking)

float	GetBlinkRate ()

void	SetBlinkRate (float rate)

int	GetAlphaMode ()

void	SetAlphaMode (int mode)

bool	GetCullBackFaces ()

void	SetCullBackFaces (bool cullFaces)

bool	GetZBufferTestedFlag ()

void	SetZBufferTestedFlag (bool tested)

bool	GetAffectZBufferFlag ()

void	SetAffectZBufferFlag (bool affect)

bool	GetLightingEnabledFlag ()

void	SetLightingEnabledFlag (bool enabled)

DisplayObject::PickableType_e	GetPickMode ()

void	SetPickMode (DisplayObject::PickableType_e mode)

bool	GetVisibilityFlag ()

void	SetVisibilityFlag (bool visible)

PolygonClose_e	GetClosePolygonFlag ()

void	SetClosePolygonFlag (PolygonClose_e closePolygon)

PolygonMode_e	GetPolygonMode ()

void	SetPolygonMode (PolygonMode_e polygonMode)

ShadingType_e	GetShadingMode ()

void	SetShadingMode (ShadingType_e shadingMode)

Vertex	GetLocation ()

void	SetLocation (Vertex loc)

Vertex	GetRotationPoint ()

void	SetRotationPoint (Vertex rotPoint)

GlsMatrixAffine *	GetDcsMatrix ()

void	SetDcsMatrix (GlsMatrixAffine *matrix)

int	GetMaterialIndex ()

void	SetMaterialIndex (int matIndex)

String	GetObjectClassName ()

int	GetTextureIndex ()

void	SetTextureIndex (int texIndex)

TextureMap_e	GetTextureMappingTechnique ()

void	SetTextureMappingTechnique (TextureMap_e mappingTechnique)

bool	GetTextureRepeat ()

void	SetTextureRepeat (bool repeat)

disti::GlsColor	GetBlendingColor ()

void	SetBlendingColor (GlsColor blendColor)

DisplayObject::TextureFilter_e	GetTextureMagnificationFilter ()

void	SetTextureMagnificationFilter (DisplayObject::TextureFilter_e filter)

DisplayObject::TextureFilter_e	GetTextureMinificationFilter ()

void	SetTextureMinificationFilter (DisplayObject::TextureFilter_e filter)

std::vector< Vector >	GetTextureCoordinates ()

void	SetTextureCoordinates (std::vector< Vector > &texVerts)

void	GetTextureCoordinates (VertexArray *texVerts)

void	SetTextureCoordinates (VertexArray &texVerts)

void	GetTexturePoints (VertexArray *texVerts)

void	SetTexturePoints (VertexArray &texVerts)

void	SetTexturePoints (std::vector< Vector > &texVerts)

std::vector< Vector >	GetTexturePoints ()

void	GetVertices (VertexArray *verts)

void	SetVertices (VertexArray &verts)

String	GetInitialization ()

void	SetInitialization (String initCode)

String	GetCallbackCode ()

void	SetCallbackCode (String cbCode)

DisplayObject *	DuplicateObject (Document *doc=NULL)

DisplayObject *	TessellateObject ()

DisplayObject *	ExtrudeObject (float amount)

void	RotateObject (float amount, RotationAxis_e axis)

void	TranslateObject (float x, float y, float z)

void	ScaleObject (float x, float y, float z, Vertex *anchor=NULL)

void	LineWidth (float width)

float	LineWidth ()

LineStyle_e	LineStyle ()

void	LineStyle (LineStyle_e style)

GlsColor	LineColor ()

void	LineColor (GlsColor color)

GlsColor	FillColor ()

void	FillColor (GlsColor color)

void	GetExtents (Vector &min, Vector &max)

bool	HasUserDefinedAttribute (String attribName)

std::map< String, String >	GetUserDefinedAttributes ()

String	GetUserDefinedAttributeValue (String attribName)

	typemap (check) String attribName

void	SetUserDefinedAttributeValue (String attribName, String value)

DisplayObject *	GetParent ()

Document *	GetDocument ()

String	AlternateClassName ()

void	AlternateClassName (String name)

String	GetAlternateClassHeaderFile ()

void	SetAlternateClassHeaderFile (String name)

String	GetResources ()

String	GetRuntimeResources (bool recursive)

String	GetAttributeValueString (String attribName)

void	SetAttributeValueString (String attribName, String value)

unsigned int	RegisterObserver (String attribName, PyObject *pyfunc)

void	UnregisterObserver (String attribName, unsigned int id)

std::vector< Vector >	GetNormals ()

void	SetNormals (std::vector< Vector > &normals)

std::vector< CustomAttributeInfo >	GetExtraAttributes ()

DisplayObject *	CloneObject ()

void	CopyProperties (DisplayObject *sourceObj)

void	SetLocation (Vector loc)

GlsMatrixAffine	GetObjectCoordinatesTransform (DisplayObject *targetObject)

void	CalculateParentBoundingBox ()

void	SetOrigin (Vertex &vert)

Module Methods
Methods that can be called on the module.
static Catalyzer *	CastToCatalyzer (DisplayObject *obj)

Additional Inherited Members
Public Types inherited from DisplayObject
enum	MemberAccess_e { PUBLIC, PRIVATE, PROTECTED }

enum	PickableType_e { UNPICKABLE, FIRST_PICK, BEST_PICK, ALWAYS_PICK }

enum	PolygonClose_e { POLY_OPEN, POLY_CLOSED }

enum	PolygonMode_e { POLY_MODE_UNDEFINED, POLY_MODE_POINTS, POLY_MODE_OUTLINE, POLY_MODE_FILLED, POLY_MODE_FILL_AND_OUTLINE }

enum	ShadingType_e { SHADING_FLAT, SHADING_GOURAUD }

enum	TextureMap_e { TEXTURE_MAP_MODULATE, TEXTURE_MAP_DECAL, TEXTURE_MAP_BLEND, TEXTURE_MAP_REPLACE }

enum	TextureFilter_e { TEXTURE_FILTER_NEAREST, TEXTURE_FILTER_LINEAR, TEXTURE_FILTER_NEAREST_MIPMAP_NEAREST, TEXTURE_FILTER_LINEAR_MIPMAP_LINEAR, TEXTURE_FILTER_NEAREST_MIPMAP_LINEAR, TEXTURE_FILTER_LINEAR_MIPMAP_NEAREST }

enum	TessellateType_e { TESSELLATE_UNION, TESSELLATE_INTERSECT, TESSELLATE_DIFFERENCE }

enum	RotationAxis_e { X_AXIS, Y_AXIS, Z_AXIS }

enum	LineStyle_e { SOLID_LINE_STYLE, SMALL_DOTTED_LINE_STYLE, DOTTED_LINE_STYLE, DASHED_LINE_STYLE, DOT_DASHED_LINE_STYLE, SMALL_DASHED_LINE_STYLE }

enum	AlphaMode_e { ALPHA_MODE_UNDEFINED, ALPHA_MODE_OPAQUE, ALPHA_MODE_2_LEVEL, ALPHA_MODE_256_LEVEL }

Static Public Member Functions inherited from Group
static Group *	CastToGroup (DisplayObject *obj)

Static Public Attributes inherited from Group
static int	DEFAULT_GROUP_LOCATION = -1

Static Public Attributes inherited from DisplayObject
static int	TEXTURE_INDEX_NONE = -1

Detailed Description

Python engine extension for the Catalzyer editor object.

See also: Enumeration: RefreshModeType

Constructor & Destructor Documentation

Catalyzer::Catalyzer ( )

Creates an empty catalyzer.

Member Function Documentation

void Catalyzer::AddScript ( String scriptPath )

Add a script to the end of the list.

Parameters

scriptPath the path to the script

static Catalyzer* Catalyzer::CastToCatalyzer ( DisplayObject * obj )

static

Casts the specified object to a Catalyzer.

void Catalyzer::DeleteAllOverriddenPropertiesOfType ( OverriddenPropertyType_e overriddenPropertyType )

Delete and stop tracking a filtered subset of all Overridden Properties of a Catalyzer.

Parameters

overriddenPropertyType enum to filter which type of overridden properties are removed

void Catalyzer::DeleteOverriddenProperty	(	String	objectName,
		String	attributeName,
		OverriddenPropertyType_e	typeToDelete = `OVERRIDDEN_ALL`
	)

Delete and stop tracking an individual Overridden Property of a Catalyzer.

Parameters

objectName	The full Child (object) name as String
attributeName	the full Property (attribute) name as String
typeToDelete	OverriddenPropertyType of the property to be deleted, resolvng possible ambiguity

String Catalyzer::GetAttributeValueString ( String attribName )

Gets the value for a single attribute of the object.

See also: SetAttributeValueString(); GetResources()

Since: GL Studio 6.0.1

Document* Catalyzer::GetDocument ( void )

Retrieves the display object's document.

Returns: Document * the object's document

Since: GL Studio 6.0.1

std::map< String , std::vector< std::pair< String , String > > > Catalyzer::GetOverriddenProperties ( OverriddenPropertyType_e overriddenPropertyType = OVERRIDDEN_ALL )

Get a dictionary of all Overriden Properties pairs of a specific catalyzer filtered by enum type.

Parameters

overriddenPropertyType enum by which overriddenProperties is filtered (default to OVERRIDDEN_ALL)

Returns: dictionary of two vectors of String pairs corresponding to Child Name and Property Name split into Local and Referenced

RefreshModeType Catalyzer::GetRefreshMode ( )

Gets the Refresh Mode.

Returns: The Refresh Mode that was set via SetRefreshMode() This only differs from CurrentRefreshMode() when when REFRESH_SCRIPT_CONTROLLED is set

String Catalyzer::GetScriptAtIndex ( unsigned int index )

Get the script path at the specified index.

Parameters

index the index of the script to retrieve

Returns: the script path. Will be fully qualified path, regardless of user settings concerning absolute path.

unsigned int Catalyzer::GetScriptCount ( )

Get the number of scripts.

void Catalyzer::InsertScriptAtIndex	(	String	scriptPath,
		unsigned int	index
	)

Insert a script before the specified index.

Parameters

scriptPath	the path to the script
index	the index to add the script at

bool Catalyzer::IsPrefixingObjectNames ( )

Get the status of the Prefix Object Names flag to see if object prefixes are enabled.

Returns: the status of object name prefixes

void Catalyzer::RemoveScriptAtIndex ( unsigned int index )

Remove a script at the specified index.

Parameters

index the index of the script to remove

void Catalyzer::RunScripts ( )

Run the scripts.

void Catalyzer::SetAttributeValueString	(	String	attribName,
		String	value
	)

Sets the value for a single attribute of the object.

See also: GetAttributeValueString(); GetResources()

Since: GL Studio 6.0.1

void Catalyzer::SetNeedsReaction ( )

Sets the flag if the reactions need to be run on this catalyzer.

void Catalyzer::SetPrefixingObjectNames ( bool enabled )

Set the Prefix Object Names flag.

Parameters

enabled the desired state of the Prefix Object Names flag

void Catalyzer::SetRefreshMode ( RefreshModeType mode )

Set the Refresh Mode to control when reactions fire.

Parameters

mode	desired Refresh Mode to be set

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

Catalyzer.i

Public Member Functions

Module Methods

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation