Loading...
Searching...
No Matches
SBDDocumentRenderPreset Class Reference

This class describes a render preset. More...

Anti-aliasing

enum class  AntiAliasingPreset {
  BestSpeed ,
  BetterSpeed ,
  HigherQuality ,
  HighestQuality ,
  Custom
}
 
AntiAliasingPreset getAntiAliasingPreset () const
 Returns the anti-aliasing preset.
 
void setAntiAliasingPreset (AntiAliasingPreset preset)
 Sets the anti-aliasing preset to preset.
 
int getAntiAliasingPresetIndex () const
 Returns the anti-aliasing preset index.
 
void setAntiAliasingPresetIndex (int i)
 Sets the anti-aliasing preset to i.
 
int getAntiAliasingPresetCount () const
 Returns the number of anti-aliasing presets.
 
std::string getAntiAliasingPresetItemText (int i) const
 Returns the name of the i-th anti-aliasing preset.
 
std::string getAntiAliasingPresetToolTip () const
 
int getAntiAliasingMultisamplingFactor () const
 Returns the multisampling factor value.
 
void setAntiAliasingMultisamplingFactor (int i)
 Sets the multisampling factor value to i.
 
int getMinimumAntiAliasingMultisamplingFactor () const
 Returns the minimum value of the anti-aliasing multisampling factor.
 
int getMaximumAntiAliasingMultisamplingFactor () const
 Returns the maximum value of the anti-aliasing multisampling factor.
 
int getDefaultAntiAliasingMultisamplingFactor () const
 Returns the default value of the anti-aliasing multisampling factor.
 
int getAntiAliasingMultisamplingFactorSingleStep () const
 
std::string getAntiAliasingMultisamplingFactorToolTip () const
 
bool getFXAAFlag () const
 Returns the FXAA flag.
 
void setFXAAFlag (bool b)
 Sets the FXAA flag to b.
 
std::string getFXAAFlagToolTip () const
 
static std::string getAntiAliasingPresetString (AntiAliasingPreset preset)
 Returns a human-readable string representation of the anti-aliasing preset preset.
 

Background

enum class  BackgroundType {
  Default ,
  White ,
  Black ,
  Custom ,
  Image
}
 
enum class  BackgroundImageMode {
  ContainedInViewport ,
  CoveringViewport
}
 
BackgroundType getBackgroundType () const
 Returns the background type.
 
void setBackgroundType (BackgroundType type)
 Sets the background type to type.
 
bool isCustomBackground () const
 A convenience function that return true if the custom gradient background is chosen.
 
bool isImageBackground () const
 A convenience function that return true if the image background is chosen.
 
int getBackgroundTypeIndex () const
 Returns the background type index.
 
void setBackgroundTypeIndex (int i)
 Sets the background type to i.
 
int getDefaultBackgroundTypeIndex () const
 Returns the default background type.
 
int getBackgroundTypeCount () const
 Returns the number of background types.
 
std::string getBackgroundTypeItemText (int i) const
 Returns the name of the i-th background type.
 
std::string getBackgroundTypeToolTip () const
 
const SBColorgetBackgroundTopColor () const
 Returns the background top color.
 
void setBackgroundTopColor (const SBColor &color)
 Sets the background top color to color.
 
const SBColorgetDefaultBackgroundTopColor () const
 Returns the default background top color.
 
const SBColorgetBackgroundBottomColor () const
 Returns the background bottom color.
 
void setBackgroundBottomColor (const SBColor &color)
 Sets the background bottom color to color.
 
const SBColorgetDefaultBackgroundBottomColor () const
 Returns the default background bottom color.
 
BackgroundImageMode getBackgroundImageMode () const
 Returns the background image mode.
 
void setBackgroundImageMode (BackgroundImageMode mode)
 Sets the background image mode to mode.
 
int getBackgroundImageModeIndex () const
 Returns the background image mode index.
 
void setBackgroundImageModeIndex (int i)
 Sets the background image mode to i.
 
int getDefaultBackgroundImageModeIndex () const
 Returns the default background image mode.
 
int getBackgroundImageModeCount () const
 Returns the number of background image modes.
 
std::string getBackgroundImageModeItemText (int i) const
 Returns the name of the i-th background image mode.
 
const std::string & getBackgroundImageBase64 () const
 Returns the background image in base64.
 
void setBackgroundImageBase64 (const std::string &imageBase64)
 Sets the background image in base64 to imageBase64.
 
bool hasBackgroundImageBase64 () const
 Returns whether the background image in base64 has been set.
 
void clearBackgroundImageBase64 ()
 Clear the background image.
 
static std::string getBackgroundTypeString (BackgroundType type)
 Returns a human-readable string representation of the background type type.
 
static std::string getBackgroundImageModeString (BackgroundImageMode mode)
 Returns a human-readable string representation of the background image mode mode.
 

Lighting

enum class  LightingPreset {
  Default ,
  FlatLight ,
  Custom
}
 
LightingPreset getLightingPreset () const
 Returns the lighting preset.
 
void setLightingPreset (LightingPreset preset)
 Sets the lighting preset to preset.
 
int getLightingPresetIndex () const
 Returns the lighting preset index.
 
void setLightingPresetIndex (int i)
 Sets the lighting preset to i.
 
int getDefaultLightingPresetIndex () const
 Returns the default lighting presets.
 
int getLightingPresetCount () const
 Returns the number of lighting presets.
 
std::string getLightingPresetItemText (int i) const
 Returns the name of the i-th lighting preset.
 
std::string getLightingPresetToolTip () const
 
const SBColorgetFirstLightColor () const
 Returns the first light's color.
 
void setFirstLightColor (const SBColor &color)
 Sets the first light's color to color.
 
const SBColorgetDefaultFirstLightColor () const
 Returns the first light's default color.
 
std::string getFirstLightColorToolTip () const
 
float getFirstLightIntensity () const
 Returns the first light's intensity.
 
void setFirstLightIntensity (float v)
 Sets the first light's intensity value to v.
 
float getMinimumFirstLightIntensity () const
 Returns the first light's minimum intensity.
 
float getMaximumFirstLightIntensity () const
 Returns the first light's maximum intensity.
 
float getDefaultFirstLightIntensity () const
 Returns the first light's default intensity.
 
float getFirstLightIntensitySingleStep () const
 
float getFirstLightSpecularIntensity () const
 Returns the first light's specular intensity.
 
void setFirstLightSpecularIntensity (float v)
 Sets the first light's specular intensity value to v.
 
float getMinimumFirstLightSpecularIntensity () const
 Returns the first light's minimum specular intensity.
 
float getMaximumFirstLightSpecularIntensity () const
 Returns the first light's maximum specular intensity.
 
float getDefaultFirstLightSpecularIntensity () const
 Returns the first light's default specular intensity.
 
float getFirstLightSpecularIntensitySingleStep () const
 
std::string getFirstLightSpecularIntensityToolTip () const
 
float getFirstLightSpecularPower () const
 Returns the first light's specular power.
 
void setFirstLightSpecularPower (float v)
 Sets the first light's specular power value to v.
 
float getMinimumFirstLightSpecularPower () const
 Returns the first light's minimum specular power.
 
float getMaximumFirstLightSpecularPower () const
 Returns the first light's maximum specular power.
 
float getDefaultFirstLightSpecularPower () const
 Returns the first light's default specular power.
 
float getFirstLightSpecularPowerSingleStep () const
 
std::string getFirstLightSpecularPowerToolTip () const
 
void setFirstLightLongitude (int v)
 Sets the first light's longitude.
 
int getFirstLightLongitude () const
 Returns the first light's longitude.
 
int getDefaultFirstLightLongitude () const
 Returns the light's default value of longitude.
 
void setFirstLightLatitude (int v)
 Sets the first light's latitude.
 
int getFirstLightLatitude () const
 Returns the first light's latitude.
 
int getDefaultFirstLightLatitude () const
 Returns the first light's default value of latitude.
 
int getMinimumLightCoordinate () const
 Returns the light's minimum value of longitude/latitude.
 
int getMaximumLightCoordinate () const
 Returns the light's maximum value of longitude/latitude.
 
int getLightCoordinateSingleStep () const
 
std::string getLightCoordinateToolTip () const
 
const SBColorgetSecondLightColor () const
 Returns the second light's color.
 
void setSecondLightColor (const SBColor &color)
 Sets the second light's color to color.
 
const SBColorgetDefaultSecondLightColor () const
 Returns the second light's default color.
 
std::string getSecondLightColorToolTip () const
 
float getSecondLightIntensity () const
 Returns the second light's intensity.
 
void setSecondLightIntensity (float v)
 Sets the second light's intensity value to v.
 
float getMinimumSecondLightIntensity () const
 Returns the second light's minimum intensity.
 
float getMaximumSecondLightIntensity () const
 Returns the second light's maximum intensity.
 
float getDefaultSecondLightIntensity () const
 Returns the second light's default intensity.
 
float getSecondLightIntensitySingleStep () const
 
float getSecondLightSpecularIntensity () const
 Returns the second light's specular intensity.
 
void setSecondLightSpecularIntensity (float v)
 Sets the second light's specular intensity value to v.
 
float getMinimumSecondLightSpecularIntensity () const
 Returns the second light's minimum specular intensity.
 
float getMaximumSecondLightSpecularIntensity () const
 Returns the second light's maximum specular intensity.
 
float getDefaultSecondLightSpecularIntensity () const
 Returns the second light's default specular intensity.
 
float getSecondLightSpecularIntensitySingleStep () const
 
std::string getSecondLightSpecularIntensityToolTip () const
 
float getSecondLightSpecularPower () const
 Returns the second light's specular power.
 
void setSecondLightSpecularPower (float v)
 Sets the second light's specular power value to v.
 
float getMinimumSecondLightSpecularPower () const
 Returns the second light's minimum specular power.
 
float getMaximumSecondLightSpecularPower () const
 Returns the second light's maximum specular power.
 
float getDefaultSecondLightSpecularPower () const
 Returns the second light's default specular power.
 
float getSecondLightSpecularPowerSingleStep () const
 
std::string getSecondLightSpecularPowerToolTip () const
 
void setSecondLightLongitude (int v)
 Sets the second light's longitude.
 
int getSecondLightLongitude () const
 Returns the second light's longitude.
 
int getDefaultSecondLightLongitude () const
 Returns the second light's default value of longitude.
 
void setSecondLightLatitude (int v)
 Sets the second light's latitude.
 
int getSecondLightLatitude () const
 Returns the second light's latitude.
 
int getDefaultSecondLightLatitude () const
 Returns the second light's default value of latitude.
 
float getFresnelIntensity () const
 Returns the global light's fresnel intensity.
 
void setFresnelIntensity (float v)
 Sets the global light's fresnel intensity value to v.
 
float getMinimumFresnelIntensity () const
 Returns the global light's minimum fresnel intensity.
 
float getMaximumFresnelIntensity () const
 Returns the global light's maximum fresnel intensity.
 
float getDefaultFresnelIntensity () const
 Returns the global light's default fresnel intensity.
 
float getFresnelIntensitySingleStep () const
 
std::string getFresnelIntensityToolTip () const
 
float getFresnelPower () const
 Returns the global light's fresnel power.
 
void setFresnelPower (float v)
 Sets the global light's fresnel power value to v.
 
float getMinimumFresnelPower () const
 Returns the global light's minimum fresnel power.
 
float getMaximumFresnelPower () const
 Returns the global light's maximum fresnel power.
 
float getDefaultFresnelPower () const
 Returns the global light's default fresnel power.
 
float getFresnelPowerSingleStep () const
 
std::string getFresnelPowerToolTip () const
 
float getAmbientLight () const
 Returns the global light's ambient light amount.
 
void setAmbientLight (float v)
 Sets the global light's ambient light amount to v.
 
float getMinimumAmbientLight () const
 Returns the global light's minimum ambient light amount.
 
float getMaximumAmbientLight () const
 Returns the global light's maximum ambient light amount.
 
float getDefaultAmbientLight () const
 Returns the global light's default ambient light amount.
 
float getAmbientLightSingleStep () const
 
std::string getAmbientLightToolTip () const
 
static std::string getLightingPresetString (LightingPreset preset)
 Returns a human-readable string representation of the lighting preset preset.
 

Shadow

enum class  ShadowPreset {
  LowQuality ,
  MediumQuality ,
  HighQuality ,
  SoftShadow ,
  Custom
}
 
bool getShadowFlag () const
 Returns whether shadow should be displayed.
 
void setShadowFlag (bool b)
 Sets the shadow flag to b.
 
std::string getShadowToolTip () const
 
void setShadowTransparency (int v)
 Sets the shadow transparency.
 
int getShadowTransparency () const
 Returns the shadow transparency.
 
int getMinimumShadowTransparency () const
 Returns the minimum value of the shadow transparency.
 
int getMaximumShadowTransparency () const
 Returns the maximum value of the shadow transparency.
 
int getDefaultShadowTransparency () const
 Returns the default value of the shadow transparency.
 
int getShadowTransparencySingleStep () const
 
ShadowPreset getShadowPreset () const
 Returns the shadow preset.
 
void setShadowPreset (ShadowPreset preset)
 Sets the shadow preset to preset.
 
int getShadowPresetIndex () const
 Returns the shadow preset's index.
 
void setShadowPresetIndex (int i)
 Sets the shadow preset to i.
 
int getDefaultShadowPresetIndex () const
 Returns the default shadow presets.
 
int getShadowPresetCount () const
 Returns the number of shadow presets.
 
std::string getShadowPresetItemText (int i) const
 Returns the name of the i-th shadow preset.
 
std::string getShadowPresetToolTip () const
 
int getShadowResolution () const
 Returns the shadow resolution value.
 
void setShadowResolution (int i)
 Sets the shadow resolution value to i.
 
int getMinimumShadowResolution () const
 Returns the minimum value of shadows' resolution.
 
int getMaximumShadowResolution () const
 Returns the maximum value of shadows' resolution.
 
int getDefaultShadowResolution () const
 Returns the default value of shadows' resolution.
 
int getShadowResolutionSingleStep () const
 
std::string getShadowResolutionToolTip () const
 
int getShadowMultisamplingFactor () const
 Returns the shadow multisampling factor value.
 
void setShadowMultisamplingFactor (int i)
 Sets the shadow multisampling factor value to i.
 
int getMinimumShadowMultisamplingFactor () const
 Returns the minimum value of shadows' multisampling factor.
 
int getMaximumShadowMultisamplingFactor () const
 Returns the maximum value of shadows' multisampling factor.
 
int getDefaultShadowMultisamplingFactor () const
 Returns the default value of shadows' multisampling factor.
 
int getShadowMultisamplingFactorSingleStep () const
 
std::string getShadowMultisamplingFactorToolTip () const
 
float getShadowSpread () const
 Returns the spread of shadows.
 
void setShadowSpread (float v)
 Sets the spread of shadows to v.
 
float getMinimumShadowSpread () const
 Returns the minimum value of the spread of shadows.
 
float getMaximumShadowSpread () const
 Returns the maximum value of the spread of shadows.
 
float getDefaultShadowSpread () const
 Returns the default value of the spread of shadows.
 
float getShadowSpreadSingleStep () const
 
std::string getShadowSpreadToolTip () const
 
void setShadowOffset (SBQuantity::length v)
 Sets the offset between objects and their shadows.
 
SBQuantity::length getShadowOffset () const
 Returns the offset between objects and their shadows.
 
SBQuantity::length getMinimumShadowOffset () const
 Returns the minimum value of the offset between objects and their shadows.
 
SBQuantity::length getMaximumShadowOffset () const
 Returns the maximum value of the offset between objects and their shadows.
 
SBQuantity::length getDefaultShadowOffset () const
 Returns the default value of the offset between objects and their shadows.
 
SBQuantity::length getShadowOffsetSingleStep () const
 
std::string getShadowOffsetToolTip () const
 
static std::string getShadowPresetString (ShadowPreset preset)
 Returns a human-readable string representation of the shadow preset preset.
 

Constructors and destructors

 SBDDocumentRenderPreset ()
 Constructs a render preset.
 
 SBDDocumentRenderPreset (const std::string &name)
 Constructs a render preset with name name.
 
virtual ~SBDDocumentRenderPreset ()
 Destructs the render preset.
 

Serialization

virtual bool isSerializable () const override
 Returns true.
 
virtual void serialize (SBCSerializer *serializer, const SBNodeIndexer &nodeIndexer, const SBVersionNumber &sdkVersionNumber=SB_SDK_VERSION_NUMBER, const SBVersionNumber &classVersionNumber=SBVersionNumber(1, 0, 0)) const override
 Serializes the render preset.
 
virtual void unserialize (SBCSerializer *serializer, const SBNodeIndexer &nodeIndexer, const SBVersionNumber &sdkVersionNumber=SB_SDK_VERSION_NUMBER, const SBVersionNumber &classVersionNumber=SBVersionNumber(1, 0, 0)) override
 Unserializes the render preset.
 

Topology

SBDDocumentRenderPresetgetNextRenderPreset () const
 Returns the next render preset.
 
SBDDocumentRenderPresetgetPreviousRenderPreset () const
 Returns the previous render preset.
 
virtual SBDDocumentRenderPresetclone () override
 Returns a copy of the node.
 

Identity

virtual SBDDataGraphNode::Type getType () const override
 Returns the data graph node type.
 
SBUUID getUUID () const
 Returns the render preset UUID.
 
const std::string & getDescriptionForInspector () const
 Returns text description that will be shown in the Inspector.
 

Apply

void apply ()
 Applies the render preset.
 

Ambient occlusion

bool getSSAOFlag () const
 Returns the screen-space ambient occlusion (SSAO) effect is on or off.
 
void setSSAOFlag (bool b)
 Sets the screen-space ambient occlusion (SSAO) flag to b.
 
std::string getSSAOToolTip () const
 
int getSSAOKernelSize () const
 Returns the SSAO kernel size value.
 
void setSSAOKernelSize (int v)
 Sets the SSAO kernel size value to v.
 
int getMinimumSSAOKernelSize () const
 Returns the minimum value of the SSAO kernel size.
 
int getMaximumSSAOKernelSize () const
 Returns the maximum value of the SSAO kernel size.
 
int getDefaultSSAOKernelSize () const
 Returns the default value of the SSAO kernel size.
 
int getSSAOKernelSizeSingleStep () const
 
std::string getSSAOKernelSizeToolTip () const
 
float getSSAOStrength () const
 Returns the SSAO strength value.
 
void setSSAOStrength (float v)
 Sets the SSAO strength value to v.
 
float getMinimumSSAOStrength () const
 Returns the minimum value of the SSAO strength.
 
float getMaximumSSAOStrength () const
 Returns the maximum value of the SSAO strength.
 
float getDefaultSSAOStrength () const
 Returns the default value of the SSAO strength.
 
float getSSAOStrengthSingleStep () const
 
std::string getSSAOStrengthToolTip () const
 
float getSSAORadius () const
 Returns the SSAO radius.
 
void setSSAORadius (float v)
 Sets the SSAO radius to v.
 
float getMinimumSSAORadius () const
 Returns the minimum value of the SSAO radius.
 
float getMaximumSSAORadius () const
 Returns the maximum value of the SSAO radius.
 
float getDefaultSSAORadius () const
 Returns the default value of the SSAO radius.
 
float getSSAORadiusSingleStep () const
 
std::string getSSAORadiusToolTip () const
 
float getSSAORandomization () const
 Returns the SSAO randomization value.
 
void setSSAORandomization (float v)
 Sets the SSAO randomization value to v.
 
float getMinimumSSAORandomization () const
 Returns the minimum value of the SSAO randomization parameter.
 
float getMaximumSSAORandomization () const
 Returns the maximum value of the SSAO randomization parameter.
 
float getDefaultSSAORandomization () const
 Returns the default value of the SSAO randomization parameter.
 
float getSSAORandomizationSingleStep () const
 
std::string getSSAORandomizationToolTip () const
 
bool getOSAOFlag () const
 Returns the object-space ambient occlusion (OSAO) effect is on or off.
 
void setOSAOFlag (bool b)
 Sets the object-space ambient occlusion (OSAO) flag to b.
 
std::string getOSAOToolTip () const
 
int getOSAOGridSize () const
 Returns the SSAO kernel size value.
 
void setOSAOGridSize (int v)
 Sets the SSAO kernel size value to v.
 
int getMinimumOSAOGridSize () const
 Returns the minimum value of the SSAO kernel size.
 
int getMaximumOSAOGridSize () const
 Returns the maximum value of the SSAO kernel size.
 
int getDefaultOSAOGridSize () const
 Returns the default value of the SSAO kernel size.
 
int getOSAOGridSizeSingleStep () const
 
std::string getOSAOGridSizeToolTip () const
 
float getOSAOStrength () const
 Returns the OSAO strength value.
 
void setOSAOStrength (float v)
 Sets the OSAO strength value to v.
 
float getMinimumOSAOStrength () const
 Returns the minimum value of the OSAO strength.
 
float getMaximumOSAOStrength () const
 Returns the maximum value of the OSAO strength.
 
float getDefaultOSAOStrength () const
 Returns the default value of the OSAO strength.
 
float getOSAOStrengthSingleStep () const
 
std::string getOSAOStrengthToolTip () const
 

Bloom effect

bool getBloomFlag () const
 Returns the bloom effect is on or off.
 
void setBloomFlag (bool b)
 Sets the bloom flag to b.
 
std::string getBloomToolTip () const
 
int getBloomRadius () const
 Returns the number of bloom passes.
 
void setBloomRadius (int v)
 Sets the number of bloom passes value to v.
 
int getMinimumBloomRadius () const
 Returns the minimum number of bloom passes.
 
int getMaximumBloomRadius () const
 Returns the maximum number of bloom passes.
 
int getDefaultBloomRadius () const
 Returns the default number of bloom passes.
 
int getBloomRadiusSingleStep () const
 
std::string getBloomRadiusToolTip () const
 
float getBloomThreshold () const
 Returns the bloom threshold value.
 
void setBloomThreshold (float v)
 Sets the bloom threshold value to v.
 
float getMinimumBloomThreshold () const
 Returns the minimum value of the bloom threshold.
 
float getMaximumBloomThreshold () const
 Returns the maximum value of the bloom threshold.
 
float getDefaultBloomThreshold () const
 Returns the default value of the bloom threshold.
 
float getBloomThresholdSingleStep () const
 
float getBloomStrength () const
 Returns the bloom strength value.
 
void setBloomStrength (float v)
 Sets the bloom strength value to v.
 
float getMinimumBloomStrength () const
 Returns the minimum value of the bloom strength.
 
float getMaximumBloomStrength () const
 Returns the maximum value of the bloom strength.
 
float getDefaultBloomStrength () const
 Returns the default value of the bloom strength.
 
float getBloomStrengthSingleStep () const
 

Depth-of-field

bool getDepthOfFieldFlag () const
 Returns the depth-of-field effect is on or off.
 
void setDepthOfFieldFlag (bool b)
 Sets the depth-of-field flag to b.
 
std::string getDepthOfFieldToolTip () const
 
void setDepthOfFieldStrength (float v)
 Sets the depth-of-field strength.
 
float getDepthOfFieldStrength () const
 Returns the depth-of-field strength.
 
float getMinimumDepthOfFieldStrength () const
 Returns the minimum value of the depth-of-field strength.
 
float getMaximumDepthOfFieldStrength () const
 Returns the maximum value of the depth-of-field strength.
 
float getDefaultDepthOfFieldStrength () const
 Returns the default value of the depth-of-field strength.
 
float getDepthOfFieldStrengthSingleStep () const
 
std::string getDepthOfFieldStrengthToolTip () const
 
void setDepthOfFieldDistance (SBQuantity::length v)
 Sets the distance at which the depth-of-field effect begins.
 
SBQuantity::length getDepthOfFieldDistance () const
 Returns the distance at which the depth-of-field effect begins.
 
SBQuantity::length getMinimumDepthOfFieldDistance () const
 Returns the minimum value of the depth-of-field's distance.
 
SBQuantity::length getMaximumDepthOfFieldDistance () const
 Returns the maximum value of the depth-of-field's distance.
 
SBQuantity::length getDefaultDepthOfFieldDistance () const
 Returns the default value of the depth-of-field's distance.
 
SBQuantity::length getDepthOfFieldDistanceSingleStep () const
 
std::string getDepthOfFieldDistanceToolTip () const
 

Fog

bool getFogFlag () const
 Returns the fog effect is on or off.
 
void setFogFlag (bool b)
 Sets the fog flag to b.
 
std::string getFogToolTip () const
 
void setFogStrength (int v)
 Sets the fog strength.
 
int getFogStrength () const
 Returns the fog strength.
 
int getMinimumFogStrength () const
 Returns the minimum value of the fog strength.
 
int getMaximumFogStrength () const
 Returns the maximum value of the fog strength.
 
int getDefaultFogStrength () const
 Returns the default value of the fog strength.
 
int getFogStrengthSingleStep () const
 
std::string getFogStrengthToolTip () const
 
void setFogNearDistance (SBQuantity::length v)
 Sets the distance at which the fog begins.
 
SBQuantity::length getFogNearDistance () const
 Returns the distance at which the fog begins.
 
SBQuantity::length getMinimumFogNearDistance () const
 Returns the minimum value of the fog's near distance.
 
SBQuantity::length getMaximumFogNearDistance () const
 Returns the maximum value of the fog's near distance.
 
SBQuantity::length getDefaultFogNearDistance () const
 Returns the default value of the fog's near distance.
 
SBQuantity::length getFogNearDistanceSingleStep () const
 
std::string getFogNearDistanceToolTip () const
 
void setFogFarDistance (SBQuantity::length v)
 Sets the distance beyond which fog is maximal.
 
SBQuantity::length getFogFarDistance () const
 Returns the distance beyond which fog is maximal.
 
SBQuantity::length getMinimumFogFarDistance () const
 Returns the minimum value of the fog's far distance.
 
SBQuantity::length getMaximumFogFarDistance () const
 Returns the maximum value of the fog's far distance.
 
SBQuantity::length getDefaultFogFarDistance () const
 Returns the default value of the fog's far distance.
 
SBQuantity::length getFogFarDistanceSingleStep () const
 
std::string getFogFarDistanceToolTip () const
 

Grid

bool getGridFlag () const
 Returns whether the grid should be displayed in the Viewport.
 
void setGridFlag (bool b)
 Sets the grid flag to b.
 
std::string getGridToolTip () const
 
void setGridSpacing (SBQuantity::length v)
 Sets the grid spacing.
 
SBQuantity::length getGridSpacing () const
 Returns the grid spacing.
 
SBQuantity::length getMinimumGridSpacing () const
 Returns the minimum value of the grid spacing.
 
SBQuantity::length getMaximumGridSpacing () const
 Returns the maximum value of the grid spacing.
 
SBQuantity::length getDefaultGridSpacing () const
 Returns the default value of the grid spacing.
 
SBQuantity::length getGridSpacingSingleStep () const
 
void setGridThickness (SBQuantity::length v)
 Sets the grid thickness.
 
SBQuantity::length getGridThickness () const
 Returns the grid thickness.
 
SBQuantity::length getMinimumGridThickness () const
 Returns the minimum value of the grid thickness.
 
SBQuantity::length getMaximumGridThickness () const
 Returns the maximum value of the grid thickness.
 
SBQuantity::length getDefaultGridThickness () const
 Returns the default value of the grid thickness.
 
SBQuantity::length getGridThicknessSingleStep () const
 
void setGridRadius (SBQuantity::length v)
 Sets the grid radius.
 
SBQuantity::length getGridRadius () const
 Returns the grid radius.
 
SBQuantity::length getMinimumGridRadius () const
 Returns the minimum value of the grid radius.
 
SBQuantity::length getMaximumGridRadius () const
 Returns the maximum value of the grid radius.
 
SBQuantity::length getDefaultGridRadius () const
 Returns the default value of the grid radius.
 
SBQuantity::length getGridRadiusSingleStep () const
 
void setGridTransparency (int v)
 Sets the grid transparency.
 
int getGridTransparency () const
 Returns the grid transparency.
 
int getMinimumGridTransparency () const
 Returns the minimum value of the grid transparency.
 
int getMaximumGridTransparency () const
 Returns the maximum value of the grid transparency.
 
int getDefaultGridTransparency () const
 Returns the default value of the grid transparency.
 
int getGridTransparencySingleStep () const
 

Pinhole effect

bool getPinholeFlag () const
 Returns whether the pinhole effect is on or off.
 
void setPinholeFlag (bool b)
 Sets the pinhole flag to b.
 
std::string getPinholeToolTip () const
 
void setPinholeSharpness (int v)
 Sets the pinhole sharpness.
 
int getPinholeSharpness () const
 Returns the pinhole sharpness.
 
int getMinimumPinholeSharpness () const
 Returns the minimum value of the pinhole sharpness.
 
int getMaximumPinholeSharpness () const
 Returns the maximum value of the pinhole sharpness.
 
int getDefaultPinholeSharpness () const
 Returns the default value of the pinhole sharpness.
 
int getPinholeSharpnessSingleStep () const
 

Scale

bool getScaleFlag () const
 Returns whether the scale should be displayed in the Viewport.
 
void setScaleFlag (bool b)
 Sets the scale flag to b.
 
std::string getScaleToolTip () const
 
void setScaleMinimumLength (int v)
 Sets the scale's minimum lengths.
 
int getScaleMinimumLength () const
 Returns the scale's minimum lengths.
 
int getMinimumScaleMinimumLength () const
 Returns the minimum value of the scale's minimum lengths.
 
int getMaximumScaleMinimumLength () const
 Returns the maximum value of the scale's minimum lengths.
 
int getDefaultScaleMinimumLength () const
 Returns the default value of the scale's minimum lengths.
 
int getScaleMinimumLengthSingleStep () const
 
std::string getScaleMinimumLengthSuffix () const
 
void setScaleThickness (int v)
 Sets the scale thickness.
 
int getScaleThickness () const
 Returns the scale thickness.
 
int getMinimumScaleThickness () const
 Returns the minimum value of the scale thickness.
 
int getMaximumScaleThickness () const
 Returns the maximum value of the scale thickness.
 
int getDefaultScaleThickness () const
 Returns the default value of the scale thickness.
 
int getScaleThicknessSingleStep () const
 
std::string getScaleThicknessSuffix () const
 

Silhouettes

bool getSilhouetteFlag () const
 Returns whether silhouettes should be displayed.
 
void setSilhouetteFlag (bool b)
 Sets the silhouette flag to b.
 
std::string getSilhouetteToolTip () const
 
const SBColorgetSilhouetteColor () const
 Returns the silhouette color.
 
void setSilhouetteColor (const SBColor &color)
 Sets the silhouette color to color.
 
const SBColorgetDefaultSilhouetteColor () const
 Returns the silhouette's default color.
 
std::string getSilhouetteColorToolTip () const
 
void setSilhouetteTransparency (int v)
 Sets the silhouette transparency.
 
int getSilhouetteTransparency () const
 Returns the silhouette transparency.
 
int getMinimumSilhouetteTransparency () const
 Returns the minimum value of the silhouette transparency.
 
int getMaximumSilhouetteTransparency () const
 Returns the maximum value of the silhouette transparency.
 
int getDefaultSilhouetteTransparency () const
 Returns the default value of the silhouette transparency.
 
int getSilhouetteTransparencySingleStep () const
 
void setSilhouetteThickness (int v)
 Sets the silhouette thickness.
 
int getSilhouetteThickness () const
 Returns the silhouette thickness.
 
int getMinimumSilhouetteThickness () const
 Returns the minimum value of the silhouette thickness.
 
int getMaximumSilhouetteThickness () const
 Returns the maximum value of the silhouette thickness.
 
int getDefaultSilhouetteThickness () const
 Returns the default value of the silhouette thickness.
 
int getSilhouetteThicknessSingleStep () const
 
std::string getSilhouetteThicknessSuffix () const
 
void setSilhouetteDistanceThreshold (SBQuantity::length v)
 Sets the silhouette's distance threshold.
 
SBQuantity::length getSilhouetteDistanceThreshold () const
 Returns the silhouette's distance threshold.
 
SBQuantity::length getMinimumSilhouetteDistanceThreshold () const
 Returns the minimum value of the silhouette's distance threshold.
 
SBQuantity::length getMaximumSilhouetteDistanceThreshold () const
 Returns the maximum value of the silhouette's distance threshold.
 
SBQuantity::length getDefaultSilhouetteDistanceThreshold () const
 Returns the default value of the silhouette's distance threshold.
 
SBQuantity::length getSilhouetteDistanceThresholdSingleStep () const
 
std::string getSilhouetteDistanceThresholdToolTip () const
 
bool getSilhouetteFogAttenuationFlag () const
 Returns whether silhouettes should have fog attenuation.
 
void setSilhouetteFogAttenuationFlag (bool b)
 Sets the silhouette's fog attenuation flag to b.
 
std::string getSilhouetteFogAttenuationToolTip () const
 

Structural model rendering

bool getConstantAtomRadiusFlag () const
 Returns true if atoms should be rendered with a constant radius, false if atoms should be rendered with the atom size proportional to Van der Waals radius.
 
bool getNonConstantAtomRadiusFlag () const
 This is a convenience function that returns an opposite to what returns getConstantAtomRadiusFlag()
 
void setConstantAtomRadiusFlag (bool b)
 Sets the whether atoms should be rendered with a constant radius.
 
std::string getConstantAtomRadiusFlagToolTip () const
 
void setConstantAtomRadius (SBQuantity::length v)
 Sets the constant atom radius value.
 
SBQuantity::length getConstantAtomRadius () const
 Returns the constant atom radius value.
 
SBQuantity::length getMinimumConstantAtomRadius () const
 Returns the minimum value of the constant atom radius.
 
SBQuantity::length getMaximumConstantAtomRadius () const
 Returns the maximum value of the constant atom radius.
 
SBQuantity::length getDefaultConstantAtomRadius () const
 Returns the default value of the constant atom radius.
 
SBQuantity::length getConstantAtomRadiusSingleStep () const
 
std::string getConstantAtomRadiusToolTip () const
 
void setAtomRadiusRatioToVanDerWaalsRadius (float v)
 Sets the ratio of atom size to van der Waals radius.
 
float getAtomRadiusRatioToVanDerWaalsRadius () const
 Returns the ratio of atom size to van der Waals radius.
 
float getMinimumAtomRadiusRatioToVanDerWaalsRadius () const
 Returns the minimum value of the ratio of atom size to van der Waals radius.
 
float getMaximumAtomRadiusRatioToVanDerWaalsRadius () const
 Returns the maximum value of the ratio of atom size to van der Waals radius.
 
float getDefaultAtomRadiusRatioToVanDerWaalsRadius () const
 Returns the default value of the ratio of atom size to van der Waals radius.
 
float getAtomRadiusRatioToVanDerWaalsRadiusSingleStep () const
 
std::string getAtomRadiusRatioToVanDerWaalsRadiusSuffix () const
 
std::string getAtomRadiusRatioToVanDerWaalsRadiusToolTip () const
 
bool getRenderMultipleBondsFlag () const
 Returns true if multiple bonds should be rendered explicitly (default), false of the order of a bond should be represented by its thickness.
 
void setRenderMultipleBondsFlag (bool b)
 Sets the whether multiple bonds should be rendered explicitly.
 
std::string getRenderMultipleBondsToolTip () const
 
void setBondRadius (SBQuantity::length v)
 Sets the bond radius.
 
SBQuantity::length getBondRadius () const
 Returns the bond radius.
 
SBQuantity::length getMinimumBondRadius () const
 Returns the minimum value of the bond radius.
 
SBQuantity::length getMaximumBondRadius () const
 Returns the maximum value of the bond radius.
 
SBQuantity::length getDefaultBondRadius () const
 Returns the default value of the bond radius.
 
SBQuantity::length getBondRadiusSingleStep () const
 
std::string getBondRadiusToolTip () const
 

Signals

virtual void changed ()
 Emits the RenderPresetChanged event.
 

Messaging

void connectDocumentSignalToSlot (SBCReferenceTarget *referenceTarget, void(SBCReferenceTarget::*functionPointer)(SBDocumentEvent *), SBCReferenceTarget *nextReferenceTarget=0, void(SBCReferenceTarget::*nextFunctionPointer)(SBDocumentEvent *)=0)
 Connects the document signal to a slot.
 
bool documentSignalIsConnectedToSlot (SBCReferenceTarget *referenceTarget, void(SBCReferenceTarget::*functionPointer)(SBDocumentEvent *)) const
 Returns true if and only if the document signal is connected to the slot.
 
void disconnectDocumentSignalFromSlot (SBCReferenceTarget *referenceTarget, void(SBCReferenceTarget::*functionPointer)(SBDocumentEvent *))
 Disconnects the document signal from a slot.
 

Debugging

virtual std::string toStdString (unsigned int offset=0) const
 Returns a string representation of the render preset.
 
virtual void print (unsigned int offset=0) const override
 Prints the render preset.
 
 SB_DECLARE_DATA (SBDDocumentRenderPreset)
 

Additional Inherited Members

- Public Types inherited from SBDDataGraphNode
enum  Type {
  Undefined ,
  StructuralModel ,
  StructuralModelNode ,
  StructuralModelConformation ,
  Conformation ,
  StructuralModelPath ,
  Path ,
  StructuralModelNodeGroup ,
  StructuralGroup ,
  StructuralModelNodeRoot ,
  Root ,
  StructuralModelNodeAtom ,
  Atom ,
  StructuralModelNodeBond ,
  Bond ,
  StructuralModelNodeHydrogenBond ,
  HydrogenBond ,
  StructuralModelNodeHydrogenBondGroup ,
  HydrogenBondGroup ,
  StructuralModelNodeResidue ,
  Residue ,
  StructuralModelNodeSegment ,
  Segment ,
  StructuralModelNodeChain ,
  Chain ,
  StructuralModelNodeMolecule ,
  Molecule ,
  StructuralModelNodeBackbone ,
  Backbone ,
  StructuralModelNodeSideChain ,
  SideChain ,
  VisualModel ,
  VisualModelMesh ,
  Mesh ,
  DynamicalModel ,
  DynamicalModelParticleSystem ,
  ParticleSystem ,
  DynamicalModelRigidBodySystem ,
  RigidBodySystem ,
  DynamicalModelArticulatedBodySystem ,
  ArticulatedBodySystem ,
  DynamicalModelNode ,
  DynamicalNode ,
  DynamicalModelNodeGroup ,
  DynamicalGroup ,
  DynamicalModelNodeRoot ,
  DynamicalRoot ,
  DynamicalModelNodeParticle ,
  Particle ,
  DynamicalModelNodeRigidBody ,
  RigidBody ,
  DynamicalModelNodeArticulatedBody ,
  ArticulatedBody ,
  InteractionModel ,
  InteractionModelParticleSystem ,
  InteractionModelRigidBodySystem ,
  InteractionModelArticulatedBodySystem ,
  PropertyModel ,
  PropertyModelFunction ,
  Simulator ,
  SimulatorParticleSystem ,
  SimulatorRigidBodySystem ,
  SimulatorArticulatedBodySystem ,
  StateUpdater ,
  StateUpdaterParticleSystem ,
  StateUpdaterRigidBodySystem ,
  StateUpdaterArticulatedBodySystem ,
  Animation ,
  Camera ,
  Document ,
  DocumentManager ,
  File ,
  Folder ,
  Label ,
  Light ,
  Note ,
  Presentation ,
  RenderPreset ,
  DataGraphNodeGroup ,
  NodeGroup ,
  Controller ,
  ControllerNode ,
  Asset
}
 The type of the data graph node. More...
 
enum class  RenderingPass {
  Setup ,
  OpaqueGeometry ,
  SelectableGeometry ,
  ShadowingGeometry ,
  TransparentGeometry ,
  Interface ,
  Text
}
 The rendering pass. More...
 
- Public Member Functions inherited from SBDDataGraphNode
SBDDataGraphNodegetParent () const
 Returns the parent of the node.
 
SBDDataGraphNodegetThisNode () const
 Returns the pointer to this node.
 
SBDDataGraphNodegetNextNode () const
 Returns the pointer to the next node in the children of the node's parent.
 
SBDDataGraphNodegetPreviousNode () const
 Returns the pointer to the previous node in the children of the node's parent.
 
SBDDataGraphNodegetNextNode (SBDDataGraphNode::Type nodeType) const
 Returns the pointer to the next node with type nodeType in the children of the node's parent.
 
SBDDataGraphNodegetPreviousNode (SBDDataGraphNode::Type nodeType) const
 Returns the pointer to the previous node with type nodeType in the children of the node's parent.
 
SBDDocumentgetDocument () const
 Returns the document the node belongs to.
 
virtual bool canAddChild (const SBDDataGraphNode *node, const SBDDataGraphNode *nextNode=nullptr) const
 Returns whether this node can add node as a child.
 
virtual bool canAddChildType (SBDDataGraphNode::Type nodeType) const
 Returns whether this node can add a node with type nodeType as a child.
 
virtual bool canHaveDescendantType (SBDDataGraphNode::Type nodeType) const
 Returns whether this node can have a node with type nodeType as a descendant.
 
virtual bool addChild (SBDDataGraphNode *node, SBDDataGraphNode *nextNode=nullptr)
 Adds a child to the node.
 
virtual bool removeChild (SBDDataGraphNode *node)
 Removes a child from the node.
 
bool hasOneOf (const SBNodeIndexer &nodeIndexer) const
 Returns true if and only if this node is one of the nodes of the nodeIndexer, or is the ancestor of one of them, or is a group that stores one of them.
 
bool descendsFrom (const SBDDataGraphNode *node) const
 Returns true if and only if this node is node, or descends from it.
 
bool descendsFrom (const SBNodeIndexer &nodeIndexer) const
 Returns true if and only if this node is one of the nodes of the nodeIndexer, or descends from one of them.
 
bool descendsFrom (SBPointerIndexer< SBDDataGraphNode > *nodePointerIndexer) const
 Returns true if and only if this node is one of the nodes of the nodePointerIndexer, or descends from one of them.
 
bool isIn (const SBDDataGraphNode *node) const
 Returns true if and only if this node is node, or descends from it, or belongs to a group stored in node.
 
bool isIn (const SBNodeIndexer &nodeIndexer) const
 Returns true if and only if this node is one of the nodes of the nodeIndexer, or descends from one of them, or belongs to a group stored in one of the nodes of the nodeIndexer.
 
bool isIn (SBPointerIndexer< SBDDataGraphNode > *nodePointerIndexer) const
 Returns true if and only if this node is one of the nodes of the nodePointerIndexer, or descends from one of them, or belongs to a group stored in of the nodes of the nodePointerIndexer.
 
bool isOneOf (const SBNodeIndexer &nodeIndexer) const
 Returns true if and only if this node is one of the nodes of the nodeIndexer.
 
bool isOneOf (SBPointerIndexer< SBDDataGraphNode > *nodePointerIndexer) const
 Returns true if and only if this node is one of the nodes of the nodePointerIndexer.
 
SBDDataGraphNodegetRoot () const
 Returns the root of the hierarchy the node belongs to.
 
unsigned int getNodeIndex () const
 Returns the node index (unique in the whole data graph, but non-persistent)
 
std::string getTypeString (bool humanReadable=false) const
 Returns a string describing the type of the data graph node.
 
virtual std::string const & getName () const
 Returns the name of the node.
 
virtual void setName (const std::string &name)
 Sets the name of the node.
 
bool isType (Type type) const
 Returns true when the type of the node corresponds to type.
 
bool isModel () const
 Returns true when the node is a model.
 
bool isAtom () const
 Returns true when the node is an atom.
 
bool isBond () const
 Returns true when the node is a bond.
 
bool isStructuralNode () const
 Returns true when the node is a structural node.
 
bool isStructuralModel () const
 Returns true when the node is a structural model.
 
bool isVisualModel () const
 Returns true when the node is a visual model.
 
bool isDynamicalModel () const
 Returns true when the node is a dynamical model.
 
bool isInteractionModel () const
 Returns true when the node is a interaction model.
 
bool isPropertyModel () const
 Returns true when the node is a property model.
 
bool isMesh () const
 Returns true when the node is a mesh.
 
bool isLight () const
 Returns true when the node is a light.
 
bool isSimulator () const
 Returns true when the node is a simulator.
 
bool isBallAndStick () const
 Returns true when the node is the default ball-and-stick visual model.
 
bool isLicorice () const
 Returns true when the node is the default licorice visual model.
 
bool isVanDerWaals () const
 Returns true when the node is the default van der Waals visual model.
 
bool isCartoon () const
 Returns true when the node is the default cartoon visual model.
 
bool isRibbon () const
 Returns true when the node is the default ribbon visual model.
 
bool isTube () const
 Returns true when the node is the default tube visual model.
 
bool isGaussianSurface () const
 Returns true when the node is the default Gaussian surface visual model.
 
bool isSolventAccessibleSurface () const
 Returns true when the node is the default solvent accessible surface visual model.
 
bool isSolventExcludedSurface () const
 Returns true when the node is the default solvent excluded surface visual model.
 
virtual bool isLocked () const
 Returns whether the node is locked.
 
virtual bool getLockedFlag () const
 Returns the locked flag.
 
virtual void setLockedFlag (bool flag)
 Sets the locked flag.
 
bool isCreated () const
 Returns true if and only if the node is created.
 
void create ()
 Creates the node.
 
bool isErased () const
 Returns true if and only if the node is erased.
 
void erase ()
 Erases the node.
 
virtual unsigned int getFlags () const
 Returns the flags.
 
virtual unsigned int getInheritedFlags () const
 Returns the inherited flags.
 
bool isSelected () const
 Returns whether the node is selected.
 
bool getSelected () const
 Returns whether the node is selected.
 
bool getSelectionFlag () const
 Returns the selection flag.
 
void setSelectionFlag (bool flag)
 Sets the selection flag.
 
bool isVisible () const
 Returns whether the node is visible.
 
bool getVisible () const
 Returns whether the node is visible.
 
bool getVisibilityFlag () const
 Returns the visibility flag.
 
void setVisibilityFlag (bool flag)
 Sets the visibility flag.
 
bool isHighlighted () const
 Returns whether the node is highlighted.
 
bool getHighlightingFlag () const
 Returns the highlighting flag.
 
void setHighlightingFlag (bool flag)
 Sets the highlighting flag.
 
virtual void display (RenderingPass renderingPass)
 Displays the node.
 
virtual void display ()
 Displays the node (deprecated)
 
virtual void displayForShadow ()
 Displays the node for shadowing purposes (deprecated)
 
virtual void displayForSelection ()
 Displays the node for selection purposes (deprecated)
 
virtual unsigned int getOpacity () const
 Returns the opacity.
 
virtual void setOpacity (unsigned int opacity)
 Sets the opacity.
 
virtual bool hasOpacityRange () const
 Returns whether the node has the opacity range.
 
virtual unsigned int getDefaultOpacity () const
 Returns the default opacity.
 
virtual unsigned int getMinimumOpacity () const
 Returns the minimum opacity.
 
virtual unsigned int getMaximumOpacity () const
 Returns the maximum opacity.
 
virtual unsigned int getOpacitySingleStep () const
 Returns the opacity single step.
 
virtual std::string getOpacitySuffix () const
 Returns the opacity suffix.
 
virtual unsigned int getTransparency () const
 Returns the transparency.
 
virtual void setTransparency (unsigned int transparency)
 Sets the transparency.
 
virtual bool hasTransparencyRange () const
 Returns whether the node has the transparency range.
 
virtual unsigned int getDefaultTransparency () const
 Returns the default transparency.
 
virtual unsigned int getMinimumTransparency () const
 Returns the minimum transparency.
 
virtual unsigned int getMaximumTransparency () const
 Returns the maximum transparency.
 
virtual unsigned int getTransparencySingleStep () const
 Returns the transparency single step.
 
virtual std::string getTransparencySuffix () const
 Returns the transparency suffix.
 
float getInheritedOpacity () const
 Returns the cumulative opacity, when taking into account the ascendants.
 
float getInheritedTransparency () const
 Returns the cumulative transparency, when taking into account the ascendants.
 
bool canAddMaterial () const
 Returns whether can add a material to the node based on its type.
 
bool addMaterial (SBDDataGraphNodeMaterial *material)
 Adds a material.
 
bool removeMaterial ()
 Removes the material.
 
void removeMaterialsFromDescendants ()
 Removes materials from all nodes that descend from this node, but it does not remove the material from the node itself.
 
bool hasMaterial () const
 Returns whether the node has a material (by itself, or inherited)
 
bool ownsMaterial () const
 Returns whether the node owns a material.
 
SBDDataGraphNodeMaterialgetMaterial () const
 Returns the material.
 
SBDDataGraphNodegetMaterialOwner () const
 Returns the node whose material is inherited.
 
void connectBaseSignalToSlot (SBCReferenceTarget *referenceTarget, void(SBCReferenceTarget::*functionPointer)(SBBaseEvent *), SBCReferenceTarget *nextReferenceTarget=0, void(SBCReferenceTarget::*nextFunctionPointer)(SBBaseEvent *)=0)
 Connects the base signal to a slot.
 
bool baseSignalIsConnectedToSlot (SBCReferenceTarget *referenceTarget, void(SBCReferenceTarget::*functionPointer)(SBBaseEvent *)) const
 Returns true when the base signal is connected to a slot.
 
void disconnectBaseSignalFromSlot (SBCReferenceTarget *referenceTarget, void(SBCReferenceTarget::*functionPointer)(SBBaseEvent *))
 Disconnects the base signal from a slot.
 
virtual void getNodes (SBNodeIndexer &nodeIndexer, SBDDataGraphNode::Type nodeType, bool selectedNodesOnly=false, const SBNodePredicate &visitPredicate=SBDDataGraphNode::All(), bool includeDependencies=false) const
 Collects nodes into nodeIndexer, based on a nodeType, a selection status and a visitPredicate, with or without dependencies.
 
virtual void getNodes (SBNodeIndexer &nodeIndexer, const SBNodePredicate &selectionPredicate=SBDDataGraphNode::All(), const SBNodePredicate &visitPredicate=SBDDataGraphNode::All(), bool includeDependencies=false) const
 Collects nodes into nodeIndexer, based on a selectionPredicate and a visitPredicate, with or without dependencies.
 
virtual bool hasNode (SBDDataGraphNode::Type nodeType, bool selectedNodesOnly=false, const SBNodePredicate &visitPredicate=SBDDataGraphNode::All(), bool includeDependencies=false) const
 Returns whether the node has nodes based on a nodeType, a selection status and a visitPredicate, with or without dependencies.
 
virtual bool hasNode (const SBNodePredicate &selectionPredicate=SBDDataGraphNode::All(), const SBNodePredicate &visitPredicate=SBDDataGraphNode::All(), bool includeDependencies=false) const
 Returns whether the node has nodes based on a selectionPredicate and a visitPredicate, with or without dependencies.
 
unsigned int countNodes (SBDDataGraphNode::Type nodeType, bool selectedNodesOnly=false, const SBNodePredicate &visitPredicate=SBDDataGraphNode::All(), bool includeDependencies=false) const
 Counts nodes based on a nodeType, a selection status and a visitPredicate, with or without dependencies.
 
unsigned int countNodes (const SBNodePredicate &selectionPredicate=SBDDataGraphNode::All(), const SBNodePredicate &visitPredicate=SBDDataGraphNode::All(), bool includeDependencies=false) const
 Counts nodes based on a selectionPredicate and a visitPredicate, with or without dependencies.
 
virtual void forEachNodeDepthFirst (void(*action)(SBDDataGraphNode *node))
 Performs an action on each node.
 
virtual void forEachNodeDepthFirst (SBCClass *object, void(SBCClass::*action)(SBDDataGraphNode *node))
 Performs an action on each node.
 
virtual std::string getHierarchyString (const std::string &separator=" / ", bool includeNodeType=false) const
 Returns a string with hierarchical information on the node and its parents names.
 
virtual unsigned int getNumberOfChains ()
 Returns the number of chains.
 
virtual unsigned int getNumberOfMolecules ()
 Returns the number of molecules.
 
virtual unsigned int getNumberOfResidues ()
 Returns the number of residues.
 
virtual unsigned int getNumberOfSegments ()
 Returns the number of segments.
 
virtual unsigned int getNumberOfStructuralGroups ()
 Returns the number of structural groups.
 
virtual unsigned int getNumberOfStructuralModels ()
 Returns the number of structural models.
 
virtual unsigned int getNumberOfAtoms ()
 Returns the number of atoms.
 
virtual unsigned int getNumberOfCarbons ()
 Returns the number of carbons.
 
virtual unsigned int getNumberOfHydrogens ()
 Returns the number of hydrogens.
 
virtual unsigned int getNumberOfNitrogens ()
 Returns the number of nitrogens.
 
virtual unsigned int getNumberOfOxygens ()
 Returns the number of oxygens.
 
virtual unsigned int getNumberOfSulfurs ()
 Returns the number of sulfurs.
 
virtual unsigned int getNumberOfCoarseGrainedAtoms ()
 Returns the number of coarse-grained atoms.
 
virtual unsigned int getNumberOfOtherAtoms ()
 Returns the number of other atoms.
 
virtual int getSumOfFormalCharges ()
 Returns the sum of formal charges.
 
virtual float getSumOfPartialCharges ()
 Returns the sum of partial charges.
 
virtual SBQuantity::mass getMolecularWeight ()
 Returns the molecular weight.
 
 SB_DECLARE_DATA (SBDDataGraphNode)
 
- Public Member Functions inherited from SBCReferenceTarget
unsigned int getMemoryFootprint () const
 
void printReferencesToOwners () const
 
 SBCReferenceTarget ()
 
virtual ~SBCReferenceTarget ()
 
- Static Public Member Functions inherited from SBDDataGraphNode
static void clone (const SBNodeIndexer &sourceNodeIndexer, SBNodeIndexer &destinationNodeIndexer)
 Clones the nodes in sourceNodeIndexer (treated as a whole) and places the clones in destinationNodeIndexer.
 
static SBDDataGraphNodegetNode (unsigned int nodeIndex)
 Returns the unique node corresponding to the node index nodeIndex.
 
static std::string getTypeString (Type type, bool humanReadable=false)
 Returns a string describing the type of the data graph node.
 
static bool canAddMaterial (SBDDataGraphNode::Type nodeType)
 Returns whether can add a material to a node of type nodeType.
 
static void forEachNodeInSelection (SBNodeIndexer &nodeIndexer, void(*action)(SBDDataGraphNode *node))
 Performs an action for each node in a selection.
 
static void forEachNodeInSelection (SBNodeIndexer &nodeIndexer, SBCClass *object, void(SBCClass::*action)(SBDDataGraphNode *node))
 Performs an action for each node in a selection.
 
- Protected Member Functions inherited from SBDDataGraphNode
 SBDDataGraphNode ()
 Builds a data graph node.
 
 SBDDataGraphNode (SBDDataGraphNodeData *dataPointer)
 Builds a data graph node.
 
virtual ~SBDDataGraphNode ()
 Destroys the node.
 
- Protected Member Functions inherited from SBCReferenceTarget
void removeAllReferenceOwners ()
 
 SBCReferenceTarget (SBCReferenceTargetData *dataPointer)
 
- Protected Attributes inherited from SBCReferenceTarget
SBCReferenceTargetData * dataPointer
 

Detailed Description

This class describes a render preset.

Short name: SBRenderPreset

Member Enumeration Documentation

◆ AntiAliasingPreset

Enumerator
BestSpeed 

The anti-aliasing preset for the best speed (low quality)

BetterSpeed 

The anti-aliasing preset for the better speed (medium quality)

HigherQuality 

The anti-aliasing preset for the higher quality.

HighestQuality 

The anti-aliasing preset for the highest quality.

Custom 

A custom anti-aliasing preset.

◆ BackgroundImageMode

Enumerator
ContainedInViewport 

Background image is fully contained in the viewport.

CoveringViewport 

Background image is covering in the viewport.

◆ BackgroundType

Enumerator
Default 

The default background.

White 

White background.

Black 

Black background.

Custom 

Custom background changing from top color to bottom color.

Image 

Image as a background.

◆ LightingPreset

Enumerator
Default 

The default 3D lighting preset.

FlatLight 

The flat lighting preset.

Custom 

A custom lighting preset.

◆ ShadowPreset

Enumerator
LowQuality 

Low quality shadows.

MediumQuality 

Medium quality shadows.

HighQuality 

High quality shadows.

SoftShadow 

Soft shadows (highest quality)

Custom 

A custom shadow preset.

Member Function Documentation

◆ apply()

void SBDDocumentRenderPreset::apply ( )

This function applies the render preset by setting the rendering preferences in the Main Preferences according to the render preset.

This function is This function is undoable
. It calls SAMSON::beginHolding() and SAMSON::endHolding() internally.

◆ clone()

SBDDocumentRenderPreset * SBDDocumentRenderPreset::clone ( )
overridevirtual

Reimplemented from SBDDataGraphNode.

◆ getType()

SBNode::Type SBDDocumentRenderPreset::getType ( ) const
overridevirtual

Reimplemented from SBDDataGraphNode.

◆ isSerializable()

bool SBDDocumentRenderPreset::isSerializable ( ) const
overridevirtual

Reimplemented from SBDDataGraphNode.

◆ print()

void SBDDocumentRenderPreset::print ( unsigned int  offset = 0) const
overridevirtual

Reimplemented from SBDDataGraphNode.

◆ serialize()

void SBDDocumentRenderPreset::serialize ( SBCSerializer serializer,
const SBNodeIndexer nodeIndexer,
const SBVersionNumber sdkVersionNumber = SB_SDK_VERSION_NUMBER,
const SBVersionNumber classVersionNumber = SBVersionNumber(1, 0, 0) 
) const
overridevirtual

Reimplemented from SBDDataGraphNode.

◆ unserialize()

void SBDDocumentRenderPreset::unserialize ( SBCSerializer serializer,
const SBNodeIndexer nodeIndexer,
const SBVersionNumber sdkVersionNumber = SB_SDK_VERSION_NUMBER,
const SBVersionNumber classVersionNumber = SBVersionNumber(1, 0, 0) 
)
overridevirtual

Reimplemented from SBDDataGraphNode.