Interface IOperationsVectorDisplayBaseViewModel
Last update: 16.07.2025Namespace: VM.Operations.Post.Interfaces
Assembly: VM.Operations.Post.dll
Interface representing information for the vector display view model.
public interface IOperationsVectorDisplayBaseViewModel
Examples
For an example that includes information about interfaces, see this example. To view the examples, refer to the location of the 'Install_Path\Motion\Document\Postprocessor API for Python.zip' file.
# IOperationsVectorDisplayBaseViewModel.py
import sys
current_dir = __file__.rsplit('\\', 1)[0]
external_modules_path = current_dir + '\\..\\..\\Modules'
sys.path.append(external_modules_path)
from OperationAPI import *
# Start the headless application interface
applicationHandler = ApplicationHandler()
# Import result file
result_file_path = get_result_file_path()
# Set array about result file
filepaths = List[str]()
filepaths.Add(result_file_path)
# Open about result files
applicationHandler.AddDocument(filepaths)
# Find Page
pages = applicationHandler.GetPages()
findViews = list()
for page in pages :
views = page.GetViews()
animationViews = [view for view in views if view.ViewType == ViewType.Animation]
for animationView in animationViews :
if animationView.DocumentFilePath == result_file_path and animationView.AnalysisResultType == AnalysisResultType.Dynamics :
findViews.append(animationView)
viewCount = len(findViews)
if viewCount > 0 :
document = applicationHandler.GetDocument(result_file_path)
analysis = document.GetAnalysisResultViewModel(AnalysisResultType.Dynamics)
# Create Vector Display
vector = analysis.CreateVectorDisplay("TJ_01", "Base Force")
vector.FullName = "TJ_VectorDisplay"
vector.IsLabel = True
vector.LabelBackgroundColor = OperationAPIService.GetColorFrameRGB(255,255,255)
vector.LabelTextColor = OperationAPIService.GetColorFrameRGB(0,0,0)
vector.IsVisible = True
vector.SetCharacteristic("Base Torque")
# Close the Pages
pages = applicationHandler.GetPages()
for page in pages :
page.Close()
# Close the Document
applicationHandler.CloseDocument(result_file_path)
Properties
FullName
Gets or sets the full name of the vector display.
string FullName { get; set; }
Property Value
Examples
For an example that includes this property, see the Interface IOperationsVectorDisplayBaseViewModel.
Remarks
Use this property to specify or retrieve the full name of the vector display.
IsLabel
Gets or sets a value indicating whether to display or hide the object name, and force and position vectors in the animation view.
bool IsLabel { get; set; }
Property Value
Examples
For an example that includes this property, see the Interface IOperationsVectorDisplayBaseViewModel.
Remarks
Use this property to specify or retrieve the visibility of the object name, and force and position vectors in the animation view.
IsVisible
Gets or sets a value indicating whether the vector display is visible in the animation view.
bool IsVisible { get; set; }
Property Value
Examples
The following example demonstrates how to use the IsVisible property:
For an example that includes this property, see the [Interface IOperationsVectorDisplayBaseViewModel](VM.Operations.Post.Interfaces.IOperationsVectorDisplayBaseViewModel.md).
Remarks
Use this property to specify or retrieve the visibility of the vector display in the animation view.
LabelBackgroundColor
Gets or sets the background color of the label in the vector display.
Color LabelBackgroundColor { get; set; }
Property Value
Examples
The following example demonstrates how to use the LabelBackGroundColor property:
For an example that includes this property, see the [Interface IOperationsVectorDisplayBaseViewModel](VM.Operations.Post.Interfaces.IOperationsVectorDisplayBaseViewModel.md).
Remarks
Use this property to specify or retrieve the background color of the label in the vector display.
LabelTextColor
Gets or sets the text color of the label in the vector display.
Color LabelTextColor { get; set; }
Property Value
Examples
The following example demonstrates how to use the LabelTextColor property:
For an example that includes this property, see the [Interface IOperationsVectorDisplayBaseViewModel](VM.Operations.Post.Interfaces.IOperationsVectorDisplayBaseViewModel.md).
Remarks
Use this property to specify or retrieve the text color of the label in the vector display.
Methods
SetCharacteristic(string)
Sets the characteristic for the vector display.
void SetCharacteristic(string characteristic)
Parameters
characteristic string
The characteristic to be set.
Examples
The following example demonstrates how to use the SetCharacteristic method:
For an example that includes this property, see the [Interface IOperationsVectorDisplayBaseViewModel](VM.Operations.Post.Interfaces.IOperationsVectorDisplayBaseViewModel.md).
Remarks
This method sets or changes the characteristic for the vector display.