Class ActionFeedBack
A container for Feedback objects. These are objects that give visual feedback to the user while a Action is in progress. Currently you can add IGeoObjects or FeedBackPlanes that provide the feedback.
Inheritance
Inherited Members
Namespace: CADability.Actions
Assembly: CADability.dll
Syntax
public class ActionFeedBack
Methods
| Improve this Doc View SourceAdd(IFeedBack)
Adds an IFeedBack to the list of feedback objects. The object shows in the appropriate view and the view reflects all changes of the object. Currently there are the GeoObjects and the FeedBackPlane object which support the IFeedBack interface. You could also implement your own IFeedBack objects.
Declaration
public int Add(IFeedBack feedBackObject)
Parameters
| Type | Name | Description |
|---|---|---|
| IFeedBack | feedBackObject | the object to show |
Returns
| Type | Description |
|---|---|
| System.Int32 | the index in the list, may be used for Remove(Int32) |
AddSelected(IGeoObject)
Adds a GeoObject to the list of displayed objects. In contrary to Add(IFeedBack) the object is displayed in the select color and the select display mode.
Declaration
public int AddSelected(IGeoObject feedBackObject)
Parameters
| Type | Name | Description |
|---|---|---|
| IGeoObject | feedBackObject | Object to add |
Returns
| Type | Description |
|---|---|
| System.Int32 | the index in the list, may be used for RemoveSelected(Int32) |
AddTransparent(IGeoObject)
Declaration
public void AddTransparent(IGeoObject feedBackObject)
Parameters
| Type | Name | Description |
|---|---|---|
| IGeoObject | feedBackObject |
ClearAll()
Removes all feedback objects.
Declaration
public void ClearAll()
ClearSelected()
Removes all objects from the list of "display as selected" objects
Declaration
public void ClearSelected()
ClearTransparent()
Declaration
public void ClearTransparent()
FeedbackPoint(IFrame)
Creates a point which can be used as a feedback object. The point uses the feedback color as specified in the project settings.
Declaration
public static Point FeedbackPoint(IFrame frame)
Parameters
| Type | Name | Description |
|---|---|---|
| IFrame | frame | Frame to gat access to the settings |
Returns
| Type | Description |
|---|---|
| Point | A Point as a feedback object |
FeedbackPoint(IFrame, PointSymbol)
Declaration
public static Point FeedbackPoint(IFrame frame, PointSymbol pointSymbol)
Parameters
| Type | Name | Description |
|---|---|---|
| IFrame | frame | Frame to gat access to the settings |
| PointSymbol | pointSymbol | The icon, in which the point is beiing displayed |
Returns
| Type | Description |
|---|---|
| Point | A Point as a feedback object |
MakeModelTransparent(Boolean)
Declaration
public void MakeModelTransparent(bool transparent)
Parameters
| Type | Name | Description |
|---|---|---|
| System.Boolean | transparent |
Remove(IFeedBack)
Removes an previously added IFeedBack from the list of feedback objects. The object is no longer displayed.
Declaration
public void Remove(IFeedBack feedBackObject)
Parameters
| Type | Name | Description |
|---|---|---|
| IFeedBack | feedBackObject | Object to remove |
Remove(Int32)
Removes an IFeedBack object by its index from the list of the displayed objects.
Declaration
public void Remove(int index)
Parameters
| Type | Name | Description |
|---|---|---|
| System.Int32 | index | Index of the object to remove |
RemoveSelected(IGeoObject)
Removes the provided and previously added object from the list of "display as selected" objects
Declaration
public void RemoveSelected(IGeoObject feedBackObject)
Parameters
| Type | Name | Description |
|---|---|---|
| IGeoObject | feedBackObject | Object to remove |
RemoveSelected(Int32)
Removes the object (identified by its index) from the list of "display as selected" objects
Declaration
public void RemoveSelected(int index)
Parameters
| Type | Name | Description |
|---|---|---|
| System.Int32 | index | index of the object to remove |
RemoveTransparent(IGeoObject)
Declaration
public void RemoveTransparent(IGeoObject feedBackObject)
Parameters
| Type | Name | Description |
|---|---|---|
| IGeoObject | feedBackObject |