Python Reference Guide
 
Loading...
Searching...
No Matches
FBEditProperty Class Reference

Property editor widget. More...

#include <pyfbsdk.h>

Inheritance diagram for FBEditProperty:

Public Member Functions

 FBEditProperty ()
 Constructor.
 
- Public Member Functions inherited from FBVisualComponent
 FBVisualComponent ()
 Constructor.
 
bool AddChild (FBVisualComponent pChild, int pId=0)
 Add a child component.
 
FBVisualComponent GetChild (int pId=0)
 Get a child component.
 
QWidget GetQWidgetAddress ()
 Get internal QWidget.
 
bool IsView ()
 Is component a view?
 
 Refresh (bool pNow=False)
 Refresh component.
 
 ViewExpose ()
 Exposed view callback function.
 
 ViewInput (int pMouseX, int pMouseY, FBInputType pAction, int pButtonKey, int pModifier)
 Input callback function.
 
- Public Member Functions inherited from FBComponent
 FBComponent ()
 Constructor.
 
str ClassName ()
 Get the class name.
 
 DisableObjectFlags (FBObjectFlag pFlags)
 Disable a specific Object Flags.
 
 EnableObjectFlags (FBObjectFlag pFlags)
 Enable a specific Object Flags.
 
bool FBCreate ()
 Open Reality Creation function.
 
 FBDelete ()
 Open Reality deletion function.
 
 FBDestroy ()
 Open Reality destruction function.
 
FBObjectFlag GetObjectFlags ()
 Get all Object Flags (concatenated).
 
bool GetObjectStatus (FBObjectStatus pStatus)
 Check to see if an object status is enabled.
 
FBFileReference GetOwnerFileReference (p0)
 Get the owner FileReference object.
 
 HardSelect ()
 HardSelect.
 
bool HasObjectFlags (FBObjectFlag pFlags)
 Check whether a specific object flag is enabled.
 
bool Is (int pTypeId)
 Returns true if object is of type TypeId.
 
bool ProcessNamespaceHierarchy (FBNamespaceAction pNamespaceAction, str pNamespaceName, str pReplaceTo=None, bool pAddRight=True)
 ProcessNamespaceHierarchy.
 
bool ProcessObjectNamespace (FBNamespaceAction pNamespaceAction, str pNamespaceName, str pReplaceTo=None, bool pAddRight=True)
 ProcessObjectNamespace.
 
int PropertyAdd (FBProperty pProperty)
 Add a property to the component's property manager.
 
bool PropertyAddReferenceProperty (FBProperty pReferenceProperty)
 Add a reference property to the component's property manager.
 
FBProperty PropertyCreate (str pName, FBType pType, str pDataType, bool pAnimatable, bool pIsUser=False, FBProperty pReferenceSource=None)
 Create user or dynamic property.
 
 PropertyGetModifiedList (FBArrayTemplate< FB > pPropList, FBPlugModificationFlag pModificationFlags)
 Get list of properties which have been modified since last loading.
 
 PropertyRemove (FBProperty pProperty)
 Remove a Property from the component's Property manager.
 
 SetObjectFlags (FBObjectFlag pFlags)
 SetObjectFlags.
 
 SetObjectStatus (FBObjectStatus pStatus, bool pValue)
 Enable/Disable a specific Object Status.
 

Public Attributes

float LargeInc
 Read Write Property: Indicate the large increment applied when click-draging on the property value (usually left-click-dragging)

 
float Precision
 Read Write Property: Used to specify the width and precision of the value shown. A value of 7.2 indicates to show at minimum 7 numbers, with 2 decimals.

 
FBReference Property
 Read Write Property: Property to edit. Set to NULL to disable.

 
float SliderMax
 Read Write Property: Should the property be editable using a slider, set the maximum value atainable with the slider.

 
float SliderMin
 Read Write Property: Should the property be editable using a slider, set the minimum value atainable with the slider.

 
float SmallInc
 Read Write Property: Indicate the small increment applied when click-draging on the property value (usually right-click-dragging)

 
- Public Attributes inherited from FBVisualComponent
str RegionName
 Read Write Property: Region name.
 
int RegionOffsetX
 Read Write Property: Region X offset.
 
int RegionOffsetY
 Read Write Property: Region Y offset.
 
int RegionOffsetWidth
 Read Write Property: Region width offset.
 
int RegionOffsetHeight
 Read Write Property: Region height offset.
 
float RegionRatioX
 Read Write Property: Ratio for X attachment.
 
float RegionRatioY
 Read Write Property: Ratio for Y attachment.
 
float RegionRatioWidth
 Read Write Property: Ratio for Width attachment.
 
float RegionRatioHeight
 Read Write Property: Ratio for Height attachment.

 
FBAttachType RegionAttachTypeX
 Read Write Property: X Attachment type.
 
FBAttachType RegionAttachTypeY
 Read Write Property: Y Attachment type.
 
FBAttachType RegionAttachTypeWidth
 Read Write Property: Width Attachment type.
 
FBAttachType RegionAttachTypeHeight
 Read Write Property: Height Attachment type.
 
FBVisualComponent RegionAttachToX
 Read Write Property X Attachment source.
 
FBVisualComponent RegionAttachToY
 Read Write Property: Y Attachment source.
 
FBVisualComponent RegionAttachToWidth
 Read Write Property: Width Attachment source.
 
FBVisualComponent RegionAttachToHeight
 Read Write Property: Height Attachment source.

 
int RegionPosMaxX
 Read Write Property: Region X position Max
 
int RegionPosMinX
 Read Write Property: Region X position Min
 
int RegionPosMaxY
 Read Write Property: Region Y position Max
 
int RegionPosMinY
 Read Write Property: Region Y position Min
 
str BorderCaption
 Read Write Property: Caption to display in border.
 
bool BorderShowCaption
 Read Write Property: Show caption?
 
FBBorderStyle BorderStyle
 Read Write Property: Style of border.
 
bool BorderInSet
 Read Write Property: Is border inset?
 
int BorderWidth
 Read Write Property: Width of border.
 
int BorderSpacing
 Read Write Property: Spacing of border.
 
float BorderMaxAngle
 Read Write Property: Max angle for rounding.
 
int BorderCornerRadius
 Read Write Property: Corner radius (rounded).

 
str Caption
 Property: Widget caption.

 
bool Enabled
 Read Write Property: Is visual enabled?

 
int Height
 Read Write Property: Height.

 
str Hint
 Read Write Property: Hint to show.

 
int Left
 Read Write Property: Left coordinate.

 
bool ReadOnly
 Read Write Property: Is visual component read only?

 
int Top
 Read Write Property: Top coordinate.

 
bool Visible
 Read Write Property: Is visual component visible?

 
int Width
 Read Write Property: Width.

 
- Public Attributes inherited from FBComponent
FBListComponent Components
 List: List of components.

 
str LongName
 Read Write Property: Name and namespace for object.

 
str Name
 Read Write Property: Unique name of object. See sample: RemoveSuffixFromNameOfSceneElements.py.
 
FBListComponent Parents
 List: Parents.

 
FBManager PropertyList
 Read Only Property: Manages all of the properties for the component.

 
bool Selected
 Read Write Property: Selected property.

 
int TypeInfo
 Contains the Type information of the object.

 
- Public Attributes inherited from FBPlug
str ClassGroupName
 ClassGroupName of the object.

 
int TypeInfo
 TypeInfo.

 

Detailed Description

Property editor widget.


This widget allows users to edit the values of a property without having to manually customize the GUI depending on the type of the property being edited.SDK objects can have three types of properties:An internal property which maps to an actual property that can be seen in the property editor tool of the application. This type of property is usually obtained from the PropertyList data member.SDK-only property which does not maps onto an existing property of the encapsulated object. The existence of these types of property is often to make the object interface simpler. All the FBPropertyList-types will fall into this category, except for FBPropertyListObjects.SDK property which maps onto an existing object property, but does so indirectly using function calls instead of direct property access. This is usually for historical reason. In this case the property will usually be present twice in the PropertyList: once as an SDK-Only property and another time as an internal property.Another limitation of this widget is that it can only display non hidden internal properties. To get around this issue, the property flag can be changed to unhide it. Doing so will also cause the property to be visible via the property tool.

// In a tool header file...
FBEditProperty mEditProperty;
// In a tool source file...
FBModel* lModel = FBFindModelByLabelName( "ModelName" );
if( lModel )
{
FBProperty* lProperty = lModel->PropertyList.Find( "RotationOrder" );
if( lProperty &&
lProperty->IsInternal() &&
!lProperty->GetPropertyFlag( kFBPropertyFlagHideProperty ))
{
mEditProperty.Property = lProperty;
}
}
FBManager PropertyList
Read Only Property: Manages all of the properties for the component.
Definition: pyfbsdk.h:6381
Property editor widget.
Definition: pyfbsdk.h:7768
FBReference Property
Read Write Property: Property to edit. Set to NULL to disable.
Definition: pyfbsdk.h:7778
Model class.
Definition: pyfbsdk.h:12718
Generic application property.
Definition: pyfbsdk.h:974
bool GetPropertyFlag(FBFlag pFlag)
GetPropertyFlag.
FBModel FBFindModelByLabelName(str pModelLabelName)
Find a model in the scene by its label name.

See sample: PropertyDrop.py.

Constructor & Destructor Documentation

◆ FBEditProperty()

Constructor.

Member Data Documentation

◆ LargeInc

float LargeInc

Read Write Property: Indicate the large increment applied when click-draging on the property value (usually left-click-dragging)

◆ Precision

float Precision

Read Write Property: Used to specify the width and precision of the value shown. A value of 7.2 indicates to show at minimum 7 numbers, with 2 decimals.

◆ Property

FBReference Property

Read Write Property: Property to edit. Set to NULL to disable.

◆ SliderMax

float SliderMax

Read Write Property: Should the property be editable using a slider, set the maximum value atainable with the slider.

◆ SliderMin

float SliderMin

Read Write Property: Should the property be editable using a slider, set the minimum value atainable with the slider.

◆ SmallInc

float SmallInc

Read Write Property: Indicate the small increment applied when click-draging on the property value (usually right-click-dragging)