VRay SDK for C++
Loading...
Searching...
No Matches
VRay::RuntimeUIGuides Class Reference
Inheritance diagram for VRay::RuntimeUIGuides:
VRay::UIGuides

Public Member Functions

bool isEnabled () const
 
bool isHidden () const
 
- Public Member Functions inherited from VRay::UIGuides
 UIGuides (const UIGuides &uiGuides)
 
int getCountOfOverrides () const
 
std::string getDisplayName () const
 
std::vector< std::string > getEnableDepends () const
 
std::vector< EnumItemgetEnumStrings () const
 
std::vector< std::string > getFileAssetExts () const
 
std::vector< std::string > getFileAssetNames () const
 
FileAssetOpType getFileAssetOp () const
 
float getFloat (const GuideType type) const
 
std::vector< float > getFloats (const GuideType type) const
 
GPUParamSupport getGPUSupportStatus () const
 
std::vector< std::string > getHideDepends () const
 
QuantityTypeEnum getQuantityType () const
 
std::string getRolloutName () const
 
std::vector< std::string > getStringEnumStrings () const
 
std::string getTabName () const
 
TierType getTier () const
 
UnitsType getUnits () const
 
std::string getValueOfOverriddenBy () const
 
std::string getValueOfOverride (const int index) const
 
bool hasAttribute (const AttributesType attributeType) const
 
bool hasEnabledCondition () const
 
bool hasHiddenCondition () const
 
bool hasOverriddenBy () const
 
bool hasOverride () const
 
bool hasType (const GuideType type) const
 
bool isEnum () const
 
bool isStringEnum () const
 
UIGuidesoperator= (const UIGuides &uiGuides)
 

Protected Member Functions

 RuntimeUIGuides (const void *pParamDef, const Internal::VRayRendererNative *renderer, InstanceId id)
 
- Protected Member Functions inherited from VRay::UIGuides
 UIGuides (const void *pParamDef)
 
const void * getParamDef () const
 

Friends

class PropertyRuntimeMeta
 

Additional Inherited Members

- Public Types inherited from VRay::UIGuides
enum  AttributesType {
  None = 0 , ObjectSet = 1 , TextureSlot = 2 , LightSet = 4 ,
  PartOf3dsMaxTriple = 8 , BitSet = 16 , Boolean = 32
}
 Used to specify some additional attributes for the parameter. More...
 
enum  FileAssetOpType { Load , Save , LoadAndSave }
 
enum  GuideType {
  Enum , Enable , DisplayName , MinValue ,
  MaxValue , SpinStep , Units , FileAsset ,
  Attributes , StringEnum , FileAssetNames , FileAssetOp ,
  StartRollout , StartTab , SoftMinValue , SoftMaxValue ,
  QuantityType , OverridenBy , Overrides , GPUSupport ,
  Tier , Hide , DefaultValue , MaxGuides
}
 UIGuides supported property types. More...
 
enum  QuantityTypeEnum { Unknown , Distance , Angle , LocalSubdivs }
 Defines the quantity type that the parameter represents. More...
 
enum  TierType { Basic = 0 , DefaultTier = 1 , Advanced = 2 }
 
enum  UnitsType {
  DefaultUnits , Radians , Degrees , Millimeters ,
  Centimeters , Meters
}
 

Member Function Documentation

◆ isEnabled()

bool VRay::RuntimeUIGuides::isEnabled ( ) const

Evaluates whether the enabled condition holds with the current values of the parameters of the plugin.

Returns
true if the parameter should be enabled in the UI, false otherwise.

◆ isHidden()

bool VRay::RuntimeUIGuides::isHidden ( ) const

Evaluates whether the hidden condition holds with the current values of the parameters of the plugin.

Returns
true if the parameter should be hidden in the UI, false otherwise.

The documentation for this class was generated from the following file: