Hide Table of Contents

Get Surface-finish Image Path and File Name Example (VB.NET)

This example shows how to set and get the path and file name of the image used for an appearance's surface finish.

'----------------------------------------------------------------
' Preconditions:
' 1. Verify that:
'    * specified model document exists.
'    * specified materials and surface-finish image exist.
'    * PhotoView 360 add-in is loaded.
' 2. Open the Immediate window.
'
' Postconditions:
' 1. Opens the specified model document.
' 2. Applies the specified appearance and surface finish to the model.
' 3. Gets the file names of the first appearance and surface finish
'    applied to the model.
' 4. If prompted to use perspective views in rendering, click
'    Continue without Camera or Perspective.
' 5. Renders the model.
' 6. Examine the Final Render and Immediate windows.
'
' NOTES:
' * Rendering can take several minutes to complete.
' * Because the model is used elsewhere, do not save changes.
'----------------------------------------------------------------
 
Imports SolidWorks.Interop.sldworks
Imports SolidWorks.Interop.swconst
Imports System.Runtime.InteropServices
Imports System
Imports System.Diagnostics
 
Partial Class SolidWorksMacro
 
    Public Sub main()
 
        Dim swModel As ModelDoc2
        Dim swModelDocExt As ModelDocExtension
        Dim swSelectionMgr As SelectionMgr
        Dim swComponent As Component2
        Dim swConfiguration As Configuration
        Dim swRenderMaterial As RenderMaterial
        Dim swRayTraceRenderer As RayTraceRenderer
        Dim nbrRenderMaterials As Integer
        Dim fileName As String
        Dim warnings As Integer
        Dim errors As Integer
        Dim status As Boolean
        Dim materialName As String
        Dim displayStateNames() As String
        Dim materialID1 As Integer
        Dim materialID2 As Integer
 
        'Open model document
        fileName = "C:\Users\Public\Documents\SOLIDWORKS\SOLIDWORKS 2018\samples\tutorial\tolanalyst\offset\bushing.sldprt"
        swModel = swApp.OpenDoc6(fileName, swDocumentTypes_e.swDocPART, swOpenDocOptions_e.swOpenDocOptions_Silent, "", errors, warnings)
 
        'Access PhotoView 360
        swRayTraceRenderer = swApp.GetRayTraceRenderer(swRayTraceRenderType_e.swPhotoView)
 
        'Create material for the appearance
        materialName = "C:\Program Files\SolidWorks Corp\SolidWorks\data\graphics\Materials\metal\bronze\cast bronze.p2m";
        swModelDocExt = swModel.Extension
        swRenderMaterial = swModelDocExt.CreateRenderMaterial(materialName)
 
        'Verify that RealView Graphics is set
        Debug.Print("RealView Graphics set? " & swModelDocExt.ViewDisplayRealView)
 
        'Add an appearance
        status = swModelDocExt.SelectByID2("bushing.SLDPRT""COMPONENT", 0, 0, 0, False, 0, Nothing, 0)
        swSelectionMgr = swModel.SelectionManager
        swComponent = swSelectionMgr.GetSelectedObject6(1, -1)
        status = swRenderMaterial.AddEntity(swComponent)
        Debug.Print("Appearance added to model? " & status)
 
        'Add surface finish
        fileName = "C:\Program Files\SolidWorks Corp\SolidWorks\data\Images\textures\metal\cast\cast_bump.jpg"
        swRenderMaterial.BumpTextureFilename = fileName
 
        swModel.ClearSelection2(True)
 
        'Get the names of display states
        'Add the appearance to all of the display states
        swConfiguration = swModel.GetActiveConfiguration
        displayStateNames = swConfiguration.GetDisplayStates
        status = swModelDocExt.AddDisplayStateSpecificRenderMaterial(swRenderMaterial, swDisplayStateOpts_e.swAllDisplayState, displayStateNames, materialID1, materialID2)
 
        'Get the number of appearances
        nbrRenderMaterials = swModelDocExt.GetRenderMaterialsCount2(swDisplayStateOpts_e.swAllDisplayState, displayStateNames)
 
        'If one or more appearances are applied to the model,
        'then get the file names of the first appearance and surface finish applied
        If nbrRenderMaterials > 0 Then
            Debug.Print("First appearance's file name: " & swRenderMaterial.FileName)
            Debug.Print("  Surface finish's file name: " & swRenderMaterial.BumpTextureFilename)
            Debug.Print("Fixed aspect ratio? " & swRenderMaterial.FixedAspectRatio)
            Debug.Print("  Width: " & swRenderMaterial.Width * 1000.0# & "mm")
            Debug.Print("  Height: " & swRenderMaterial.Height * 1000.0# & "mm")
            If Not swRenderMaterial.DoubleSided Then
                swRenderMaterial.DoubleSided = True
            End If
            Debug.Print("Double-sided? " & swRenderMaterial.DoubleSided)
            swRenderMaterial.RoundSharpEdges = 0.005
            Debug.Print("Round sharp edges value: " & swRenderMaterial.RoundSharpEdges * 1000.0# & "mm")
 
            'Display final render window
            status = swRayTraceRenderer.InvokeFinalRender
        Else
            Debug.Print("No appearances applied to this model.")
        End If
 
 
    End Sub
 
    ''' <summary>
    ''' The SldWorks swApp variable is pre-assigned for you.
    ''' </summary>
    Public swApp As SldWorks
 
 
End Class


Provide feedback on this topic

SOLIDWORKS welcomes your feedback concerning the presentation, accuracy, and thoroughness of the documentation. Use the form below to send your comments and suggestions about this topic directly to our documentation team. The documentation team cannot answer technical support questions. Click here for information about technical support.

* Required

 
*Email:  
Subject:   Feedback on Help Topics
Page:   Get Surface-finish Image Path and File Name Example (VB.NET)
*Comment:  
*   I acknowledge I have read and I hereby accept the privacy policy under which my Personal Data will be used by Dassault Systèmes

Print Topic

Select the scope of content to print:

x

We have detected you are using a browser version older than Internet Explorer 7. For optimized display, we suggest upgrading your browser to Internet Explorer 7 or newer.

 Never show this message again
x

Web Help Content Version: API Help (English only) 2022 SP05

To disable Web help from within SOLIDWORKS and use local help instead, click Help > Use SOLIDWORKS Web Help.

To report problems encountered with the Web help interface and search, contact your local support representative. To provide feedback on individual help topics, use the “Feedback on this topic” link on the individual topic page.