AlReferenceFileSet

Deletes an AlReferenceFileSet wrapper object.

Synopsis

class AlReferenceFileSet	: public AlObject
{
public:
	virtual					~AlReferenceFileSet();

	virtual statusCode		deleteObject();
	virtual AlObject*  		copyWrapper() const;

	virtual AlObjectType	type() const;

	virtual const char*		name() const;
	virtual statusCode		setName( const char* );

    bool                    isAlternative() const;
    bool                    isVisible() const;
    statusCode              setVisible(bool isVisible);
    bool                    hasColour() const;
    bool                    getColour(unsigned char rgba[4]) const;
    statusCode              setColour(unsigned char rgba[4]);

    AlReferenceFile*		firstReferenceFile();
	AlReferenceFile*		nextReferenceFile( AlReferenceFile* );
	statusCode		        nextReferenceFileD( AlReferenceFile*, bool rootOnly = false );

    statusCode              addReferenceFile( AlReferenceFile* );
    statusCode              addReferenceFileToAlternative(AlReferenceFile*);
    statusCode              removeReferenceFileFromAlternative(AlReferenceFile*);

protected:
							AlReferenceFileSet();
private:
	static void				initMessages();
	static void				finiMessages();
};

statusCode AlReferenceFileSet::deleteObject()

Description

Deletes the associated AlReferenceFileSet.

Return Codes

sSuccess - the AlReferenceFileSet data was successfully deleted.

sInvalidObject - the AlReferenceFileSet was not valid.

AlObject* AlReferenceFileSet::copyWrapper() const

Description

Makes a copy of the AlReferenceFileSet. The returned AlReferenceFileSet references the same data as the original.

AlObjectType AlReferenceFileSet::type() const

Description

Returns the class identifier kRefFileSetType.

const char* AlReferenceFileSet::name() const

Description

Returns a pointer to this camera's name.

statusCode AlReferenceFileSet::setName( const char* )

Description

Changes the FileSet's name to the given name. If the given name is not unique, then a unique name is generated.

Arguments

< const char *newName - The name to be given to the FileSet.

Return Codes

s Success - If successful.

sInvalidObject - If the FileSet is not valid.

sInvalidArgument - Given pointer is NULL.

bool AlReferenceFileSet::isAlternative() const

bool AlReferenceFileSet::isVisible( bool isVisible )

statusCode AlReferenceFileSet::setVisible( bool isVisible )

bool AlReferenceFileSet::hasColour() const

bool AlReferenceFileSet::getColour( unsigned char rgba[4] ) const

statusCode AlReferenceFileSet::setColour( unsigned char rgba[4] )

AlReferenceFile* AlReferenceFileSet::firstReferenceFile()

Description

Returns the first Reference file set in the list of Alias AlReferenceFileSet objects. NULL is returned if the list is empty.

AlReferenceFile* AlReferenceFileSet::nextReferenceFile( AlReferenceFile* refFile)

Description

Returns the AlShader following curShader in the list of Alias AlShader objects. NULL is returned if curShader has no next shader.

Arguments

< curShader - Shader from which to walk forward.

statusCode AlReferenceFileSet::nextReferenceFileD( AlReferencFile* refFile )

Description

Destructively points 'curShader' to the AlShader following curShader in the list of Alias AlShader objects.

Arguments

< curShader - Shader from which to walk forward.

rootOnly (default value is false) - Allows the caller to traverse only the top level of the reference structure as opposed to traversing the whole assembly tree.

Return Codes

sSuccess - curShader now points to the next shader.

sFailure - There is no next shader.

sInvalidArgument - curShader was invalid.

statusCode AlReferenceFileSet::addReferenceFileToAlternative( AlReferenceFile* refFile ) const

statusCode AlReferenceFileSet::removeReferenceFileFromAlternative( AlReferenceFile* refFile )