Hide Table of Contents
IPwOptions Interface Members

The following tables list the members exposed by IPwOptions.

Public Properties

 NameDescription
PropertyAntiAliasingQualityGets or sets the level of anti-aliasing quality.  
PropertyAntiAliasingQualityCustomGets or sets the level of customized anti-aliasing quality.  
PropertyAutoLoadSelectedFolderGets or sets whether to display the active custom folder in the Material Editor's tree.  
PropertyBrightnessGets or sets the brightness (radiance) of an image.  
PropertyCausticAccuracyGets or sets the maximum number of photons used for calculating caustics.  
PropertyCausticAllCastAndReceiveGets or sets whether to force all materials to cast and receive caustics.  
PropertyCausticRadiusGets or sets the custom caustic radius.  
PropertyCausticRadiusDefaultGets the default caustic radius.  
PropertyCausticsAccuracyMaximumGets the maximum value for caustic accuracy.  
PropertyCausticsAccuracyMinimumGets the minimum value for caustic accuracy.  
PropertyCausticsRadiusMaximumgets the maximum caustic radius.  
PropertyCausticsRadiusMinimumGets the minimum caustic radius.  
PropertyClearImageBeforeRenderingGets or sets whether to clear the SolidWorks graphics area before each new rendering.  
PropertyContourBackgroundColorGets or sets the color of the background when rendering contours.  
PropertyContourDepthFadeGets or sets the value by which to reduce the size of the contour lines as the model's depth changes away from the viewer.  
PropertyContourDepthFadeMaximumGets the maximum size of the contour lines as the model depth changes away from the viewer.  
PropertyContourDepthFadeMinimumGets the minimum contour lines as the model depth changes away from the viewer.  
PropertyContourLineColorGets or sets the color of the contour lines.  
PropertyContourLineThicknessGets or sets the thickness of the contour lines.  
PropertyContourLineThicknessMaximumGets the maximum value for the thickness of the contour lines.  
PropertyContourLineThicknessMinimumGets the minimum value for the thickness of the contour lines.  
PropertyContourRenderingMode

Gets or sets the mode for contour rendering, which allows you to render:

  • only the contours,
  • only the model, or
  • both the contours and the model.
 
PropertyContrastGets or sets the contrast (level of difference between light and dark areas) in an image.  
PropertyDisplayPreviewWindowGets or sets whether or not to show a preview window.  
PropertyDisplayProgressAbortDialogGets or sets whether or not to show a progress dialog during the rendering process.  
PropertyEnableCausticGets or sets whether or not to enable caustics.  
PropertyEnableContourFadesWithDepthGets or sets whether or not to reduce the size of the contour lines as the model's depth changes away from the viewer.  
PropertyEnableDynamicHelpGets or sets whether or not to enable dynamic help as a tab in the SolidWorks FeatureManager design tree.  
PropertyEnableGlobalIlluminationGets or sets whether to allow global illumination effects on the model.  
PropertyEnableIndirectIlluminationGets or sets whether to enable indirect illumination.  
PropertyEnableMemorySettingsGets or sets whether to enable memory settings.  
PropertyEnableRayTraceDepthSettingsGets or sets whether or not to enable ray tracing depth.  
PropertyGammaCorrectionGets or sets the value for gamma correction, the process to correct the output to compensate for the output device.  
PropertyGammaCorrectionMaximumGets the maximum value for gamma correction.  
PropertyGammaCorrectionMinimumGets the minimum value for gamma correction.  
PropertyGlobalIlluminationAccuracyGets or sets the global illumination accuracy.  
PropertyGlobalIlluminationAccuracyMaximumGets the maximum value for global illumination accuracy.  
PropertyGlobalIlluminationAccuracyMinimumGets the minimum value for global illumination accuracy.  
PropertyGlobalIlluminationAllCastAndReceiveGets or sets whether or not all materials cast and receive global illumination by default.  
PropertyGlobalIlluminationRadiusGets or sets the custom radius for global illumination.  
PropertyGlobalIlluminationRadiusDefaultGets the default value of the global illumination radius.  
PropertyGlobalIlluminationRadiusMaximumGets the maximum value of global illumination radius.  
PropertyGlobalIlluminationRadiusMinimumGets the minimum value of global illumination radius.  
PropertyHideDecalsInSolidWorksGets or sets whether to hide decals in SolidWorks.  
PropertyIndirectIlluminationAccuracyGets or sets the indirect illumination accuracy.  
PropertyIndirectIlluminationAccuracyMaximumGets the maximum value for indirect illumination accuracy.  
PropertyIndirectIlluminationAccuracyMinimumGets the minimum value for indirect illumination accuracy.  
PropertyIndirectIlluminationAveragingGets or sets the indirect illumination averaging, which controls the size of the area over which different sections in a rendering are blurred together.  
PropertyIndirectIlluminationBouncesGets or sets the indirection illumination bounces, which determines how many times light is transferred from one surface to another.  
PropertyIndirectIlluminationDetailsGets or sets the indirect illumination details, which controls the density of light gathering points and determines how clearly you see rapid changes between light and dark values.  
PropertyIndirectIlluminationPrecisionGets or sets the distance between successive calculations at light gathering points.  
PropertyIndirectIlluminationQualityGets or sets the quality of indirect illumination.  
PropertyIndirectIlluminationRadiusGets or sets the value for the custom indirect illumination radius.  
PropertyIndirectIlluminationRadiusDefaultGets the value for the indirect illumination default radius.  
PropertyIndirectIlluminationRadiusMaximumGets the maximum value for the indirect illumination radius.  
PropertyIndirectIlluminationRadiusMinimumGets the minimum value for the indirect illumination radius.  
PropertyMemoryLimitGets or sets the amount of memory for the rendering process.  
PropertyMemoryLimitMaximumGets the maximum amount of memory for the rendering processing.  
PropertyMemoryLimitMinimumGets the minimum amount of memory for the rendering processing.  
PropertyOverwriteSolidWorksPropertiesGets or sets whether to overwrite the material properties of the SolidWorks model with the properties of the PhotoWorks material.  
PropertyRayTraceDepthGets or sets the number of times PhotoWorks can subdivide a scene into simple objects for ray trace calculations.  
PropertyRayTraceDepthMaximumGets the maximum number of times PhotoWorks can subdivide a scene into simple objects for ray trace calculations.  
PropertyRayTraceDepthMinimumGets the minimum number of times PhotoWorks can subdivide a scene into simple objects for ray trace calculations.  
PropertyRayTraceNumberReflectionsGets or sets the number of ray tracing reflections.  
PropertyRayTraceNumberRefractionsGets or sets the number of refraction and transparency rays.  
PropertySaturationGets or sets the color saturation, which controls the level of color intensity, of an image.  
PropertySaveImageWithDocumentGets or sets whether the PhotoWorks data is stored in the SolidWorks model document.  
PropertySearchSubFoldersGets or sets whether to search sub-folders when a material, scene, or decal file is not found.  
PropertySuppressStandardMaterialsGets or sets whether or not to hide the default folders in the Material Editor tree so that only custom folders appear.  
PropertyUseCausticDefaultRadiusGets or sets whether to use the default caustic radius.  
PropertyUseGlobalIlluminationDefaultRadiusGets or sets whether to use the default global illumination radius.  
PropertyUseIndirectIlluminationDefaultRadiusGets or sets whether or not to use the default indirect illumination radius.  
PropertyUseSolidWorksMaterialsGets or sets whether to use SolidWorks materials when you render the model.  
PropertyUseSolidWorksPhysicalPropertiesGets or sets whether to use SolidWorks physical materials when you render the model.  
Top

Public Methods

 NameDescription
MethodAddCustomFolderCreates a custom folder for materials.  
MethodAddSearchPathAdds a file location (disk and folders) to the search path. This file location is searched when PhotoWorks cannot find a material, scene, or decal file.  
MethodClearCustomFolderListClears the list of custom folders.  
MethodClearSearchPathListClears the list of paths to search for missing material, scene, or decal files.  
MethodGetActiveCustomFolderGets the name of the active custom folder.  
MethodGetCustomFolderListGets a list of the names of the custom folders.  
MethodGetCustomFolderListCountGets the number of custom folders.  
MethodGetDocumentSaveImages  
MethodGetSearchPathListGets a list of the paths to search for missing material, scene, or decal files.  
MethodGetSearchPathListCountGets the number of paths to search for missing material, scene, or decal files.  
MethodIGetCustomFolderListGets a list of the names of the custom folders.  
MethodIGetSearchPathListGets a list of the paths to search for missing material, scene, or decal files.  
MethodSetActiveCustomFolderSets the active custom folder in which PhotoWorks first searches for material files (.p2m).  
Top

See Also



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:   IPwOptions Interface Members
*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) 2010 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.

0.20.53