Class: TToolCommandBinding

Declaration: CursorTools.h

Taxonomy Categories:

Member Functions:

Interface Category:

API.

Inherits From:

TCommandBinding

Inherited By:

TToolCommandBindingTo

Purpose:

TToolCommandBinding polymorphically binds a command to a target. TToolCommandBinding allows tool interactors to pass commands to target without having to know the type of the command or the target.

Instantiation:

Allocate on the heap or the stack.

Deriving Classes:

Do not derive any classes from TToolCommandBinding.

Concurrency:

Not multithread safe.

Resource Use:

No special requirements.

Other Considerations:

None.

Member Function: TToolCommandBinding::TToolCommandBinding

TToolCommandBinding ()
TToolCommandBinding (const TToolCommandBinding &)

Interface Category:

API.

Purpose:

Default constructor.
Copy constructor.

Calling Context:

Called to create a TToolCommandBinding suitable for streaming into.
Called to copy an object.

Parameters:

Takes no parameters.
const TToolCommandBinding & -The object to be copied.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TToolCommandBinding::~TToolCommandBinding

virtual ~ TToolCommandBinding ()

Interface Category:

API.

Purpose:

Destructor.

Calling Context:

Called to destroy an object.

Parameters:

Takes no parameters.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TToolCommandBinding::operator=

TToolCommandBinding & operator =(const TToolCommandBinding &)

Interface Category:

API.

Purpose:

Assignment operator.

Calling Context:

Called when an object is assigned to another compatible object.

Parameters:

const TToolCommandBinding & -The object to be copied.

Return Value:

A non-const reference to the left-hand side object.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TToolCommandBinding::operator>>=

virtual TStream & operator >>=(TStream &) const

Interface Category:

API.

Purpose:

Stream-out operator.

Calling Context:

Called to stream out data.

Parameters:

TStream & -The destination stream.

Return Value:

Returns a reference to the stream to which the object streams itself.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TToolCommandBinding::operator<<=

virtual TStream & operator <<= (TStream &)

Interface Category:

API.

Purpose:

Stream-in operator.

Calling Context:

Called to stream in data.

Parameters:

TStream & -The source stream.

Return Value:

Returns a reference to the stream from which the object streams itself.

Exceptions:

Throws TGlobalExceptionKludge(kStreamBadVersion) if the version if the object streamed in is not the original version.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TToolCommandBinding::AdoptToolTarget

void AdoptToolTarget (MToolTarget *)

Interface Category:

API.

Purpose:

Adopts the specified tool target.

Calling Context:

Called to adopt a tool target.

Parameters:

MToolTarget * -The target to adopt.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TToolCommandBinding::GetToolTarget

MToolTarget * GetToolTarget ()
const MToolTarget * GetToolTarget () const

Interface Category:

API.

Purpose:

Returns a reference to the current tool target.

Calling Context:

Called to obtain a reference to the current tool target.
Called to obtain a const reference to the current tool target.

Parameters:

Takes no parameters.
Takes no parameters.

Return Value:

Returns a reference to the current tool target.
Returns a const reference to the current tool target.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Click the icon to mail questions or corrections about this material to Taligent personnel.