Inheritance diagram for ComponentRef:

Public Member Functions
	ComponentRef ()

	ComponentRef (Group *srcObjs, String tmpFilePath)

bool	isNULL ()

void	ReloadComponentFile ()

void	SetComponentFilePath (String filename)

String	GetComponentFilePath ()

RSOAvailableAttributesArray	GetAvailableAttributes ()

RSOInitialAttributeValuesArray	GetInitialAttributeValues ()

void	SetInitialAttributeValue (String attribute, String attributeValue)

void	DeleteInitialAttributeValue (String attribute)

bool	UsingLiveComponent () throw ( CEIException& )

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)

Static Public Member Functions
static ComponentRef *	CastToComponentRef (DisplayObject *obj)

Static Public Member Functions inherited from Group
static Group *	CastToGroup (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 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 extension to access and modify Component reference settings.

Constructor & Destructor Documentation

ComponentRef::ComponentRef ( )

ComponentRef::ComponentRef	(	Group *	srcObjs,
		String	tmpFilePath
	)

Member Function Documentation

static ComponentRef* ComponentRef::CastToComponentRef ( DisplayObject * obj )

static

void ComponentRef::DeleteInitialAttributeValue ( String attribute )

delete an initial RSO attribute value

Parameters

attribute attribute in question

Precondition: !isNULL(), GetAvailableAttributes().IsAttributeInArray( attribute ) == true

RSOAvailableAttributesArray ComponentRef::GetAvailableAttributes ( )

get an array of the available RSO attribute names

Returns: an array of the available RSO attribute names

Precondition: !iSNULL()

String ComponentRef::GetComponentFilePath ( )

Gets the path to the component file (.gls or .dll/.so) for this component object.

See also: SetComponentFilePath()

RSOInitialAttributeValuesArray ComponentRef::GetInitialAttributeValues ( )

get an array of the initial RSO attribute values

Returns: an array of the initial RSO attribute values

Precondition: !isNULL()

bool ComponentRef::isNULL ( )

determine if wrapped componet ref does not exist

Returns: true if wrapped component ref does not exist

Deprecated:: Refer to the Truth Value Checking page

void ComponentRef::ReloadComponentFile ( )

Forces a reload of a Component File.

Precondition: !isNULL()

void ComponentRef::SetComponentFilePath ( String filename )

Sets the path to the component file (.gls or .dll/.so) for this component object.

See also: GetComponentFilePath()

void ComponentRef::SetInitialAttributeValue	(	String	attribute,
		String	attributeValue
	)

set an initial RSO attribute value

Parameters

attribute	attribute in question
attributeValue	initial value for attribute

Precondition: !isNULL(), GetAvailableAttributes().IsAttributeInArray( attribute ) == true

bool ComponentRef::UsingLiveComponent	(		)
throw	(	CEIException &
	)

Returns whether the component is a live (pre-built) or a design file.

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

ComponentRef.i

Public Member Functions

Static Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation