/// <summary>
/// Gets the result of between the two elements can cut.
/// </summary>
/// <param name="elm1"></param>
/// <param name="elm2"></param>
/// <param name="reason"></param>
/// <returns></returns>
public static bool CutElement(this Element elm1, Element elm2, CutFailureReason reason)
{
if (!Enum.IsDefined(typeof(CutFailureReason), reason))
{
throw new InvalidEnumArgumentException(nameof(reason), (int)reason, typeof(CutFailureReason));
}
return(SolidSolidCutUtils.CanElementCutElement(elm1, elm2, out _));
}
/// <summary>
/// Implement this method as an external command for Revit.
/// </summary>
/// <param name="commandData">An object that is passed to the external application
/// which contains data related to the command,
/// such as the application object and active view.</param>
/// <param name="message">A message that can be set by the external application
/// which will be displayed if a failure or cancellation is returned by
/// the external command.</param>
/// <param name="elements">A set of elements to which the external application
/// can add elements that are to be highlighted in case of failure or cancellation.</param>
/// <returns>Return the status of the external command.
/// A result of Succeeded means that the API external method functioned as expected.
/// Cancelled can be used to signify that the user cancelled the external operation
/// at some point. Failure should be returned if the application is unable to proceed with
/// the operation.</returns>
public Autodesk.Revit.UI.Result Execute(ExternalCommandData commandData,
ref string message, Autodesk.Revit.DB.ElementSet elements)
{
// NOTES: Anything can be done in this method, such as the solid-solid cut operation.
// Get the application and document from external command data.
Application app = commandData.Application.Application;
Document activeDoc = commandData.Application.ActiveUIDocument.Document;
#region Demo how to use the SolidSolidCut API to make one solid cut another.
int solidToBeCutElementId = 30481; //The cube
int cuttingSolidElementId = 30809; //The sphere
//Get element by ElementId
Element solidToBeCut = activeDoc.GetElement(new ElementId(solidToBeCutElementId));
Element cuttingSolid = activeDoc.GetElement(new ElementId(cuttingSolidElementId));
//If the two elements do not exist, notify user to open the family file then try this command.
if (solidToBeCut == null || cuttingSolid == null)
{
TaskDialog.Show("Notice", "Please open the family file SolidSolidCut.rfa, then try to run this command.");
return(Autodesk.Revit.UI.Result.Succeeded);
}
//Check whether the cuttingSolid can cut the solidToBeCut
CutFailureReason cutFailureReason = new CutFailureReason();
if (SolidSolidCutUtils.CanElementCutElement(cuttingSolid, solidToBeCut, out cutFailureReason))
{
//cuttingSolid can cut solidToBeCut
//Do the solid-solid cut operation
//Start a transaction
Transaction transaction = new Transaction(activeDoc);
transaction.Start("AddCutBetweenSolids(activeDoc, solidToBeCut, cuttingSolid)");
//Let the cuttingSolid cut the solidToBeCut
SolidSolidCutUtils.AddCutBetweenSolids(activeDoc, solidToBeCut, cuttingSolid);
transaction.Commit();
}
#endregion
return(Autodesk.Revit.UI.Result.Succeeded);
}
/// <summary>
/// Implement this method as an external command for Revit.
/// </summary>
/// <param name="commandData">An object that is passed to the external application
/// which contains data related to the command,
/// such as the application object and active view.</param>
/// <param name="message">A message that can be set by the external application
/// which will be displayed if a failure or cancellation is returned by
/// the external command.</param>
/// <param name="elements">A set of elements to which the external application
/// can add elements that are to be highlighted in case of failure or cancellation.</param>
/// <returns>Return the status of the external command.
/// A result of Succeeded means that the API external method functioned as expected.
/// Cancelled can be used to signify that the user cancelled the external operation
/// at some point. Failure should be returned if the application is unable to proceed with
/// the operation.</returns>
public Autodesk.Revit.UI.Result Execute(ExternalCommandData commandData,
ref string message, Autodesk.Revit.DB.ElementSet elements)
{
// NOTES: Anything can be done in this method, such as the solid-solid uncut operation.
// Get the application and document from external command data.
Application app = commandData.Application.Application;
Document activeDoc = commandData.Application.ActiveUIDocument.Document;
#region Demo how to use the SolidSolidCut API to uncut two solids which have the cutting relationship.
int solidToBeCutElementId = 30481; //The cube
int cuttingSolidElementId = 30809; //The sphere
//Get element by ElementId
Element solidToBeCut = activeDoc.get_Element(new ElementId(solidToBeCutElementId));
Element cuttingSolid = activeDoc.get_Element(new ElementId(cuttingSolidElementId));
//If the two elements do not exist, notify user to open the family file then try this command.
if (solidToBeCut == null || cuttingSolid == null)
{
TaskDialog.Show("Notice", "Please open the family file SolidSolidCut.rfa, then try to run this command.");
return(Autodesk.Revit.UI.Result.Succeeded);
}
//Remove the solid-solid cut (Uncut)
//Start a transaction
Transaction transaction = new Transaction(activeDoc);
transaction.Start("RemoveCutBetweenSolids(activeDoc, solidToBeCut, cuttingSolid)");
//Remove the cutting relationship between solidToBeCut and cuttingSolid (Uncut)
SolidSolidCutUtils.RemoveCutBetweenSolids(activeDoc, solidToBeCut, cuttingSolid);
transaction.Commit();
#endregion
return(Autodesk.Revit.UI.Result.Succeeded);
}
