Plane Properties (PlaneProperties)

An opening ID is an entry point used to customize business logic. PlaneProperties enables you to manage the color and thickness of the reference planes depending on their categories.

Note: For more information about customization by business rules, see Installation and Setup: Customize: Behavior: Data Setup: Customization by Business Rules.

This page discusses:

General Information

This opening ID is invoked:

  • When you create the reference plane system.
  • When you edit the category of the reference planes.

This opening ID is used to customize:

  • Reference plane color.
  • Reference plane thickness.

The table below provides you with information related to the definition of the Opening ID.

PLM Opening ID: PlaneProperties
Customization intent: Computation
Execution context: Client

Input Objects

Input objects must be of the following types:

  • ThisObject: VPMReference
  • Parameters: RuleContext

Sample

The following sample shows the business rule for assigning color and thickness to the reference planes according to their category type.

Important: All the inputs, that is, color (R, G, B) and thickness are required for the business to work.

let RValue(Integer)
let GValue(Integer)
let BValue(Integer)
let ThicknessOfPlane(Integer)

let CategoryName(String)

set CategoryName= Parameters.GetAttributeString("CategoryName")

/* Set RGB color and Thickness of Plane */
if("WatertightFrame" == CategoryName)
{
  RValue = 0
  GValue = 0
  BValue = 255
  ThicknessOfPlane = 3
}
else if("FireZoneFrame" == CategoryName)
{
  RValue = 255
  GValue = 0
  BValue = 0
  ThicknessOfPlane = 4
}
else if("WebFrame" == CategoryName)
{
  RValue = 128
  GValue = 0
  BValue = 255
  ThicknessOfPlane = 2
}
else if("RFGMidShip" == CategoryName)
{
  RValue = 255
  GValue = 255
  BValue = 0
  ThicknessOfPlane = 4
}
else if("RFGCentreLine" == CategoryName)
{
  RValue = 255
  GValue = 128
  BValue = 0
  ThicknessOfPlane = 4
}

Parameters.SetAttributeInteger("RValue", RValue)
Parameters.SetAttributeInteger("GValue", GValue)
Parameters.SetAttributeInteger("BValue", BValue)
Parameters.SetAttributeInteger("Thickness", ThicknessOfPlane )