Civilized Development

21WOJP–Week 21: Creating Stacked Profile Views

In Jay Peak, we have provided the ability to create stacked profile views through the API. We did this by providing new overloads to the already existing methods that created profile views. The ‘ProfileView’ class exposes several ‘Create()’ and, as we saw last week, ‘CreateMultiple()’ methods to create single and multiple profile views. We also provided overloads for these methods that take a ‘StackedProfileViewsCreationOptions’ object, which defines how stacked profiles can be created.

The following example uses some of the code from last week to create multiple stacked profiles:

C#

private void createStackedProfileViews()
{
  ProfileView.CreateMultiple(_alignmentId, _insertionPoint, 
      _stackedOptions, _creationOptions);
}

private StackedProfileViewsCreationOptions _stackedOptions
{
  get
  {
    StackedProfileViewsCreationOptions options =
      new StackedProfileViewsCreationOptions(_defaultPVId,
        _defaultPVId, _defaultPVId);
    return options;
  }
}

private ObjectId _defaultPVId
{
  get
  {
    return _civildoc.Styles.ProfileViewStyles[0];
  }
}

VB.NET

Private Sub createStackedProfileViews()
  ProfileView.CreateMultiple(_alignmentId, _insertionPoint,
    _stackedOptions, _creationOptions)
End Sub

Private ReadOnly Property _stackedOptions() _
    As StackedProfileViewsCreationOptions
  Get
    Dim options As New StackedProfileViewsCreationOptions(
      _defaultPVId, _defaultPVId, _defaultPVId)
    Return options
  End Get
End Property

Private ReadOnly Property _defaultPVId() As ObjectId
  Get
    Return _civildoc.Styles.ProfileViewStyles(0)
  End Get
End Property

And with this installment, we complete the Jay Peak series. It has been many weeks of Jay Peak goodness, which I hope you have enjoyed and that allows you to derive great benefit from our latest release. The series has covered the most important features and enhancements we added, but there are some other gems that we will be looking at in the future, so stay tuned for more Civil 3D API talk.

21WOJP–Week 20: Create Multiple Profile Views

Jay Peak provides some enhancements to the ‘ProfileView’ object. One of them is the ability to create multiple profile views at once. The code is very simple, since it is just one straight call to a static method of ‘ProfileView’. Yet, it is a very powerful call since it takes a ‘MultipleProfileViewsCreationOptions’ object that allows to customize the behavior of the profile views being created. The following code shows how to create multiple profile views.

C#

private void createProfileViews()
{
  ProfileView.CreateMultiple(_alignmentId, _insertionPoint,
    _creationOptions);
}

private MultipleProfileViewsCreationOptions _creationOptions
{
  get
  {
    MultipleProfileViewsCreationOptions options =
      new MultipleProfileViewsCreationOptions();
    options.DrawOrder = ProfileViewPlotType.ByRows;
    options.GapBetweenViewsInColumn = 1000;
    options.GapBetweenViewsInRow = 1000;
    options.MaxViewInRowOrColumn = 3;
    options.StartCorner = 
      ProfileViewStartCornerType.UpperLeft;
    return options;
  }
}

VB.NET

Private Sub createProfileViews()
  ProfileView.CreateMultiple(_alignmentId, _insertionPoint,
    _creationOptions)
End Sub



Private ReadOnly Property _creationOptions() _
    As MultipleProfileViewsCreationOptions
  Get
    Dim options As New MultipleProfileViewsCreationOptions()
    options.DrawOrder = ProfileViewPlotType.ByRows
    options.GapBetweenViewsInColumn = 1000
    options.GapBetweenViewsInRow = 1000
    options.MaxViewInRowOrColumn = 3
    options.StartCorner = ProfileViewStartCornerType.UpperLeft
    Return options
  End Get
End Property

We use an alignment id, an insertion point, and the ‘MultipleProfileViewsCreationOptions’ object to create the multiple views. The ‘MultipleProvileViewsCreationOption’ object allows you to customize the draw order of the profile views, and things like the gap between rows and columns, maximum views in each row or column (depending on the draw order option), and the start corner to which the insertion point refers. The ‘CreateMultiple’ method provides other overloads that allow you to customize further how the views are created.

You can download the entire implementation of the command from the Civilized Development repository at BitBucket.