Show / Hide Table of Contents

    Class Sweep

    A sweep of a profile along a curve.

    Inheritance
    System.Object
    SolidOperation
    Sweep
    Implements
    System.ComponentModel.INotifyPropertyChanged
    Inherited Members
    SolidOperation.LocalTransform
    SolidOperation.Solid
    SolidOperation.IsVoid
    SolidOperation.PropertyChanged
    SolidOperation.RaisePropertyChanged(String)
    System.Object.Equals(System.Object)
    System.Object.Equals(System.Object, System.Object)
    System.Object.GetHashCode()
    System.Object.GetType()
    System.Object.MemberwiseClone()
    System.Object.ReferenceEquals(System.Object, System.Object)
    System.Object.ToString()
    Namespace: Elements.Geometry.Solids
    Assembly: Hypar.Elements.dll
    Syntax
    public class Sweep : SolidOperation, INotifyPropertyChanged

    Constructors

    Sweep(Profile, BoundedCurve, Double, Double, Double, Boolean)

    Construct a sweep.

    Declaration
    [JsonConstructor]
    public Sweep(Profile profile, BoundedCurve curve, double startSetback, double endSetback, double profileRotation, bool isVoid)
    Parameters
    Type Name Description
    Profile profile
    BoundedCurve curve
    System.Double startSetback
    System.Double endSetback
    System.Double profileRotation
    System.Boolean isVoid

    Properties

    Curve

    The curve along which the profile will be swept.

    Declaration
    [JsonProperty("Curve", Required = Required.AllowNull)]
    public BoundedCurve Curve { get; set; }
    Property Value
    Type Description
    BoundedCurve

    EndSetback

    The amount to set back the resulting solid from the end of the curve.

    Declaration
    [JsonProperty("EndSetback", Required = Required.Always)]
    public double EndSetback { get; set; }
    Property Value
    Type Description
    System.Double

    Profile

    The id of the profile to be swept along the curve.

    Declaration
    [JsonProperty("Profile", Required = Required.AllowNull)]
    public Profile Profile { get; set; }
    Property Value
    Type Description
    Profile

    ProfileRotation

    The rotation of the profile around the sweep's curve.

    Declaration
    [JsonProperty("ProfileRotation", Required = Required.DisallowNull, NullValueHandling = NullValueHandling.Ignore)]
    public double ProfileRotation { get; set; }
    Property Value
    Type Description
    System.Double

    StartSetback

    The amount to set back the resulting solid from the start of the curve.

    Declaration
    [JsonProperty("StartSetback", Required = Required.Always)]
    public double StartSetback { get; set; }
    Property Value
    Type Description
    System.Double

    Implements

    System.ComponentModel.INotifyPropertyChanged