AlConstructionEntity

Base class for Alias construction entities.

Synposis

#include <AlConstructionEntity.h>
class AlConstructionEntity : public AlObject, public AlPickable 
virtual ~AlConstructionEntity();
virtual statusCode	    deleteObject();
virtual AlObject *	    copyWrapper() const = 0;
virtual AlObjectType	type() const;
virtual const char*	name() const;
virtual statusCode	setName( const char * );
AlLayer *	layer();
statusCode 	setLayer( AlLayer * );
boolean	invisible();
statusCode	setInvisible( boolean );
statusCode              	templated(boolean &) const;

Description

This base class encapsulates methods common to Alias construction entities. These entities include space points, curve points, surface points, curve on surface points, construction planes and construction vectors. Construction points have similarities to locator objects. A major difference between construction points and locators is that construction points will be on the Alias pick list. The AlPickList class can be used to retrieve picked construction entity objects. As you will see below, the AlConstructionEntity class multiply inherits from the AlPickable class.

This class contains methods for deleting, and naming locators. In addition, methods are available for working with layers and for changing invisibility and templated modes.

As in the locator objects, if a construction entity is dependent on an object that is deleted, it will also be removed.

AlConstructionEntity::AlConstructionEntity(void)

Description

Constructs an AlConstructionEntity wrapper object.

AlConstructionEntity::~AlConstructionEntity()

Description

Deletes an AlConstructionEntity wrapper object.

AlObjectType AlConstructionEntity::type() const

Description

Returns the class identifier kConstructionEntityType.

const char *AlConstructionEntity::name() const

Description

Returns the name of the construction entity. NULL is returned if this method fails.

statusCode AlConstructionEntity::setName( const char *name )

Description

Sets the name of the construction entity

Arguments

< name - name that construction entity should be called

Return Codes

sSuccess - the name was set

sFailure - the method failed

sInvalidObject - the construction entity is invalid

sNameChangedToUniqueOne - the name was not unique so it was changed

AlLayer *AlConstructionEntity::layer()

Description

Returns the layer that this construction entity is in. NULL is returned if this method failed.

statusCode AlConstructionEntity::setLayer( AlLayer *layer )

Description

Sets the layer of the construction entity.

Arguments

< layer - the layer to put this construction entity into

Return Codes

sSuccess - the layer was set

sFailure - failed to set the layer

sInvalidObject - the construction entity is invalid

sInvalidArgument - layer is NULL or is invalid

boolean AlConstructionEntity::invisible()

Description

Returns TRUE if the layer is invisible. FALSE will be returned if the method failed.

statusCode AlConstructionEntity::setInvisible( boolean invisible )

Description

Sets the invisibility of the construction entity

Arguments

< invisible - either TRUE or FALSE

Return Codes

sSuccess - the visibility was set

sFailure - failed to set the visibility

sInvalidObject - the construction entity is invalid

statusCode AlConstructionEntity::templated(boolean &tmpl) const

Description

Finds whether the object on which a construction entity depends is templated. If a construction entity does not depend on any other object, the argument is set to false.

Arguments

> tmpl - is set to true if the object on which a locator depends is templated. Otherwise, tmpl is set to false.

Return Codes

sSuccess - The value was set successfully

sInvalidObject - the object is not valid