Altium C++ SDK 3.0
Loading...
Searching...
No Matches
PCB::IPCB_Component Struct Reference

#include <EDP.PCB.Interfaces.h>

Inheritance diagram for PCB::IPCB_Component:
PCB::IPCB_Group PCB::IPCB_Primitive

Public Member Functions

int GetState_ChannelOffset ()
EDP::TComponentKind GetState_ComponentKind ()
IPCB_TextGetState_Name ()
IPCB_TextGetState_Comment ()
std::wstring GetState_Pattern ()
bool GetState_NameOn ()
bool GetState_CommentOn ()
bool GetState_LockStrings ()
int GetState_GroupNum ()
double GetState_Rotation ()
int GetState_Height ()
TTextAutoposition GetState_NameAutoPos ()
TTextAutoposition GetState_CommentAutoPos ()
std::wstring GetState_SourceDesignator ()
std::wstring GetState_SourceUniqueId ()
std::wstring GetState_SourceHierarchicalPath ()
std::wstring GetState_SourceFootprintLibrary ()
std::wstring GetState_SourceComponentLibrary ()
std::wstring GetState_SourceLibReference ()
std::wstring GetState_SourceDescription ()
std::wstring GetState_FootprintDescription ()
std::wstring GetState_DefaultPCB3DModel ()
bool GetState_IsBGA ()
C_CoordRect BoundingRectangleNoNameComment ()
C_CoordRect BoundingRectangleNoNameCommentForSignals ()
void SetState_ChannelOffset (int Value)
void SetState_ComponentKind (EDP::TComponentKind Value)
void SetState_Pattern (std::wstring Value)
void SetState_NameOn (bool Value)
void SetState_CommentOn (bool Value)
void SetState_LockStrings (bool Value)
void SetState_GroupNum (int Value)
void SetState_Rotation (double Value)
void SetState_Height (int Value)
void SetState_NameAutoPos (TTextAutoposition Value)
void SetState_CommentAutoPos (TTextAutoposition Value)
void SetState_SourceDesignator (std::wstring Value)
void SetState_SourceUniqueId (std::wstring Value)
void SetState_SourceHierarchicalPath (std::wstring Value)
void SetState_SourceFootprintLibrary (std::wstring Value)
void SetState_SourceComponentLibrary (std::wstring Value)
void SetState_SourceLibReference (std::wstring Value)
void SetState_SourceDescription (std::wstring Value)
void SetState_FootprintDescription (std::wstring Value)
void SetState_DefaultPCB3DModel (std::wstring Value)
bool ChangeNameAutoposition (TTextAutoposition Value)
bool ChangeCommentAutoposition (TTextAutoposition Value)
bool SetState_XSizeYSize_1 ()
void RotateAroundXY (int AX, int AY, double Angle)
void FlipComponent ()
void Rebuild ()
IPCB_PrimitiveGetstate_PadByName (std::wstring S)
bool LoadCompFromLibrary ()
bool LoadFromLibrary (std::wstring const AParams)
void AutoPosition_NameComment ()
void SetState_EnablePinSwapping (bool Value)
void SetState_EnablePartSwapping (bool Value)
bool GetState_EnablePinSwapping ()
bool GetState_EnablePartSwapping ()
std::wstring GetState_SourceCompDesignItemID ()
void SetState_SourceCompDesignItemID (std::wstring Value)
void SetState_FPGADisplayMode (TFPGADisplayMode Value)
TFPGADisplayMode GetState_FPGADisplayMode ()
void AutoPosition_NameComment_APILike ()
void ChangeAutopositionNameComment ()
IPCB_AxisGetState_Axis (int I)
int GetState_AxisCount ()
IPCB_AxisAddAxis ()
void ClearAxes ()
void ResetDisplacement ()
bool IsConfigurableFootprint ()
std::wstring GetState_FootprintConfiguratorName ()
void SetState_FootprintConfiguratorName (std::wstring Value)
std::wstring GetState_FootprintConfigurableParameters_Encoded ()
void SetState_FootprintConfigurableParameters_Encoded (std::wstring Value)
void SetState_VaultGUID (std::wstring Value)
void SetState_ItemGUID (std::wstring Value)
void SetState_ItemRevisionGUID (std::wstring Value)
std::wstring GetState_VaultGUID ()
std::wstring GetState_ItemGUID ()
std::wstring GetState_ItemRevisionGUID ()
void SetState_FlippedOnLayer (bool Value)
bool GetState_FlippedOnLayer ()
void SetState_JumpersVisible (bool Value)
bool GetState_JumpersVisible ()
bool SaveModelToFile (std::wstring FullPath)
Public Member Functions inherited from PCB::IPCB_Group
int GetState_XLocation ()
int GetState_YLocation ()
bool GetState_PrimitiveLock ()
bool GetState_LayerUsed (TV6_Layer L)
void SetState_XLocation (int AX)
void SetState_YLocation (int AY)
void SetState_PrimitiveLock (bool Value)
void SetState_LayerUsed (TV6_Layer L, bool Value)
void FreePrimitives ()
IPCB_PrimitiveGetPrimitiveAt (int I, TObjectId ObjectId)
int GetPrimitiveCount (TObjectSet ObjectSet)
bool SetState_XSizeYSize ()
bool FastSetState_XSizeYSize ()
void SetState_LayersUsedArray ()
IPCB_GroupIteratorGroupIterator_Create ()
void AddPCBObject (IPCB_Primitive *PCBObject)
void RemovePCBObject (IPCB_Primitive *PCBObject)
IPCB_PrimitiveReplicateWithChildren ()
void GroupIterator_Destroy (IPCB_GroupIterator **AIterator)
Public Member Functions inherited from PCB::IPCB_Primitive
IPCB_BoardGetState_Board ()
TObjectId GetState_ObjectID ()
TV6_Layer GetState_Layer ()
bool GetState_Selected ()
void SetState_Selected (bool B)
bool GetState_IsPreRoute ()
void SetState_IsPreRoute (bool B)
bool GetState_InSelectionMemory (int Index)
void SetState_InSelectionMemory (int Index, bool Value)
bool GetState_PadCacheRobotFlag ()
void SetState_PadCacheRobotFlag (bool Value)
bool GetState_Enabled ()
void SetState_Enabled (bool Value)
bool GetState_Enabled_Direct ()
void SetState_Enabled_Direct (bool Value)
bool GetState_Enabled_vNet ()
void SetState_Enabled_vNet (bool Value)
bool GetState_Enabled_vPolygon ()
void SetState_Enabled_vPolygon (bool Value)
bool GetState_Enabled_vComponent ()
void SetState_Enabled_vComponent (bool Value)
bool GetState_Enabled_vCoordinate ()
void SetState_Enabled_vCoordinate (bool Value)
bool GetState_Enabled_vDimension ()
void SetState_Enabled_vDimension (bool Value)
bool GetState_Used ()
void SetState_Used (bool Value)
bool GetState_DRCError ()
void SetState_DRCError (bool Value)
bool GetState_MiscFlag1 ()
void SetState_MiscFlag1 (bool Value)
bool GetState_MiscFlag2 ()
void SetState_MiscFlag2 (bool Value)
bool GetState_MiscFlag3 ()
void SetState_MiscFlag3 (bool Value)
bool GetState_EnableDraw ()
void SetState_EnableDraw (bool Value)
bool GetState_Moveable ()
void SetState_Moveable (bool Value)
bool GetState_UserRouted ()
void SetState_UserRouted (bool Value)
bool GetState_TearDrop ()
void SetState_TearDrop (bool Value)
bool GetState_IsTenting ()
void SetState_IsTenting (bool Value)
bool GetState_IsTenting_Top ()
void SetState_IsTenting_Top (bool Value)
bool GetState_IsTenting_Bottom ()
void SetState_IsTenting_Bottom (bool Value)
bool GetState_IsTestPoint_Top ()
void SetState_IsTestPoint_Top (bool Value)
bool GetState_IsTestPoint_Bottom ()
void SetState_IsTestPoint_Bottom (bool Value)
bool GetState_IsAssyTestPoint_Top ()
void SetState_IsAssyTestPoint_Top (bool Value)
bool GetState_IsAssyTestPoint_Bottom ()
void SetState_IsAssyTestPoint_Bottom (bool Value)
bool GetState_IsKeepout ()
void SetState_IsKeepout (bool Value)
bool GetState_AllowGlobalEdit ()
void SetState_AllowGlobalEdit (bool Value)
bool GetState_PolygonOutline ()
void SetState_PolygonOutline (bool Value)
bool GetState_InBoard ()
void SetState_InBoard (bool Value)
bool GetState_InPolygon ()
void SetState_InPolygon (bool Value)
bool GetState_InComponent ()
void SetState_InComponent (bool Value)
bool GetState_InNet ()
void SetState_InNet (bool Value)
bool GetState_InCoordinate ()
void SetState_InCoordinate (bool Value)
bool GetState_InDimension ()
void SetState_InDimension (bool Value)
bool GetState_IsElectricalPrim ()
void SetState_Board (IPCB_Board *ABoard)
void SetState_Layer (TV6_Layer ALayer)
std::wstring GetState_ObjectIDString ()
std::wstring GetState_Identifier ()
std::wstring GetState_DescriptorString ()
std::wstring GetState_DetailString ()
int GetState_Index ()
void SetState_Index (int AIndex)
int GetState_UnionIndex ()
void SetState_UnionIndex (int Value)
TPlaneConnectStyle GetState_PowerPlaneConnectStyle ()
int GetState_ReliefConductorWidth ()
int GetState_ReliefEntries ()
int GetState_ReliefAirGap ()
int GetState_PasteMaskExpansion ()
int GetState_SolderMaskExpansion ()
int GetState_PowerPlaneClearance ()
int GetState_PowerPlaneReliefExpansion ()
IPCB_NetGetState_Net ()
IPCB_ComponentGetState_Component ()
IPCB_PolygonGetState_Polygon ()
IPCB_CoordinateGetState_Coordinate ()
IPCB_DimensionGetState_Dimension ()
TViewableObjectID GetState_ViewableObjectID ()
void SetState_Net (IPCB_Net *Value)
void SetState_Component (IPCB_Component *Value)
void SetState_Polygon (IPCB_Polygon *Value)
void SetState_Coordinate (IPCB_Coordinate *Value)
void SetState_Dimension (IPCB_Dimension *Value)
C_CoordRect BoundingRectangle ()
C_CoordRect BoundingRectangleForSelection ()
C_CoordRect BoundingRectangleForPainting ()
bool IsHidden ()
bool IsFreePrimitive ()
bool IsSaveable (TAdvPCBFileFormatVersion AVer)
void MoveByXY (int AX, int AY)
void MoveToXY (int AX, int AY)
void RotateBy (double Angle)
void FlipXY (int Axis, TMirrorOperation MirrOp)
void SwapLayerPairs ()
void GraphicallyInvalidate ()
void BeginModify ()
void EndModify ()
void CancelModify ()
void Export_ToParameters (std::wstring *AParams)
int RequiredParamterSpace ()
void SetState_V7Layer (C_V7_Layer L)
C_V7_Layer GetState_V7Layer ()
C_CoordRect BoundingRectangleChildren ()
IPCB_PrimitiveReplicate ()
std::wstring GetState_UniqueId ()
std::wstring GetState_Handle ()
void SetState_UniqueID (std::wstring const Value)
bool GetState_DrawAsPreview ()
void SetState_DrawAsPreview (bool Value)
void SetState_Preview (bool Enable, long Color, float Opacity, int z, int Height, float sx, float sy, float SZ)

Member Function Documentation

◆ AddAxis()

IPCB_Axis * PCB::IPCB_Component::AddAxis ( )

◆ AutoPosition_NameComment()

void PCB::IPCB_Component::AutoPosition_NameComment ( )

◆ AutoPosition_NameComment_APILike()

void PCB::IPCB_Component::AutoPosition_NameComment_APILike ( )

◆ BoundingRectangleNoNameComment()

C_CoordRect PCB::IPCB_Component::BoundingRectangleNoNameComment ( )

◆ BoundingRectangleNoNameCommentForSignals()

C_CoordRect PCB::IPCB_Component::BoundingRectangleNoNameCommentForSignals ( )

◆ ChangeAutopositionNameComment()

void PCB::IPCB_Component::ChangeAutopositionNameComment ( )

◆ ChangeCommentAutoposition()

bool PCB::IPCB_Component::ChangeCommentAutoposition ( TTextAutoposition Value)

◆ ChangeNameAutoposition()

bool PCB::IPCB_Component::ChangeNameAutoposition ( TTextAutoposition Value)

◆ ClearAxes()

void PCB::IPCB_Component::ClearAxes ( )

◆ FlipComponent()

void PCB::IPCB_Component::FlipComponent ( )

◆ GetState_Axis()

IPCB_Axis * PCB::IPCB_Component::GetState_Axis ( int I)

◆ GetState_AxisCount()

int PCB::IPCB_Component::GetState_AxisCount ( )

◆ GetState_ChannelOffset()

int PCB::IPCB_Component::GetState_ChannelOffset ( )

◆ GetState_Comment()

IPCB_Text * PCB::IPCB_Component::GetState_Comment ( )

◆ GetState_CommentAutoPos()

TTextAutoposition PCB::IPCB_Component::GetState_CommentAutoPos ( )

◆ GetState_CommentOn()

bool PCB::IPCB_Component::GetState_CommentOn ( )

◆ GetState_ComponentKind()

EDP::TComponentKind PCB::IPCB_Component::GetState_ComponentKind ( )

◆ GetState_DefaultPCB3DModel()

std::wstring PCB::IPCB_Component::GetState_DefaultPCB3DModel ( )

◆ GetState_EnablePartSwapping()

bool PCB::IPCB_Component::GetState_EnablePartSwapping ( )

◆ GetState_EnablePinSwapping()

bool PCB::IPCB_Component::GetState_EnablePinSwapping ( )

◆ GetState_FlippedOnLayer()

bool PCB::IPCB_Component::GetState_FlippedOnLayer ( )

◆ GetState_FootprintConfigurableParameters_Encoded()

std::wstring PCB::IPCB_Component::GetState_FootprintConfigurableParameters_Encoded ( )

◆ GetState_FootprintConfiguratorName()

std::wstring PCB::IPCB_Component::GetState_FootprintConfiguratorName ( )

◆ GetState_FootprintDescription()

std::wstring PCB::IPCB_Component::GetState_FootprintDescription ( )

◆ GetState_FPGADisplayMode()

TFPGADisplayMode PCB::IPCB_Component::GetState_FPGADisplayMode ( )

◆ GetState_GroupNum()

int PCB::IPCB_Component::GetState_GroupNum ( )

◆ GetState_Height()

int PCB::IPCB_Component::GetState_Height ( )

◆ GetState_IsBGA()

bool PCB::IPCB_Component::GetState_IsBGA ( )

◆ GetState_ItemGUID()

std::wstring PCB::IPCB_Component::GetState_ItemGUID ( )

◆ GetState_ItemRevisionGUID()

std::wstring PCB::IPCB_Component::GetState_ItemRevisionGUID ( )

◆ GetState_JumpersVisible()

bool PCB::IPCB_Component::GetState_JumpersVisible ( )

◆ GetState_LockStrings()

bool PCB::IPCB_Component::GetState_LockStrings ( )

◆ GetState_Name()

IPCB_Text * PCB::IPCB_Component::GetState_Name ( )

◆ GetState_NameAutoPos()

TTextAutoposition PCB::IPCB_Component::GetState_NameAutoPos ( )

◆ GetState_NameOn()

bool PCB::IPCB_Component::GetState_NameOn ( )

◆ Getstate_PadByName()

IPCB_Primitive * PCB::IPCB_Component::Getstate_PadByName ( std::wstring S)

◆ GetState_Pattern()

std::wstring PCB::IPCB_Component::GetState_Pattern ( )

◆ GetState_Rotation()

double PCB::IPCB_Component::GetState_Rotation ( )

◆ GetState_SourceCompDesignItemID()

std::wstring PCB::IPCB_Component::GetState_SourceCompDesignItemID ( )

◆ GetState_SourceComponentLibrary()

std::wstring PCB::IPCB_Component::GetState_SourceComponentLibrary ( )

◆ GetState_SourceDescription()

std::wstring PCB::IPCB_Component::GetState_SourceDescription ( )

◆ GetState_SourceDesignator()

std::wstring PCB::IPCB_Component::GetState_SourceDesignator ( )

◆ GetState_SourceFootprintLibrary()

std::wstring PCB::IPCB_Component::GetState_SourceFootprintLibrary ( )

◆ GetState_SourceHierarchicalPath()

std::wstring PCB::IPCB_Component::GetState_SourceHierarchicalPath ( )

◆ GetState_SourceLibReference()

std::wstring PCB::IPCB_Component::GetState_SourceLibReference ( )

◆ GetState_SourceUniqueId()

std::wstring PCB::IPCB_Component::GetState_SourceUniqueId ( )

◆ GetState_VaultGUID()

std::wstring PCB::IPCB_Component::GetState_VaultGUID ( )

◆ IsConfigurableFootprint()

bool PCB::IPCB_Component::IsConfigurableFootprint ( )

◆ LoadCompFromLibrary()

bool PCB::IPCB_Component::LoadCompFromLibrary ( )

◆ LoadFromLibrary()

bool PCB::IPCB_Component::LoadFromLibrary ( std::wstring const AParams)

◆ Rebuild()

void PCB::IPCB_Component::Rebuild ( )

◆ ResetDisplacement()

void PCB::IPCB_Component::ResetDisplacement ( )

◆ RotateAroundXY()

void PCB::IPCB_Component::RotateAroundXY ( int AX,
int AY,
double Angle )

◆ SaveModelToFile()

bool PCB::IPCB_Component::SaveModelToFile ( std::wstring FullPath)

◆ SetState_ChannelOffset()

void PCB::IPCB_Component::SetState_ChannelOffset ( int Value)

◆ SetState_CommentAutoPos()

void PCB::IPCB_Component::SetState_CommentAutoPos ( TTextAutoposition Value)

◆ SetState_CommentOn()

void PCB::IPCB_Component::SetState_CommentOn ( bool Value)

◆ SetState_ComponentKind()

void PCB::IPCB_Component::SetState_ComponentKind ( EDP::TComponentKind Value)

◆ SetState_DefaultPCB3DModel()

void PCB::IPCB_Component::SetState_DefaultPCB3DModel ( std::wstring Value)

◆ SetState_EnablePartSwapping()

void PCB::IPCB_Component::SetState_EnablePartSwapping ( bool Value)

◆ SetState_EnablePinSwapping()

void PCB::IPCB_Component::SetState_EnablePinSwapping ( bool Value)

◆ SetState_FlippedOnLayer()

void PCB::IPCB_Component::SetState_FlippedOnLayer ( bool Value)

◆ SetState_FootprintConfigurableParameters_Encoded()

void PCB::IPCB_Component::SetState_FootprintConfigurableParameters_Encoded ( std::wstring Value)

◆ SetState_FootprintConfiguratorName()

void PCB::IPCB_Component::SetState_FootprintConfiguratorName ( std::wstring Value)

◆ SetState_FootprintDescription()

void PCB::IPCB_Component::SetState_FootprintDescription ( std::wstring Value)

◆ SetState_FPGADisplayMode()

void PCB::IPCB_Component::SetState_FPGADisplayMode ( TFPGADisplayMode Value)

◆ SetState_GroupNum()

void PCB::IPCB_Component::SetState_GroupNum ( int Value)

◆ SetState_Height()

void PCB::IPCB_Component::SetState_Height ( int Value)

◆ SetState_ItemGUID()

void PCB::IPCB_Component::SetState_ItemGUID ( std::wstring Value)

◆ SetState_ItemRevisionGUID()

void PCB::IPCB_Component::SetState_ItemRevisionGUID ( std::wstring Value)

◆ SetState_JumpersVisible()

void PCB::IPCB_Component::SetState_JumpersVisible ( bool Value)

◆ SetState_LockStrings()

void PCB::IPCB_Component::SetState_LockStrings ( bool Value)

◆ SetState_NameAutoPos()

void PCB::IPCB_Component::SetState_NameAutoPos ( TTextAutoposition Value)

◆ SetState_NameOn()

void PCB::IPCB_Component::SetState_NameOn ( bool Value)

◆ SetState_Pattern()

void PCB::IPCB_Component::SetState_Pattern ( std::wstring Value)

◆ SetState_Rotation()

void PCB::IPCB_Component::SetState_Rotation ( double Value)

◆ SetState_SourceCompDesignItemID()

void PCB::IPCB_Component::SetState_SourceCompDesignItemID ( std::wstring Value)

◆ SetState_SourceComponentLibrary()

void PCB::IPCB_Component::SetState_SourceComponentLibrary ( std::wstring Value)

◆ SetState_SourceDescription()

void PCB::IPCB_Component::SetState_SourceDescription ( std::wstring Value)

◆ SetState_SourceDesignator()

void PCB::IPCB_Component::SetState_SourceDesignator ( std::wstring Value)

◆ SetState_SourceFootprintLibrary()

void PCB::IPCB_Component::SetState_SourceFootprintLibrary ( std::wstring Value)

◆ SetState_SourceHierarchicalPath()

void PCB::IPCB_Component::SetState_SourceHierarchicalPath ( std::wstring Value)

◆ SetState_SourceLibReference()

void PCB::IPCB_Component::SetState_SourceLibReference ( std::wstring Value)

◆ SetState_SourceUniqueId()

void PCB::IPCB_Component::SetState_SourceUniqueId ( std::wstring Value)

◆ SetState_VaultGUID()

void PCB::IPCB_Component::SetState_VaultGUID ( std::wstring Value)

◆ SetState_XSizeYSize_1()

bool PCB::IPCB_Component::SetState_XSizeYSize_1 ( )

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