Get Rhino background color

[11165 (Deer)]

Hello everyone!
Nice to meet you here.

I am trying to get background color of specific rhino viewport using C#.
Here is what I already did:

1: Before I can get background color in “perspective” viewport, I have to get what display mode “perspective” is using. This is done with codes below:

A = Rhino.RhinoDoc.ActiveDoc.Views.Find(x, false).ActiveViewport.DisplayMode.DisplayAttributes.EnglishName;

2: After that I have to get backgroundstyle of “Shaded” displaymode.
I stuck here.
I searched rhinocommon online and tried a few ways. None of them asked for some input or parameter related to “shaded”. They are all somehow “global” settings.

Can anybody help me with this.
Thank you very much!

[Mahdiyar]

private void RunScript(string name, ref object Mode, ref object Colors)
{
  var displayMode = doc.Views.Find(name, false).ActiveViewport.DisplayMode;
  var fillMode = displayMode.DisplayAttributes.FillMode;
  Mode = fillMode;
  var colors = new Color[4];
  displayMode.DisplayAttributes.GetFill(out colors[0], out colors[1], out colors[2], out colors[3]);
  switch (fillMode)
  {
    case DisplayPipelineAttributes.FrameBufferFillMode.DefaultColor:
      Colors = Rhino.ApplicationSettings.AppearanceSettings.ViewportBackgroundColor;
      break;
    case DisplayPipelineAttributes.FrameBufferFillMode.SolidColor:
      Colors = colors[0];
      break;
    case DisplayPipelineAttributes.FrameBufferFillMode.Gradient2Color:
      Colors = new[] { colors[0], colors[1] };
      break;
    case DisplayPipelineAttributes.FrameBufferFillMode.Gradient4Color:
      Colors = colors;
      break;
    case DisplayPipelineAttributes.FrameBufferFillMode.Bitmap:
      break;
    case DisplayPipelineAttributes.FrameBufferFillMode.Renderer:
      switch (RhinoDocument.RenderSettings.BackgroundStyle)
      {
        case BackgroundStyle.SolidColor:
          Colors = RhinoDocument.RenderSettings.BackgroundColorTop;
          break;
        case BackgroundStyle.WallpaperImage:
          break;
        case BackgroundStyle.Gradient:
          Colors = new[]
            {
              RhinoDocument.RenderSettings.BackgroundColorTop,
              RhinoDocument.RenderSettings.BackgroundColorBottom
            };
          break;
        case BackgroundStyle.Environment:
          break;
        default:
          throw new ArgumentOutOfRangeException();
      }
      break;
    case DisplayPipelineAttributes.FrameBufferFillMode.Transparent:
      break;
    default:
      throw new ArgumentOutOfRangeException();
  }
}

Background.gh (4.3 KB)

[11165 (Deer)]

Wow!
This is super!
Thank you very much!

[11165 (Deer)]

@Mahdiyar

GetFill

Hello Mahdiyar.
Your code is really helpful.
I am sorry to bother but still I have a question about overall C# development.
I found the “GetFill” in rhinocommon as link below:
Rhinocommon GetFill page
My question is how does one find the correct structure of Rhinocommon. I found the document quite unclear in structure, and with new Rhino 7 API changed a lot, online Rhinocommon is missing information in many pages.
Even in Rhino 6, Rhinocommon’s quality is a little poor for a standard developer document.
The link below is FFMpeg online document page:
FFMpeg online document
Comparing to the FFMpeg document, Rhinocommon is missing so many examples and basic workflow of the whole structure, difficult for developpers to find the command they need. In this case I found it difficult to find the correct keyword “GetFill” on my own.

I am not to criticize Rhinocommon because it is basically decent document, where I can find most keywords if I am already familiar with the structure.
But still I think something is missing in my own workflow, or there is some special technich to deal with Rhinocommon.

Thank you very much Mahdiyar.

[AndersDeleuran]

Apologies for reviving the topic, but I can’t seem to get the code to return correct background colors while in GradientView. As far as I can tell the DisplayAttributes.GetFill method always return the same four colors (159,159,159 in my case) and the fillMode does not register either Gradient2Color or Gradient4Color. This is the case for both the latest Rhino 7 and Rhino 8 updates. Anyone have some nuggets of wisdom to share?

backgroundColors_GradientView.gh (8.5 KB)

[Mahdiyar]

Hi Anders, I just tested the behavior you described in Rhino 8.16.24363, and everything seems to work as expected on my end. Here’s a quick screen recording of my test:

[AndersDeleuran]

Cheers @Mahdiyar, that’s much appreciated. I was referring specifically to setting the background gradient using the GradientView command. I’ve been using that for a long time and think it might have been deprecated without me noticing (i.e. superseded by setting the gradient like you demonstrate in the video):

Edit: I just realised it sounds like I am still looking for a solution, but I’ll just stop using GradientView. Also. here’s a Python function that seems to work quite well for getting the upper left color (not taking bitmap backgrounds into account):

250108_GetRhinoBackgroundTopColor_01.gh (5.2 KB)